Skip to main content

AccountManagerColumnBase<TFormatterName>

Interface
Types Module: Broker

Column properties for the Account Manager pages.

Type parameters​

NameType
TFormatterNameextends StandardFormatterName | FormatterName

Properties​

alignment​

Optional

Horizontal alignment of the cell value. The default value is left.

AlignmentDescription
leftIt aligns the cell value to the left.
rightIt aligns the cell value to the right.

Type​

​CellAlignment

dataFields​

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.

Type​

​TFormatterName extends StandardFormatterName ? StandardFormattersDependenciesMapping[TFormatterName<TFormatterName>] : string[]

formatter​

Optional

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 Default formatters section to see the full list of formatters.

You can also create custom formatters using the AccountManagerInfo.customFormatters property.

Type​

​TFormatterName

help​

Optional

Tooltip string for the column.

Type​

​string

hideByDefault​

Optional

Setting hideByDefault to true hides the column by default.

Type​

​boolean

highlightDiff​

Optional

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.

Type​

​boolean

id​

Unique column identifier.

Type​

​string

isCapitalize​

Optional

If set to true, the first character of every word in the sentence in the column will be capitalized. The default value is true.

Type​

​boolean

label​

Column title. It will be displayed in the table's header row.

Type​

​string

notHideable​

Optional

Setting notHideable to true prevents the column from being hidden.

Type​

​boolean

notSortable​

Optional

When set to true will prevent column sorting.

Type​

​boolean

showZeroValues​

Optional

Setting showZeroValues to true hides any zero values. The default value is true.

Type​

​boolean

sortProp​

Optional

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.

Type​

​string

tooltipProperty​

Optional

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.

Type​

​string