Skip to main content
Version: v25

AccountManagerInfo

Interface
Types Module: Broker

Properties​

accountTitle​

Name of the broker

Type​

​string

customFormatters​

Optional

Optional array to define custom formatters. Each description is an object with the following fields:

  1. name: FormatterName

    • Unique name of a formatter.

  2. formatText: TableFormatTextFunction -Function that is used for formatting of a cell value to string. Required because used to generate exported data.

  3. formatElement: CustomTableFormatElementFunction | undefined

    • Optional function that is used for formatting of a cell value to string or HTMLElement.

If the formatElement function is provided, then only it will be used to format the displayed values, otherwise formatText will be used. If you need to only display string values it is better to use only formatText for performance reasons.

Example

{
    name: 'closeButton' as FormatterName, // Typecast to FormatterName. Use constant in real code
    formatText: () => '', // Returns an empty string because we don't need to display this in the exported data
    formatElement: ({ values: [id] }: TableFormatterInputs<[id: string]>) => {
        const button = document.createElement('button');

        button.innerText = 'Close';

        button.addEventListener('click', () => {
            event.stopPropagation();

            closePosition(id);
        });

        return button;
    },
}

Type​

​CustomTableElementFormatter<TableFormatterInputValues>[]

historyColumns​

Optional

History page will be displayed if it exists. All orders from previous sessions will be shown in the History.

Type​

​AccountManagerColumn[]

historyColumnsSorting​

Optional

Optional sorting of the history table.

Type​

​SortingParameters

marginUsed​

Optional

Margin used

Type​

​IWatchedValue<number>

orderColumns​

Columns description that you want to be displayed on the Orders page. You can display any field of an Order or add your own fields to an order object and display them.

Type​

​OrderTableColumn[]

orderColumnsSorting​

Optional

Optional sorting of the orders table.

Type​

​SortingParameters

pages​

You can add new tabs in the Account Manager by using pages. Each tab is a set of tables.

Type​

​AccountManagerPage[]

positionColumns​

Optional

You can display any field of a Position or add your own fields to a position object and display them.

Type​

​AccountManagerColumn[]

possibleOrderStatuses​

Optional

Optional list of statuses to be used in the orders filter. Default list is used if it hasn't been set.

Type​

​OrderStatus[]

summary​

Custom fields which will always be displayed above the pages.

Type​

​AccountManagerSummaryField[]

tradeColumns​

Optional

You can display any field of a Trade or add your own fields to a trade object and display them.

Type​

​AccountManagerColumn[]

Methods​

contextMenuActions​

Optional

Optional function to create a custom context menu.

Signature​

contextMenuActions(contextMenuEvent: MouseEvent | TouchEvent, activePageActions: ActionMetaInfo[]) => Promise<ActionMetaInfo[]>

Parameters​

NameTypeDescription
contextMenuEventMouseEvent | TouchEventMouseEvent or TouchEvent object passed by a browser
activePageActionsActionMetaInfo[]array of ActionMetaInfo items for the current page

Returns​

Promise that is resolved with an array of ActionMetaInfo

​Promise<ActionMetaInfo[]>