Skip to main content
Version: v26

BrokerConfigFlags

Interface
Types Module: Broker

Properties​

calculatePLUsingLast​

Optional

Calculate Profit / Loss using last value.

Default

false

Type​

​boolean

closePositionCancelsOrders​

Optional

Closing a position cancels its brackets.

Default

false

Type​

​boolean

positionPLInInstrumentCurrency​

Optional

Using this flag you can display PL in instrument currency.

Default

false

Type​

​boolean

requiresFIFOCloseTrades​

Optional

Trading account requires closing of trades in FIFO order.

Default

false

Type​

​boolean

showNotificationsLog​

Optional

Using this flag you can show/hide the Notifications log tab in the account manager.

Default

true

Type​

​boolean

showQuantityInsteadOfAmount​

Optional

This flag can be used to change "Amount" to "Quantity" in Order Ticket.

Default

false

Type​

​boolean

supportAddBracketsToExistingOrder​

Optional

Using this flag you can disable adding brackets to the existing order.

Default

true

Type​

​boolean

supportBalances​

Optional

Used for crypto currencies only. Allows to get crypto balances for an account. Balances are displayed as the first table of the Account Summary tab.

Default

false

Type​

​boolean

supportCancellingBothBracketsOnly​

Optional

Cancelling a bracket (take profit or stop loss) cancels its pair.

Default

false

Type​

​boolean

supportClosePosition​

Optional

Broker supports closing of a position. If it is not supported by broker, Chart will have the close button, but it will place a closing order.

Default

false

Type​

​boolean

supportCloseTrade​

Optional

Individual positions (trades) can be closed.

Default

false

Type​

​boolean

supportConfirmations​

Optional

With this flag you can show a checkbox to disable the confirmation dialog display

Default

false

Type​

​boolean

supportCryptoBrackets​

Optional

Does broker support crypto brackets

Default

false

Type​

​boolean

supportCryptoExchangeOrderTicket​

Optional

Whether the account is used to exchange(trade) crypto currencies. This flag switches Order Ticket to the Crypto Exchange mode. It adds second currency quantity control, currency labels etc.

Default

false

Type​

​boolean

supportDOM​

Optional

Does broker support Depth of Market.

Default

false

Type​

​boolean

supportDemoLiveSwitcher​

Optional

Does broker support demo live switcher.

Default

true

Type​

​boolean

supportDisplayBrokerNameInSymbolSearch​

Optional

Display broker symbol name in the symbol search. You may usually want to disable it if broker symbols are the same or you are using internal numbers as broker symbol names.

Default

true

Type​

​boolean

supportEditAmount​

Optional

Using this flag you can disable existing order's quantity modification.

Default

true

Type​

​boolean

supportExecutions​

Optional

Broker supports executions. If this flag is set to true the Chart will display executions.

Default

false

Type​

​boolean

supportLevel2Data​

Optional

Level2 data is used for DOM widget. subscribeDepth and unsubscribeDepth should be implemented.

Default

false

Type​

​boolean

supportLeverage​

Optional

Broker supports leverage. If the flag is set to true, broker will calculate leverage using leverageInfo (IBrokerWithoutRealtime.leverageinfo) method.

Default

false

Type​

​boolean

supportLeverageButton​

Optional

Broker supports leverage button. If the flag is set to true, a leverage input field will appear in Order Ticket. Click on the input field will activate a dedicated Leverage Dialog.

Default

true

Type​

​boolean

supportLimitOrders​

Optional

This flag adds limit orders type to Order Ticket.

Default

true

Type​

​boolean

supportMargin​

Optional

Broker supports margin. If the broker supports margin it should call marginAvailableUpdate (IBrokerConnectionAdapterHost.marginAvailableUpdate) when the Trading Platform subscribes using subscribeMarginAvailable (IBrokerWithoutRealtime.subscribeMarginAvailable).

Default

false

Type​

​boolean

supportMarketBrackets​

Optional

Using this flag you can disable brackets for market orders.

Default

true

Type​

​boolean

supportMarketOrders​

Optional

This flag adds market orders type to Order Ticket.

Default

true

Type​

​boolean

supportModifyBrackets​

Optional

