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

SCIFloatValues

@interface SCIFloatValues : SCIDisposableBase <ISCIValues>

Defines a float values collection.

  • Maximum capacity of underlying array.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger capacity;

    Swift

    var capacity: Int { get }
  • Creates a new SCIFloatValues instance.

    Declaration

    Objective-C

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

    Swift

    init(capacity: Int)

    Parameters

    capacity

    The initial capacity.

  • Creates a new SCIFloatValues instance and initializes it with specified array.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithItems:(nonnull const float *)items
                                    count:(NSInteger)count;

    Parameters

    items

    The array with items.

    count

    The count of passed in items.

  • Gets the internal items array.

    Declaration

    Objective-C

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

    Return Value

    The items array.

  • Adds new value.

    Declaration

    Objective-C

    - (void)add:(float)value;

    Swift

    func add(_ value: Float)

    Parameters

    value

    The value to add.

  • Adds new value at specified location.

    Declaration

    Objective-C

    - (void)insert:(float)value at:(NSInteger)index;

    Swift

    func insert(_ value: Float, at index: Int)

    Parameters

    index

    The location to add value at.

    value

    The value to add.

  • Adds multiple values from array.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    values

    The values to add.

    count

    The amount of values to add.

  • Adds multiple values from array region.

    Declaration

    Objective-C

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

    Swift

    func addValues(_ values: UnsafePointer<Float>, 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.

  • Sets the value at specified location.

    Declaration

    Objective-C

    - (void)set:(float)value at:(NSInteger)index;

    Swift

    func set(_ value: Float, at index: Int)

    Parameters

    value

    The value to set.

    index

    The index to set value at.

  • Gets the value at specified location.

    Declaration

    Objective-C

    - (float)getValueAt:(NSInteger)index;

    Swift

    func getValueAt(_ index: Int) -> Float

    Parameters

    index

    The index of value to get.

    Return Value

    The value.

  • 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.