Scope API

Provides access to a suite of functions related to the Scope object used in multiple AdapTable functions.

Scope API Methods

MethodDescription
getColumnIdsInScope(scope)Returns all the ColumnIds in the Scope
getColumnsForScope(scope)Returns a list of all Columns in the given Scope
getDataTypesInScope(scope)Returns all the DataTypes in the Scope
getScopeDescription(scope)Provides a description for the Scope
getScopeToString(scope)Gets a string representation of the Scope
isColumnInDateScope(column, scope)Returns true if Scope has Data DataType which contains Column
isColumnInNumericScope(column, scope)Returns true if Scope has Numeric DataType containing Column
isColumnInScope(column, scope)Returns true if Column is in given Scope
isColumnInScopeColumns(column, scope)Returns true if Column is in Scope's 'ColumnIds' section
isColumnInStringsScope(column, scope)Returns true if Scope has String DataType containing Column
isPrimaryKeyColumnInScopeColumns(scope)Whether PK column is included in Scope's column section
isScopeInScope(scopeA, scopeB)Returns true if first scope is in second Scope
isSingleColumnScope(scope)Returns true if Scope contains just 1 ColumnId
scopeHasColumns(scope)Returns true if Scope contains ColumnIds
scopeHasDataType(scope)Returns true if Scope contains DataTypes
scopeIsAll(scope)Returns true if Scope is 'All'
scopeIsEmpty(scope)Returns true if Scope is empty

See API documentation for full details of all available functions with lists of parameters