FormatColumn
Object used in Format Column function
TypeScript
export interface FormatColumn extendsExtends
Properties
| Property | Description | Default |
|---|---|---|
| ColumnGroupScope | When to format Columns in Column Groups ('Expanded', 'Collapsed', 'Both') | |
| DisplayFormat | Display Format to apply to Column can be Numeric, String or Date | |
| Name | Name of the Format Column definition | |
| RowScope | Which types of Rows to apply format (data, grouped, summary, total) | |
| Rule | Rule to decide whether to apply Format; if undefined Format is always applied | |
| Scope | Where Format will be applied: whole Row, some Columns, or Columns of DataType | |
| Style | AdapTable Style to apply | |
| Target | Where in Column to apply Format (cell or columnHeader) | 'cell' |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') | |
| IsSuspended | Suspends (i.e. turns off) an Adaptable Object |
Property Details
ColumnGroupScope
When to format Columns in Column Groups ('Expanded', 'Collapsed', 'Both')
TypeScript
ColumnGroupScope?: ColumnGroupScope;Property Value
DisplayFormat
Display Format to apply to Column can be Numeric, String or Date
TypeScript
DisplayFormat?: AdaptableFormat;Property Value
Name
Name of the Format Column definition
TypeScript
Name: string;Property Value
string
RowScope
Which types of Rows to apply format (data, grouped, summary, total)
TypeScript
RowScope?: RowScope;Property Value
Rule
Rule to decide whether to apply Format; if undefined Format is always applied
TypeScript
Rule?: FormatColumnRule;Property Value
Scope
Where Format will be applied: whole Row, some Columns, or Columns of DataType
TypeScript
Scope: ColumnScope;Property Value
Style
AdapTable Style to apply
TypeScript
Style?: AdaptableStyle;Property Value
Target
Where in Column to apply Format (cell or columnHeader)
TypeScript
Target?: FormatColumnTarget;Default Value
'cell'
Property Value
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
TypeScript
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
TypeScript
IsReadOnly?: boolean;Property Value
boolean