BrokerConfigFlags

Interface

Types Module: Broker

Properties

calculatePLUsingLast

Optional

Enables Profit & Loss calculations using last value.

Default

false

Type

​boolean

---

closePositionCancelsOrders

Optional

Closing a position cancels its brackets.

Default

false

Type

​boolean

---

positionPLInInstrumentCurrency

Optional

Enables displaying Profit & Loss values in instrument currency.

Default

false

Type

​boolean

---

requiresFIFOCloseIndividualPositions

Optional

Enables closing of individual positions in FIFO order.

Default

false

Type

​boolean

---

showNotificationsLog

Optional

Enables the Notifications log tab in the Account Manager.

Default

true

Type

​boolean

---

showQuantityInsteadOfAmount

Optional

Changes Amount to Quantity in Order Ticket.

Default

false

Type

​boolean

---

supportAddBracketsToExistingOrder

Optional

Enables adding brackets to the existing order.

Default

true

Type

​boolean

---

supportBalances

Optional

Allows getting crypto balances for an account. Balances are displayed as the first table of the Account Summary tab. Use the flag for crypto currencies only. This flag requires the IBrokerConnectionAdapterHost.cryptoBalanceUpdate method to be implemented.

Default

false

Type

​boolean

---

supportCancellingBothBracketsOnly

Optional

Modifies the confirmation dialog text for closing a bracket order. When set to true, the text explicitly states that cancelling a bracket order will also cancel its associated pair. When set to false, the text will include the ID of the singular bracket order being cancelled.

Note that the library does not cancel orders itself. You should implement the IBrokerTerminal.cancelOrder or IBrokerTerminal.cancelOrders method.

Default

false

Type

​boolean

---

supportCloseIndividualPosition

Optional

Enables individual position closing. This flag requires the IBrokerTerminal.closeIndividualPosition method to be implemented.

Default

false

Type

​boolean

---

supportClosePosition

Optional

Enables position closing. This flag requires the IBrokerTerminal.closePosition method to be implemented. If supportClosePosition is set to true, the library displays a close button and calls the closePosition method. If supportClosePosition is set to false, the library displays a close button but calls the IBrokerTerminal.placeOrder method with the isClose property set to true.

Default

false

Type

​boolean

---

supportCryptoBrackets

Optional

Enables crypto brackets.

Default

false

Type

​boolean

---

supportCryptoExchangeOrderTicket

Optional

Enables cryptocurrency trading (exchanging). This flag switches the Order Ticket to Crypto Exchange mode, which provides additional controls for entering the quantity in either the base or quote currency.

Default

false

Type

​boolean

---

supportDOM

Optional

Enables the Depth of Market (DOM) widget. Note that you should also enable the BrokerConfigFlags.supportLevel2Data flag and implement the subscribeDepth and unsubscribeDepth methods to provide Level 2 data for the DOM widget.

Default

false

Type

​boolean

---

supportDemoLiveSwitcher

Optional

Enables demo live switcher.

Default

true

Type

​boolean

---

supportEditAmount

Optional

Enables order quantity editing. If you set this flag to false, the quantity control in the Order Ticket will be disabled when users modify orders.

Default

true

Type

​boolean

---

supportExecutions

Optional

Enables executions. This flag requires the IBrokerTerminal.executions method to be implemented.

Default

false

Type

​boolean

---

supportGuaranteedStop

Optional

Enables guaranteed stop loss orders. If you set this flag to true, the library displays guaranteed stop orders and a user can place a guaranteed stop order using the Order Ticket.

Default

false

Type

​boolean

---

supportIndividualPositionBrackets

Optional

Enables brackets for individual positions: take-profit and stop-loss orders. If you set this flag to true, the library displays an Edit button for individual positions and Edit position... in the individual position's context menu. This flag requires the IBrokerTerminal.editIndividualPositionBrackets method to be implemented.

Default

false

Type

​boolean

---

supportLevel2Data

Optional

Enables Level 2 data for the Depth of Market (DOM) widget. This flag requires the subscribeDepth and unsubscribeDepth methods to be implemented. Note that you should also enable the BrokerConfigFlags.supportDOM flag to display the DOM widget in the UI.

Default

false

Type

​boolean

---

supportLeverage

Optional

Enables trading with leverage. If the flag is set to true, you should calculate the leverage using the IBrokerWithoutRealtime.leverageInfo method.

Default

false

Type

​boolean

---

supportLeverageButton

Optional

Displays a leverage button in the UI. Note that you should also enable the BrokerConfigFlags.supportLeverage flag. If supportLeverageButton is set to true, the leverage input field appears in the Order Ticket. Clicking the input field activates a dedicated Leverage Dialog.

Default

true

Type

​boolean

---

supportLimitOrders

Optional

Enables limit orders type in the Order Ticket.

Default

true

Type

​boolean

---

supportMargin

Optional

Allows margin. If supportMargin is set to true, you should call IBrokerConnectionAdapterHost.marginAvailableUpdate when the Trading Platform subscribes to margin available updates using IBrokerWithoutRealtime.subscribeMarginAvailable.

Default

false

Type

​boolean

---

supportMarketBrackets

Optional

Enables brackets for market orders.

Default

