Skip to main content

Interface: BrokerConfigFlags

Charting Library.BrokerConfigFlags

Properties​

calculatePLUsingLast​

• Optional calculatePLUsingLast: boolean

Calculate Profit / Loss using last value.

Default

false

closePositionCancelsOrders​

• Optional closePositionCancelsOrders: boolean

Closing a position cancels its brackets.

Default

false

positionPLInInstrumentCurrency​

• Optional positionPLInInstrumentCurrency: boolean

Using this flag you can display PL in instrument currency.

Default

false

requiresFIFOCloseTrades​

• Optional requiresFIFOCloseTrades: boolean

Trading account requires closing of trades in FIFO order.

Default

false

showNotificationsLog​

• Optional showNotificationsLog: boolean

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

Default

true

showQuantityInsteadOfAmount​

• Optional showQuantityInsteadOfAmount: boolean

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

Default

false

supportAddBracketsToExistingOrder​

• Optional supportAddBracketsToExistingOrder: boolean

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

Default

true

supportBalances​

• Optional supportBalances: boolean

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

supportCancellingBothBracketsOnly​

• Optional supportCancellingBothBracketsOnly: boolean

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

Default

false

supportClosePosition​

• Optional supportClosePosition: boolean

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

supportCloseTrade​

• Optional supportCloseTrade: boolean

Individual positions (trades) can be closed.

Default

false

supportConfirmations​

• Optional supportConfirmations: boolean

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

Default

false

supportCryptoBrackets​

• Optional supportCryptoBrackets: boolean

Does broker support crypto brackets

Default

false

supportCryptoExchangeOrderTicket​

• Optional supportCryptoExchangeOrderTicket: boolean

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

supportDOM​

• Optional supportDOM: boolean

Does broker support Depth of Market.

Default

false

supportDemoLiveSwitcher​

• Optional supportDemoLiveSwitcher: boolean

Does broker support demo live switcher.

Default

true

supportDisplayBrokerNameInSymbolSearch​

• Optional supportDisplayBrokerNameInSymbolSearch: boolean

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

supportEditAmount​

• Optional supportEditAmount: boolean

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

Default

true

supportExecutions​

• Optional supportExecutions: boolean

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

Default

false

supportLevel2Data​

• Optional supportLevel2Data: boolean

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

Default

false

supportLeverage​

• Optional supportLeverage: boolean

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

Default

false

supportLeverageButton​

• Optional supportLeverageButton: boolean

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

supportLimitOrders​

• Optional supportLimitOrders: boolean

This flag adds limit orders type to Order Ticket.

Default

true

supportMargin​

• Optional supportMargin: boolean

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

supportMarketBrackets​

• Optional supportMarketBrackets: boolean

Using this flag you can disable brackets for market orders.

Default

true

supportMarketOrders​

• Optional supportMarketOrders: boolean

This flag adds market orders type to Order Ticket.

Default

true

supportModifyBrackets​

• Optional supportModifyBrackets: boolean

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

supportModifyDuration​

• Optional supportModifyDuration: boolean

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

Default

false

supportModifyOrderPreview​

• Optional supportModifyOrderPreview: boolean

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

Default

false

supportModifyOrderPrice​

• Optional supportModifyOrderPrice: boolean

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

Default

true

supportModifyOrderType​

• Optional supportModifyOrderType: boolean

Does broker support modifying order type

Default

false

supportModifyTrailingStop​

• Optional supportModifyTrailingStop: boolean

Broker supports modifying trailing stop orders.

Default

true

supportMultiposition​

• Optional supportMultiposition: boolean

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

Default

false

supportNativeReversePosition​

• Optional supportNativeReversePosition: boolean

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

Default

false

supportOnlyPairPositionBrackets​

• Optional supportOnlyPairPositionBrackets: boolean

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

Default

false

supportOrderBrackets​

• Optional supportOrderBrackets: boolean

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

Default

false

supportOrdersHistory​

• Optional supportOrdersHistory: boolean

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

supportPLUpdate​

• Optional supportPLUpdate: boolean

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

supportPartialClosePosition​

• Optional supportPartialClosePosition: boolean

Does broker support partial position closing

Default

false

supportPartialCloseTrade​

• Optional supportPartialCloseTrade: boolean

Does broker support partial trade closing

Default

false

supportPlaceOrderPreview​

• Optional supportPlaceOrderPreview: boolean

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

Default

false

supportPositionBrackets​

• Optional supportPositionBrackets: boolean

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

supportPositions​

• Optional supportPositions: boolean

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

Default

true

supportReversePosition​

• Optional supportReversePosition: boolean

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

Default

false

supportStopLimitOrders​

• Optional supportStopLimitOrders: boolean

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

Default

false

supportStopLimitOrdersInBothDirections​

• Optional supportStopLimitOrdersInBothDirections: boolean

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

supportStopOrders​

• Optional supportStopOrders: boolean

This flag adds stop orders type to Order Ticket.

Default

true

supportStopOrdersInBothDirections​

• Optional supportStopOrdersInBothDirections: boolean

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

supportSymbolSearch​

• Optional supportSymbolSearch: boolean

Broker supports symbol search

Default

false

supportTradeBrackets​

• Optional supportTradeBrackets: boolean

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

supportTrades​

• Optional supportTrades: boolean

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

supportTrailingStop​

• Optional supportTrailingStop: boolean

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