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