true

Type

​boolean

---

supportMarketOrders

Optional

Enables market orders type in the Order Ticket.

Default

true

Type

​boolean

---

supportModifyBrackets

Optional

Enables order brackets editing. If you set this flag to false, the bracket's control in the Order Ticket will be disabled, and the Modify button will be hidden from the chart and in the Account Manager.

Default

true

Type

​boolean

---

supportModifyDuration

Optional

Allows modifying existing order duration.

Default

false

Type

​boolean

---

supportModifyOrderPreview

Optional

Allows providing the estimated commission, fees, margin, and other order information before modifying the order without actually modifying it. This information will be displayed in the Order confirmation dialog.

This flag requires the IBrokerTerminal.previewOrder method to be implemented and confirmId parameter to be passed in the IBrokerTerminal.modifyOrder method. Refer to Enable order preview for more information.

Default

false

Type

​boolean

---

supportModifyOrderPrice

Optional

Enables order price editing. If you set this flag to false, the price control in the Order Ticket will be disabled when users modify orders.

Default

true

Type

​boolean

---

supportModifyOrderType

Optional

Allows modifying order type.

Default

false

Type

​boolean

---

supportModifyTrailingStop

Optional

Allows modifying trailing stop orders.

Default

true

Type

​boolean

---

supportMultiposition

Optional

Enables multiple positions for one instrument at the same time. Supporting multiple positions prevents creating the default implementation for a reversing position.

Default

false

Type

​boolean

---

supportNativeReversePosition

Optional

Enables native position reversing. This flag requires the IBrokerTerminal.reversePosition method to be implemented. If supportNativeReversePosition is set to false, the library expects you to place a reversing order via the IBrokerTerminal.placeOrder method.

Default

false

Type

​boolean

---

supportOnlyPairPositionBrackets

Optional

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

Default

false

Type

​boolean

---

supportOrderBrackets

Optional

Enables order brackets: take-profit and stop-loss.

Default

false

Type

​boolean

---

supportOrdersHistory

Optional

Enables orders history. If supportOrdersHistory is set to true, the Account Manager will have an additional tab: Orders History. This flag requires the IBrokerTerminal.ordersHistory method to be implemented. The method should return a list of orders with the filled, cancelled, and rejected statuses from previous trade sessions.

Default

false

Type

​boolean

---

supportPLUpdate

Optional

Allows you to use your own Profit & Loss (P&L) values for positions. If supportPLUpdate is set to true, you should call the IBrokerConnectionAdapterHost.plUpdate method as soon as P&L values are changed. If supportPLUpdate is set to false, the library automatically calculates P&L values as the difference between the current trade and the average position price.

Default

true

Type

​boolean

---

supportPartialCloseIndividualPosition

Optional

Enables partial individual position closing. This flag requires the IBrokerTerminal.closeIndividualPosition method to be implemented.

Default

false

Type

​boolean

---

supportPartialClosePosition

Optional

Enables partial position closing. This flag requires the IBrokerTerminal.closePosition method to be implemented.

Default

false

Type

​boolean

---

supportPlaceOrderPreview

Optional

Allows providing the estimated commission, fees, margin, and other order information before placing the order without actually placing it. This information will be displayed in the Order confirmation dialog.

This flag requires the IBrokerTerminal.previewOrder method to be implemented and confirmId parameter to be passed in the IBrokerTerminal.placeOrder method. Refer to Enable order preview for more information.

Default

false

Type

​boolean

---

supportPositionBrackets

Optional

Enables position brackets: take-profit and stop-loss orders. If you set supportPositionBrackets to true, the library displays an Edit button for positions and Edit position... in the position's context menu. This flag requires the IBrokerTerminal.editPositionBrackets method to be implemented.

Default

false

Type

​boolean

---

supportPositionNetting

Optional

Enables individual and net positions. If you set this flag to true, the Account Manager will have two tabs: Individual Positions and Net Positions. This flag requires the IBrokerTerminal.individualPositions method to be implemented.

Default

false

Type

​boolean

---

supportPositions

Optional

Enables positions. This flag requires the IBrokerTerminal.positions method to be implemented. If you set supportPositions to false, the Positions tab in the Account Manager will be hidden.

Default

true

Type

​boolean

---

supportReversePosition

Optional

Enables position reversing. If supportReversePosition is set to false, the Reverse Position button will be hidden from the UI.

Default

false

Type

​boolean

---

supportStopLimitOrders

Optional

Enables stop-limit orders type in the Order Ticket.

Default

false

Type

​boolean

---

supportStopLimitOrdersInBothDirections

Optional

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

Type

​boolean

---

supportStopOrders

Optional

Enables stop orders type in the 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

---

supportStrictCheckingLimitOrderPrice

Optional

Whether the integration supports limit price validation in the order ticket to eliminate the possibility to place an order on the wrong side of the market that will most likely trigger and get filled immediately.

Type

​boolean

---

supportSymbolSearch

Optional

Enables symbol searching.

Default

false

Type

​boolean

---

supportTrailingStop

Optional

Enables trailing stop orders. If you set this flag to true, the library displays trailing stop orders and a user can place a trailing stop order using the Order Ticket.

Default

false

Type

​boolean