Skip to main content

IOrderLineAdapter

Interface

An API object used to control order lines.

Methods

getBodyBackgroundColor

Get the body background color of the order line.

Signature

getBodyBackgroundColor() => string

Returns

string


getBodyBorderColor

Get the body border color of the order line.

Signature

getBodyBorderColor() => string

Returns

string


getBodyFont

Get the body font of the order line.

Signature

getBodyFont() => string

Returns

string


getBodyTextColor

Get the body text color of the order line.

Signature

getBodyTextColor() => string

Returns

string


getCancelButtonBackgroundColor

Get the cancel button background color of the order line.

Signature

getCancelButtonBackgroundColor() => string

Returns

string


getCancelButtonBorderColor

Get the cancel button border color of the order line.

Signature

getCancelButtonBorderColor() => string

Returns

string


getCancelButtonIconColor

Get the cancel button icon color of the order line.

Signature

getCancelButtonIconColor() => string

Returns

string


getCancelTooltip

Get the cancel tooltip of the order line.

Signature

getCancelTooltip() => string

Returns

string


getCancellable

Get the cancellable flag value of the order line.

Signature

getCancellable() => boolean

Returns

boolean


getEditable

Get the editable flag value of the order line.

Signature

getEditable() => boolean

Returns

boolean


getExtendLeft

Get the extend left flag value of the order line.

Signature

getExtendLeft() => boolean

Returns

boolean


getLineColor

Get the line color of the order line.

Signature

getLineColor() => string

Returns

string


getLineLength

Get the line length of the order line.

Signature

getLineLength() => number

Returns

number


getLineLengthUnit

Get the unit of length specified for the line length of the order line.

Signature

getLineLengthUnit() => OrderLineLengthUnit

Returns

OrderLineLengthUnit


getLineStyle

Get the line style of the order line.

Signature

getLineStyle() => number

Returns

number


getLineWidth

Get the line width of the order line.

Signature

getLineWidth() => number

Returns

number


getModifyTooltip

Get the modify tooltip of the order line.

Signature

getModifyTooltip() => string

Returns

string


getPrice

Get the price of the order line.

Signature

getPrice() => number

Returns

number


getQuantity

Get the quantity of the order line.

Signature

getQuantity() => string

Returns

string


getQuantityBackgroundColor

Get the quantity background color of the order line.

Signature

getQuantityBackgroundColor() => string

Returns

string


getQuantityBorderColor

Get the quantity border color of the order line.

Signature

getQuantityBorderColor() => string

Returns

string


getQuantityFont

Get the quantity font of the order line.

Signature

getQuantityFont() => string

Returns

string


getQuantityTextColor

Get the quantity text color of the order line.

Signature

getQuantityTextColor() => string

Returns

string


getText

Get the text of the order line.

Signature

getText() => string

Returns

string


getTooltip

Get the tooltip of the order line.

Signature

getTooltip() => string

Returns

string


onCancel

Attach a callback to be executed when the order line is cancelled.

Signature

onCancel(callback: Function) => this

Parameters

NameTypeDescription
callback() => voidCallback to be executed when the order line is cancelled.

Returns

this


Attach a callback to be executed when the order line is cancelled.

Signature

onCancel<T>(data: T, callback: Function) => this

Type parameters

Name
T

Parameters

NameTypeDescription
dataTData to be passed to the callback.
callback(data: T) => voidCallback to be executed when the order line is cancelled.

Returns

this


onModify

Attach a callback to be executed when the order line is modified.

Signature

onModify(callback: Function) => this

Parameters

NameTypeDescription
callback() => voidCallback to be executed when the order line is modified.

Returns

this


Attach a callback to be executed when the order line is modified.

Signature

onModify<T>(data: T, callback: Function) => this

Type parameters

Name
T

Parameters

NameTypeDescription
dataTData to be passed to the callback.
callback(data: T) => voidCallback to be executed when the order line is modified.

Returns

this


onMove

Attach a callback to be executed when the order line is moved.

Signature

onMove(callback: Function) => this

Parameters

NameTypeDescription
callback() => voidCallback to be executed when the order line is moved.

Returns

this


Attach a callback to be executed when the order line is moved.

Signature

onMove<T>(data: T, callback: Function) => this

Type parameters

Name
T

Parameters

NameTypeDescription
dataTData to be passed to the callback.
callback(data: T) => voidCallback to be executed when the order line is moved.

Returns

this


onMoving

Attach a callback to be executed while the order line is being moved.

Signature

onMoving(callback: Function) => this

Parameters

NameTypeDescription
callback() => voidCallback to be executed while the order line is being moved.

Returns

this


