Skip to main content
Version: v26

BrokerCustomUI

Interface
Types Module: Broker

Properties

showCancelOrderDialog

Optional

Shows a confirmation dialog and executes handler if YES/OK is pressed.

Type

(order: Order) => Promise<boolean>

Type declaration

Shows a confirmation dialog and executes handler if YES/OK is pressed.

Signature

(order: Order) => Promise<boolean>
Parameters
NameTypeDescription
orderOrderorder to be cancelled
Returns

Promise<boolean>


showClosePositionDialog

Optional

Shows the Close Position Dialog.

Type

(position: Position) => Promise<boolean>

Type declaration

Shows the Close Position Dialog.

Signature

(position: Position) => Promise<boolean>
Parameters
NameTypeDescription
positionPositionposition to be closed
Returns

Promise<boolean>


showOrderDialog

Optional

Shows standard Order Ticket to create or modify an order and executes handler if Buy/Sell/Modify is pressed.

Type

(order: OrderTemplate | Order, focus?: OrderTicketFocusControl) => Promise<boolean>

Type declaration

Shows standard Order Ticket to create or modify an order and executes handler if Buy/Sell/Modify is pressed.

Signature

(order: OrderTemplate | Order, focus?: OrderTicketFocusControl) => Promise<boolean>
Parameters
NameTypeDescription
orderOrderTemplate | Orderorder to be placed or modified
focus?OrderTicketFocusControlControl to focus on when dialog is opened
Returns

Promise<boolean>


showPositionDialog

Optional

Shows the Position Dialog

Type

(position: Position | Trade, brackets: Brackets, focus?: OrderTicketFocusControl) => Promise<boolean>

Type declaration

Shows the Position Dialog

Signature

(position: Position | Trade, brackets: Brackets, focus?: OrderTicketFocusControl) => Promise<boolean>
Parameters
NameTypeDescription
positionPosition | Tradeposition to be placed or modified
bracketsBracketsbrackets for the position
focus?OrderTicketFocusControlControl to focus on when dialog is opened
Returns

Promise<boolean>