Class IndexSet

[iterator]

• "[iterator]"(): Iterator<number>

  Returns Iterator<number>

constructor

• new IndexSet(): Spotfire.Dxp.Data.IndexSet

  Creates an empty IndexSet.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

• new IndexSet(that: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Creates an IndexSet as a copy of another IndexSet.

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to be copied.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

• new IndexSet(
      capacity: number | System.Int32,
      filled: boolean | System.Boolean,
  ): Spotfire.Dxp.Data.IndexSet

  Creates an IndexSet with the specified capacity.

  Parameters

  • capacity: number | System.Int32

    The maximum capacity.

  • filled: boolean | System.Boolean

    If true, all indices will initially be marked as present.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

• new IndexSet(
      capacity: number | System.Int32,
      includedIndexes: OrExplicit<
          System.Collections.Generic.IEnumerable<number | System.Int32>,
      >,
  ): Spotfire.Dxp.Data.IndexSet

  Creates an IndexSet with specified capacity and initial content.

  Parameters

  • capacity: number | System.Int32

    The maximum capacity.

  • includedIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>

    The initial content.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

ReadonlyItem

Capacity

• get Capacity(): number

  Controls the total number of indexes that the IndexSet can hold (numbered 0 to Capacity-1) Setting capacity will clear the IndexSet.

  Returns number

  Since

  2.0

• set Capacity(value: number): void

  Parameters

  • value: number

  Returns void

Count

• get Count(): number

  Number of indexes currently in the set.

  Returns number

  Since

  2.0

First

• get First(): number

  Gets the first index in the IndexSet.

  Returns number

  Since

  2.0

IsEmpty

• get IsEmpty(): boolean

  True if the set has no indexes (Count == 0).

  Returns boolean

  Since

  2.0

IsFull

• get IsFull(): boolean

  True if the all indexes are in the set (Count == Capacity).

  Returns boolean

  Since

  2.0

IsReadOnly

• get IsReadOnly(): boolean

  Tells if this IndexSet is read-only.

  Returns boolean

  Since

  2.0

Last

• get Last(): number

  Gets the last index in the IndexSet.

  Returns number

  Since

  2.0

AddIndex

• AddIndex(index: number | System.Int32): void

  Adds the index to the set. If the index is already in the set, nothing is changed.

  Parameters

  • index: number | System.Int32

    Index

  Returns void

  Since

  2.0

AddIndexes

• AddIndexes(
      indexes: OrExplicit<
          System.Collections.Generic.IEnumerable<number | System.Int32>,
      >,
  ): void

  Adds the specified indexes to the set.

  Parameters

  • indexes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>

    The indexes.

  Returns void

  Since

  2.0

• AddIndexes(
      startIndex: number | System.Int32,
      count: number | System.Int32,
  ): void

  Adds a range of indexes to the set.

  Parameters

  • startIndex: number | System.Int32

    First index in the range

  • count: number | System.Int32

    Number of indexes in the range

  Returns void

  Since

  2.0

And

• And(that: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Performs a logical AND between this and that IndexSet.

  Note: the method changes the internal state of this IndexSet

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to AND with

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

AsReadOnly

• AsReadOnly(): Spotfire.Dxp.Data.IndexSet

  Returns this if read-only, otherwise a read-only clone.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

Assign

• Assign(that: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Copies the content of the specified IndexSet into this one.

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to assign from

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

• Assign(
      capacity: number | System.Int32,
      bits: TypedArray<number> | TypedArray<System.UInt32>,
  ): Spotfire.Dxp.Data.IndexSet

  Assigns the indexes from the specified array of indexes encoded as bits. The length of the bits array must be (capacity + 31)/32. Bits outside of capacity in the last array element are ignored.

  Parameters

  • capacity: number | System.Int32

    IndexSet capacity

  • bits: TypedArray<number> | TypedArray<System.UInt32>

    Array of 32-bit words

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

AssignComplement

• AssignComplement(that: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Copies the complement of the specified IndexSet into this one. In other words, this IndexSet will contain the indexes NOT in that IndexSet.

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to assign from

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

AsWritable

• AsWritable(): Spotfire.Dxp.Data.IndexSet

  Returns a clone if this is read-only, otherwise this.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

Clear

• Clear(): Spotfire.Dxp.Data.IndexSet

  Removes all indexes from the set.

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

Clone

• Clone(): Spotfire.Dxp.Data.IndexSet

  Creates a writable copy of this IndexSet.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

Contains

• Contains(that: Spotfire.Dxp.Data.IndexSet): boolean

  Determines whether this IndexSet contains all indexes of that IndexSet.

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to test against

  Returns boolean

  true is that set is a sub set of this set; otherwise false.

  Since

  2.0

CopyTo

• CopyTo(
      array: TypedArray<number> | TypedArray<System.Int32>,
      index: number | System.Int32,
  ): void

  Copies the indexes in the set to the array starting at the offset.

  Parameters

  • array: TypedArray<number> | TypedArray<System.Int32>

    Int32 array

  • index: number | System.Int32

    Array offset

  Returns void

  Since

  2.0

DeleteIndexPositions

• DeleteIndexPositions(
      startIndex: number | System.Int32,
      count: number | System.Int32,
  ): void

  Deletes a range of index positions. Existing indexes from startIndex+count and above are moved down.

  Parameters

  • startIndex: number | System.Int32

    First index position to be deleted

  • count: number | System.Int32

    Number of index positions

  Returns void

  Since

  2.0

Equals

• Equals(obj: any): boolean

  Determines whether the specified object is equal to the current object.

  Parameters

  • obj: any

    The object to compare with the current object.

  Returns boolean

  true if the specified object is equal to the current object; otherwise, false.

• Equals(that: Spotfire.Dxp.Data.IndexSet): boolean

  Tests if this IndexSet and that IndexSet have the same Capacity and contain exactly the same indexes.

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to compare against

  Returns boolean

  True if the sets are equal

  Since

  2.0

Fill

• Fill(): Spotfire.Dxp.Data.IndexSet

  Adds all indexes (as defined by Capacity) to the set.

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

GetBits

• GetBits(bits: TypedArray<number> | TypedArray<System.UInt32>): void

  Fills the specified array with the indexes encoded as bits. The length of the bits array must be (Capacity + 31)/32.

  Parameters

  • bits: TypedArray<number> | TypedArray<System.UInt32>

    Array of 32-bit words

  Returns void

  Since

  2.0

GetEnumerator

• GetEnumerator(): System.Collections.Generic.IEnumerator<number>

  Returns an enumerator for the IndexSet.

  Returns System.Collections.Generic.IEnumerator<number>

  IndexSet.Enumerator

  Since

  2.0

GetNextIndex

• GetNextIndex(index: number | System.Int32): number

  Gets the index after the specified one.

  Parameters

  • index: number | System.Int32

    The index.

  Returns number

  Next index, or -1.

  Since

  2.0

GetPreviousIndex

• GetPreviousIndex(index: number | System.Int32): number

  Gets the index before the specified one.

  Parameters

  • index: number | System.Int32

    The index.

  Returns number

  Previous index, or -1.

  Since

  2.0

GetSubsetCount

• GetSubsetCount(
      startIndex: number | System.Int32,
      endIndex: number | System.Int32,
  ): number

  Gets the number of indexes in a subset defined by the startIndex and endIndex arguments.

  Parameters

  • startIndex: number | System.Int32

    Start index in subset.

  • endIndex: number | System.Int32

    End index in subset.

  Returns number

  Number of indexes in subset.

  Remark

  If an IndexSet is not filled, GetSubsetCount(0,index) can be used to retrieve the index (between 0 and Count - 1) for a particular index (between 0 and Capacity - 1).

  Since

  2.0

HasIndex

• HasIndex(index: number | System.Int32): boolean

  Returns a bool indicating if the index is a member of the set.

  Parameters

  • index: number | System.Int32

    Index

  Returns boolean

  True if the index is a member of the set

  Since

  2.0

InsertIndexPositions

• InsertIndexPositions(
      startIndex: number | System.Int32,
      count: number | System.Int32,
      add: boolean | System.Boolean,
  ): void

  Makes room for more indexes. Existing indexes from startIndex and above are moved up.

  Parameters

  • startIndex: number | System.Int32

    First new index position

  • count: number | System.Int32

    Number of new index positions

  • add: boolean | System.Boolean

    Add the new indexes to the set

  Returns void

  Since

  2.0

Intersects

• Intersects(that: Spotfire.Dxp.Data.IndexSet): boolean

  Determines whether this and that IndexSet have any indexes in common.

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to test against

  Returns boolean

  true is the sets intersect; otherwise false.

  Since

  2.0

Not

• Not(): Spotfire.Dxp.Data.IndexSet

  Inverts the set. Any index that was included in the set will be excluded and vice versa.

  Note: the method changes the internal state of this IndexSet

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

NthSmallestIndex

• NthSmallestIndex(indexOrdinalNumber: number | System.Int32): number

  Gets the Nth smallest index. Caution: This method is slow (linear time), so you must ensure that your algorithm (or the one using your algorithm) never calls this method many times, which could result in quadratic time.

  Parameters

  • indexOrdinalNumber: number | System.Int32

    Index ordinal number. The valid range is 1 to Count.

  Returns number

  The index with the specified ordinal number.

  Since

  2.0

Or

• Or(that: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Performs a logical OR between this and that IndexSet.

  Note: the method changes the internal state of this IndexSet

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to OR with

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

RemoveIndex

• RemoveIndex(index: number | System.Int32): void

  Removes the index from the set. If the index is not in the set, nothing is changed.

  Parameters

  • index: number | System.Int32

    Index

  Returns void

  Since

  2.0

RemoveIndexes

• RemoveIndexes(
      indexes: OrExplicit<
          System.Collections.Generic.IEnumerable<number | System.Int32>,
      >,
  ): void

  Removes the specified indexes from the set.

  Parameters

  • indexes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>

    The indexes.

  Returns void

  Since

  2.0

• RemoveIndexes(
      startIndex: number | System.Int32,
      count: number | System.Int32,
  ): void

  Removes a range of indexes from the set.

  Parameters

  • startIndex: number | System.Int32

    First index in the range

  • count: number | System.Int32

    Number of indexes in the range

  Returns void

  Since

  2.0

SetReadOnly

• SetReadOnly(): Spotfire.Dxp.Data.IndexSet

  Sets this IndexSet to read-only.

  Returns Spotfire.Dxp.Data.IndexSet

  Since

  2.0

Subtract

• Subtract(that: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Subtracts that IndexSet from this one. In other words, the indexes in that IndexSet are removed from this.

  Note: the method changes the internal state of this IndexSet

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to subtract

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

Xor

• Xor(that: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Performs a logical XOR between this and that IndexSet.

  Note: the method changes the internal state of this IndexSet

  Parameters

  • that: Spotfire.Dxp.Data.IndexSet

    The IndexSet to XOR with

  Returns Spotfire.Dxp.Data.IndexSet

  This modified IndexSet

  Since

  2.0

StaticAnd

• And(
      set1: Spotfire.Dxp.Data.IndexSet,
      set2: Spotfire.Dxp.Data.IndexSet,
  ): Spotfire.Dxp.Data.IndexSet

  Returns a new IndexSet that is a logical AND between two IndexSet.

  Parameters

  • set1: Spotfire.Dxp.Data.IndexSet

    The first IndexSet.

  • set2: Spotfire.Dxp.Data.IndexSet

    The second IndexSet.

  Returns Spotfire.Dxp.Data.IndexSet

  A new IndexSet

  Since

  2.0

StaticNot

• Not(set: Spotfire.Dxp.Data.IndexSet): Spotfire.Dxp.Data.IndexSet

  Returns a new IndexSet that is the complement of the specified source set. Any index that is included in the source set will be excluded and vice versa.

  Parameters

  • set: Spotfire.Dxp.Data.IndexSet

    The source IndexSet.

  Returns Spotfire.Dxp.Data.IndexSet

  A new IndexSet

  Since

  2.0

StaticOr

• Or(
      set1: Spotfire.Dxp.Data.IndexSet,
      set2: Spotfire.Dxp.Data.IndexSet,
  ): Spotfire.Dxp.Data.IndexSet

  Returns a new IndexSet that is a logical OR between two IndexSet.

  Parameters

  • set1: Spotfire.Dxp.Data.IndexSet

    The first IndexSet.

  • set2: Spotfire.Dxp.Data.IndexSet

    The second IndexSet.

  Returns Spotfire.Dxp.Data.IndexSet

  A new IndexSet

  Since

  2.0

StaticSubtract

• Subtract(
      set1: Spotfire.Dxp.Data.IndexSet,
      set2: Spotfire.Dxp.Data.IndexSet,
  ): Spotfire.Dxp.Data.IndexSet

  Returns a new IndexSet that is a subtraction between two IndexSet. In other words, the new IndexSet is a copy of set1 without the indexes in set2.

  Parameters

  • set1: Spotfire.Dxp.Data.IndexSet

    The first IndexSet.

  • set2: Spotfire.Dxp.Data.IndexSet

    The second IndexSet.

  Returns Spotfire.Dxp.Data.IndexSet

  A new IndexSet

  Since

  2.0

StaticXor

• Xor(
      set1: Spotfire.Dxp.Data.IndexSet,
      set2: Spotfire.Dxp.Data.IndexSet,
  ): Spotfire.Dxp.Data.IndexSet

  Returns a new IndexSet that is a logical XOR between two IndexSet.

  Parameters

  • set1: Spotfire.Dxp.Data.IndexSet

    The first IndexSet.

  • set2: Spotfire.Dxp.Data.IndexSet

    The second IndexSet.

  Returns Spotfire.Dxp.Data.IndexSet

  A new IndexSet

  Since

  2.0