Using this flag you can disable existing order's brackets modification. If you set it to false, additional fields will be disabled in Order Ticket on the chart, and 'Modify' button will be hidden from the chart and in the Account Manager.

Default

true

Type​

​boolean

supportModifyDuration​

Optional

Using this flag you can enable modification of the duration of the existing order.

Default

false

Type​

​boolean

supportModifyOrderPreview​

Optional

Broker provides the estimated commission, fees, margin and other order information before modifying the order without actually modifying it.

Default

false

Type​

​boolean

supportModifyOrderPrice​

Optional

Using this flag you can disable existing order's price modification.

Default

true

Type​

​boolean

supportModifyOrderType​

Optional

Does broker support modifying order type

Default

false

Type​

​boolean

supportModifyTrailingStop​

Optional

Broker supports modifying trailing stop orders.

Default

true

Type​

​boolean

supportMultiposition​

Optional

Supporting multiposition prevents creating the default implementation for a reversing position.

Default

false

Type​

​boolean

supportNativeReversePosition​

Optional

Broker natively supports reversing of a position. If it is not natively supported by broker, Chart will place a reversing order.

Default

false

Type​

​boolean

supportOnlyPairPositionBrackets​

Optional

Stop Loss and Take Profit are added or removed only together.

Default

false

Type​

​boolean

supportOrderBrackets​

Optional

Broker supports brackets (take profit and stop loss) for orders.

Default

false

Type​

​boolean

supportOrdersHistory​

Optional

Broker supports orders history. If it is set to true, there will be an additional tab in the Account Manager - Orders History. The ordersHistory method should be implemented. It should return a list of orders with the filled, cancelled and rejected statuses from previous trade sessions.

Default

false

Type​

​boolean

supportPLUpdate​

Optional

Broker provides PL for a position. If the broker calculates profit/loss by itself it should call plUpdate as soon as PL is changed. Otherwise Chart will calculate PL as a difference between the current trade and an average price of the position.

Default

true

Type​

​boolean

supportPartialClosePosition​

Optional

Does broker support partial position closing

Default

false

Type​

​boolean

supportPartialCloseTrade​

Optional

Does broker support partial trade closing

Default

false

Type​

​boolean

supportPlaceOrderPreview​

Optional

Broker provides the estimated commission, fees, margin and other order information before placing the order without actually placing it.

Default

false

Type​

​boolean

supportPositionBrackets​

Optional

Broker supports brackets (take profit and stop loss orders) for positions. If this flag is set to true the Chart will display an Edit button for positions and add Edit position... to the context menu of a position.

Default

false

Type​

​boolean

supportPositions​

Optional

Broker supports positions. If it is set to false, the Positions tab in the Account Manager will be hidden.

Default

true

Type​

​boolean

supportReversePosition​

Optional

Broker supports reversing of a position. If it is not supported by broker, the reverse position button will be hidden.

Default

false

Type​

​boolean

supportStopLimitOrders​

Optional

This flag adds stop-limit orders type to Order Ticket.

Default

false

Type​

​boolean

supportStopLimitOrdersInBothDirections​

Optional

Enabling this flag prevents the check of stop price direction from the stop limit Order Ticket.

Type​

​boolean

supportStopOrders​

Optional

This flag adds stop orders type to Order Ticket.

Default

true

Type​

​boolean

supportStopOrdersInBothDirections​

Optional

Whether stop orders should behave like Market-if-touched in both directions. Enabling this flag prevents the check of stop price direction from the stop limit Order Ticket.

Default

false

Type​

​boolean

supportSymbolSearch​

Optional

Broker supports symbol search

Default

false

Type​

​boolean

supportTradeBrackets​

Optional

Broker supports brackets for trades (take profit and stop loss orders). If this flag is set to true the Chart will display an Edit button for trades (individual positions) and add Edit position... to the context menu of a trade.

Default

false

Type​

​boolean

supportTrades​

Optional

Broker supports individual positions (trades). If it is set to true, there will be two tabs in the Account Manager - Individual Positions and Net Positions.

Default

false

Type​

​boolean

supportTrailingStop​

Optional

Broker supports trailing stop orders. If this flag is set to true, then the chart displays trailing stop orders and a user can place a trailing stop order using Order Ticket.

Default

false

Type​

​boolean