Column Scope Technical Reference
Column Scope
ColumnScope
Which columns an object applies to. Set exactly one shape.
true
Matches every column. All must be true.
('text' | 'number' | 'boolean' | 'date' | 'textArray' | 'numberArray')[]
Data types to match, for example ['number'] or ['text', 'textArray']. Object, tuple and unknown columns are not scope data types. Name those columns with ColumnIds.
string[]
Column ids to match. These are AG Grid colId values.
string[]
AG Grid column type names, the strings set on colDef.type.
Column Scope API
ColumnScopeApi
Whether a column is inside a Column Scope, and the columns, types and data types a scope contains.
boolean
True if all selected columns are boolean
Creates a default single CellColorRange for Styled Column wizards (Gradient,
Percent Bar, Bullet Chart): Col-Min → Col-Max with neutral gray, matching
the colour used when adding a range in the Ranges UI. If the column has no
sample values yet, returns one 0 → 0 gray range.
string | undefined
Gets any ColumnId from the Scope
string[] | undefined
Returns all the ColumnIds in the Scope
Returns list of all Columns in the given Scope
string[] | undefined
Returns all the ColumnTypes in the Scope
ScopeDataType[] | undefined
Returns all the DataTypes in the Scope
string
Provides a description for the Scope
string
Gets string representation of the Scope
string | undefined
Gets the only Column in given Scope
boolean
True if Scope has Data DataType which contains Column
boolean
True if Scope has Numeric DataType containing Column
boolean
True if Column is in given Scope
boolean
True if Column is in Scope's 'ColumnIds' section
boolean
True if Scope has text DataType containing Column
boolean
Whether PK column is included in Scope's column section
boolean
True if first scope is in second Scope
Scope A | Scope B | Result
===========================================================================
All * true
* All true
DataTypes DataTypes all DataTypes from A should be in B
ColumnIds ColumnIds all ColumnIds from A should be in B
ColumnIds DataTypes all DataTypes of ColumnIds from A should be in B
DataTypes ColumnIds false
boolean
True if Scope contains just 1 boolean Column
boolean
True if Scope contains just 1 ColumnId
boolean
True if Scope contains just 1 numeric Column
boolean
True if Scope contains ColumnIds
boolean
True if Scope contains ColumnTypes
boolean
True if Scope contains DataTypes
boolean
True if Scope is DataTypes and contains just 'Boolean'
boolean
True if Scope is 'All'
boolean
True if Scope is empty