Interface: AccountManagerColumnBase<TFormatterName, TPossibleFields>
Broker.AccountManagerColumnBase
Column properties for the Account Manager pages.
Type parameters
| Name | Type |
|---|---|
TFormatterName | extends StandardFormatterName | FormatterName |
TPossibleFields | extends string = string |
Properties
alignment
Optional
alignment: CellAlignment
Horizontal alignment of the cell value. The default value is left.
| Alignment | Description |
|---|---|
| left | It aligns the cell value to the left. |
| right | It aligns the cell value to the right. |
dataFields
dataFields: TFormatterName extends StandardFormatterName ? StandardFormattersDependenciesMapping<TPossibleFields>[TFormatterName] : FieldRef<TPossibleFields>[]
The dataFields array contains fields from an order/position data object.
dataFields is used to generate the values displayed in a column.
The displayed value in the column updates only when the corresponding values in the data object change.
If no formatter is specified, the displayed values will be space-separated in the column.
When a formatter is defined, it processes only the specified values.
If an empty array is assigned to dataFields, the formatter will receive the entire data object.
Example
- For a column with `dataFields` set as `['avgPrice', 'qty']`, the displayed value updates only when the `avgPrice` or `qty` values in the data object change.
- For a column with an empty `dataFields` array, the displayed value updates if any values in the data object change.
formatter
Optional
formatter: TFormatterName
Defines a formatter to be applied for data formatting, which can either belong to the StandardFormatterName or FormatterName type.
If no specific formatter is set, the value is displayed as is.
Default formatter names are enumerated in StandardFormatterName. Refer to the Built-in formatters section to see the full list of formatters.
You can also create custom formatters using the AccountManagerInfo.customFormatters property.
help
Optional
help: string
Tooltip string for the column.
hideByDefault
Optional
hideByDefault: boolean
Setting hideByDefault to true hides the column by default.
highlightDiff
Optional
highlightDiff: boolean
highlightDiff can be set with StandardFormatterName.FormatPrice
and StandardFormatterName.FormatPriceForexSup formatters to highlight the changes of the field.
If highlightDiff is true`, the custom formatters will also get previous values.
id
id: string
Unique column identifier.
isCapitalize
Optional
isCapitalize: boolean
If set to true, the first character of every word in the sentence in the column
will be capitalized. The default value is true.
label
label: string
Column title. It will be displayed in the table's header row.
notHideable
Optional
notHideable: boolean
Setting notHideable to true prevents the column from being hidden.
notSortable
Optional
notSortable: boolean
When set to true will prevent column sorting.
showZeroValues
Optional
showZeroValues: boolean
Setting showZeroValues to true hides any zero values. The default value is true.
sortProp
Optional
sortProp: FieldRef<string>
Data object key that is used for data sorting.
If sortProp is not provided, the first element of the dataFields array will be used.
If the dataFields array is empty, the column sorting will be unavailable.
tooltipProperty
Optional
tooltipProperty: string
Key of the row object that is used to get the tooltip to display when hovering over a cell. The tooltip property refers to an object whose keys are property names and values are the corresponding tooltips.