Class Order

Top-level order assembled from the operation, position, and margin groups.

Constructors

constructor

Accessors

margin operation position

Methods

[dispose] clone free

Constructors

constructor

  • new Order(): Order

  • Constructs an empty order; populate it through the group setters.

    Returns Order

Accessors

margin

  • get margin(): undefined | OrderMargin

  • The margin group, or undefined.

    Returns undefined | OrderMargin

  • set margin(value): void

  • Sets the margin group.

    Accepts an OrderMargin object or a plain OrderMarginInit literal.

    Errors

    Throws ParamError/AssetError when a literal field is invalid.

    Parameters

    Returns void

operation

  • get operation(): undefined | OrderOperation

  • The operation group, or undefined.

    Returns undefined | OrderOperation

  • set operation(value): void

  • Sets the operation group.

    Accepts an OrderOperation object or a plain OrderOperationInit literal.

    Errors

    Throws ParamError/AssetError when a literal field is invalid.

    Parameters

    Returns void

position

  • get position(): undefined | OrderPosition

  • The position group, or undefined.

    Returns undefined | OrderPosition

  • set position(value): void

  • Sets the position group.

    Accepts an OrderPosition object or a plain OrderPositionInit literal.

    Errors

    Throws ParamError when a literal field is invalid.

    Parameters

    Returns void

Methods

[dispose]

  • [dispose](): void

  • Returns void

clone

  • clone(): Order

  • Returns a deep copy of this order, including its groups.

    Returns Order

free

  • free(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods