iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

SCIUnsignedShortValues

@interface SCIUnsignedShortValues : SCIDisposableBase <ISCIValues>

Defines a unsigned short values collection.




capacity

Maximum capacity of underlying array.

Declaration

Objective-C

@property (nonatomic, readonly) NSInteger capacity;

Swift

var capacity: Int { get }

-initWithCapacity:
Creates a new SCIUnsignedShortValues instance.
Declaration
Objective-C

- (nonnull instancetype)initWithCapacity:(NSInteger)capacity;
Swift

init(capacity: Int)
Parameters

capacity

The initial capacity.
-initWithItems:count:
Creates a new SCIUnsignedShortValues instance and initializes it with specified array.
Declaration
Objective-C

- (nonnull instancetype)initWithItems:(nonnull const unsigned short *)items count:(NSInteger)count;
Parameters

items

The array with items.

count

The count of passed in items.




itemsArray

Gets the internal items array.

Declaration

Objective-C

@property (nonatomic, readonly, getter=getItemsArray) NS_REFINED_FOR_SWIFT unsigned short *itemsArray;

Return Value

The items array.

-add:
Adds new value.
Declaration
Objective-C

- (void)add:(unsigned short)value;
Swift

func add(_ value: UInt16)
Parameters

value

The value to add.
-insert:at:
Adds new value at specified location.
Declaration
Objective-C

- (void)insert:(unsigned short)value at:(NSInteger)index;
Swift

func insert(_ value: UInt16, at index: Int)
Parameters

index

The location to add value at.

value

The value to add.




-addValues:count:

Adds multiple values from array.

Declaration

Objective-C

- (void)addValues:(nonnull const unsigned short *)values count:(NSInteger)count;

Swift

func addValues(_ values: UnsafePointer<UInt16>, count: Int)

Parameters

`values`	The values to add.
`count`	The amount of values to add.




-addValues:startIndex:count:

Adds multiple values from array region.

Declaration

Objective-C

- (void)addValues:(nonnull const unsigned short *)values
       startIndex:(NSInteger)startIndex
            count:(NSInteger)count;

Swift

func addValues(_ values: UnsafePointer<UInt16>, startIndex: Int, count: Int)

Parameters

`values`	The values array to add.
`startIndex`	The index of first value to add.
`count`	The amount of values to add.

-set:at:
Sets the value at specified location.
Declaration
Objective-C

- (void)set:(unsigned short)value at:(NSInteger)index;
Swift

func set(_ value: UInt16, at index: Int)
Parameters

value

The value to set.

index

The index to set value at.
-getValueAt:
Gets the value at specified location.
Declaration
Objective-C

- (unsigned short)getValueAt:(NSInteger)index;
Swift

func getValueAt(_ index: Int) -> UInt16
Parameters

index

The index of value to get.

Return Value

The value.
-removeAt:
Removes value at specified location.
Declaration
Objective-C

- (void)removeAt:(NSInteger)index;
Swift

func remove(at index: Int)
Parameters

index

The index to remove value at.