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

Class GraphicalTableColumnSortInfoCollection

Represents a list of columns to sort by.

Since

2.0

Hierarchy (view full)

DocumentNode
- GraphicalTableColumnSortInfoCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Context IsAttached Transactions Add Clear 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<GraphicalTableColumnSortInfo, any, undefined>
Returns Iterator<GraphicalTableColumnSortInfo, 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

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(column): GraphicalTableColumnSortInfo
Adds sorting by the specified column. Does nothing if the specified column is already sorted by.
Parameters
- column: GraphicalTableColumn
  The column to sort by.
Returns GraphicalTableColumnSortInfo
The information object for the sorted column, or null if the visualization in the column does not support sorting.

Since
2.0

Clear

Clear(): void
Removes all elements from this collection. This turns off sorting.

Returns void
Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<GraphicalTableColumnSortInfo>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<GraphicalTableColumnSortInfo>
A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

Since
2.0

Remove

Remove(sortInfo): void
Removes the specified sort info from this collection.
Parameters
- sortInfo: GraphicalTableColumnSortInfo
  The sort info to remove.
Returns void
Since
2.0

TryGetSortInfo

TryGetSortInfo(column, sortInfo): boolean
Tries to get the sort info for the specified column.
Parameters
- column: GraphicalTableColumn
  The column.
- sortInfo: OutParam<GraphicalTableColumnSortInfo>
  The sort info.
Returns boolean
True if found; false otherwise.

Since
2.0