About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class TableSortInfoCollection

Contains info on how to sort the table plot.

Since

2.0

Hierarchy (view full)

DocumentNode
- TableSortInfoCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Context Count IsAttached Transactions Add Clear Contains GetEnumerator Remove TryGetSortInfo

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj): 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.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

[iterator]

[iterator](): Iterator<TableSortInfo, any, undefined>
Returns Iterator<TableSortInfo, any, undefined>

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
The number of items in the collection.

Returns number
Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

Add

Add(dataColumn, sortMode): void
Adds a column that will be used to sort the table plot after.
Parameters
- dataColumn: DataColumn
  The data column to sort by.
- sortMode: TablePlotColumnSortMode
  Determines how to sort
Returns void
Since
2.0

Clear

Clear(): void
Removes all items in the collection.

Returns void
Since
2.0

Contains

Contains(dataColumn): boolean
Determines if a column is present in the collection.
Parameters
- dataColumn: DataColumn
  The column to look for.
Returns boolean
True if the column was present in the collection, false otherwise.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<TableSortInfo>
Gets an enumerator over the items in the collection.

Returns System.Collections.Generic.IEnumerator<TableSortInfo>
The enumerator.

Since
2.0

Remove

Remove(dataColumn): boolean
Removes a data column from the colleciton.
Parameters
- dataColumn: DataColumn
  The data column to remove.
Returns boolean
True if the column was present in the collection, false otherwise.

Since
2.0

TryGetSortInfo

TryGetSortInfo(dataColumn, sortInfo): boolean
Gets the sort info corresponding to a given data column if it exists.
Parameters
- dataColumn: DataColumn
  The data column to look for.
- sortInfo: OutParam<TableSortInfo>
  Contains info about how a given column is sorted if it is sorted.
Returns boolean
True if the dataColumn was present in the collection, false otherwise.

Since
2.0