Attach a callback to be executed while the order line is being moved.

Signature

onMoving<T>(data: T, callback: Function) => this

Type parameters

Name
T

Parameters

NameTypeDescription
dataTData to be passed to the callback.
callback(data: T) => voidCallback to be executed while the order line is being moved.

Returns

this


remove

Remove the order line. This API object cannot be used after this call.

Signature

remove() => void

Returns

void


setBodyBackgroundColor

Set the body background color of the order line.

Signature

setBodyBackgroundColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new body background color.

Returns

this


setBodyBorderColor

Set the body border color of the order line.

Signature

setBodyBorderColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new body border color.

Returns

this


setBodyFont

Set the body font of the order line.

Example

widget.activeChart().createOrderLine().setPrice(170).setBodyFont("bold 12px Verdana")

Signature

setBodyFont(value: string) => this

Parameters

NameTypeDescription
valuestringThe new body font.

Returns

this


setBodyTextColor

Set the body text color of the order line.

Signature

setBodyTextColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new body text color.

Returns

this


setCancelButtonBackgroundColor

Set the cancel button background color of the order line.

Signature

setCancelButtonBackgroundColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new cancel button background color.

Returns

this


setCancelButtonBorderColor

Set the cancel button border color of the order line.

Signature

setCancelButtonBorderColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new cancel button border color.

Returns

this


setCancelButtonIconColor

Set the cancel button icon color of the order line.

Signature

setCancelButtonIconColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new cancel button icon color.

Returns

this


setCancelTooltip

Set the cancel tooltip of the order line.

Signature

setCancelTooltip(value: string) => this

Parameters

NameTypeDescription
valuestringThe new cancel tooltip

Returns

this


setCancellable

Set the cancellable flag value of the order line.

Signature

setCancellable(value: boolean) => this

Parameters

NameTypeDescription
valuebooleanThe new cancellable flag value.

Returns

this


setEditable

Set the editable of the order line.

Signature

setEditable(value: boolean) => this

Parameters

NameTypeDescription
valuebooleanThe new editable.

Returns

this


setExtendLeft

Set the extend left flag value of the order line.

Signature

setExtendLeft(value: boolean) => this

Parameters

NameTypeDescription
valuebooleanThe new extend left flag value.

Returns

this


setLineColor

Set the line color of the order line.

Signature

setLineColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new line color.

Returns

this


setLineLength

Set the line length of the order line.

If negative number is provided for the value and the unit is 'pixel' then the position will be relative to the left edge of the chart.

Signature

setLineLength(value: number, unit?: OrderLineLengthUnit) => this

Parameters

NameTypeDescription
valuenumberThe new line length.
unit?OrderLineLengthUnitunit for the line length, defaults to 'percentage'.

Returns

this


setLineStyle

Set the line style of the order line.

Signature

setLineStyle(value: number) => this

Parameters

NameTypeDescription
valuenumberThe new line style.

Returns

this


setLineWidth

Set the line width of the order line.

Signature

setLineWidth(value: number) => this

Parameters

NameTypeDescription
valuenumberThe new line width.

Returns

this


setModifyTooltip

Set the modify tooltip of the order line.

Signature

setModifyTooltip(value: string) => this

Parameters

NameTypeDescription
valuestringThe new modify tooltip

Returns

this


setPrice

Set the price of the order line.

Signature

setPrice(value: number) => this

Parameters

NameTypeDescription
valuenumberThe new price

Returns

this


setQuantity

Set the quantity of the order line.

Signature

setQuantity(value: string) => this

Parameters

NameTypeDescription
valuestringThe new quantity.

Returns

this


setQuantityBackgroundColor

Set the quantity background color of the order line.

Signature

setQuantityBackgroundColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new quantity background color.

Returns

this


setQuantityBorderColor

Set the quantity border color of the order line.

Signature

setQuantityBorderColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new quantity border color.

Returns

this


setQuantityFont

Set the quantity font of the order line.

Example

widget.activeChart().createOrderLine().setPrice(170).setQuantityFont("bold 12px Verdana")

Signature

setQuantityFont(value: string) => this

Parameters

NameTypeDescription
valuestringThe new quantity font.

Returns

this


setQuantityTextColor

Set the quantity text color of the order line.

Signature

setQuantityTextColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new quantity text color.

Returns

this


setText

Set the text of the order line.

Signature

setText(value: string) => this

Parameters

NameTypeDescription
valuestringThe new text

Returns

this


setTooltip

Set the tooltip of the order line.

Signature

setTooltip(value: string) => this

Parameters

NameTypeDescription
valuestringThe new tooltip

Returns

this