Skip to main content
Version: v26

IExecutionLineAdapter

Interface

An API object used to control execution lines.

Methods

getArrowColor

Get the arrow color of the execution line.

Signature

getArrowColor() => string

Returns

string


getArrowHeight

Get the arrow height of the execution line.

Signature

getArrowHeight() => number

Returns

number


getArrowSpacing

Get the arrow spacing of the execution line.

Signature

getArrowSpacing() => number

Returns

number


getDirection

Get the direction of the execution line.

Signature

getDirection() => Direction

Returns

Direction


getFont

Get the font of the execution line.

Signature

getFont() => string

Returns

string


getPrice

Get the price of the execution line.

Signature

getPrice() => number

Returns

number


getText

Get the text of the execution line.

Signature

getText() => string

Returns

string


getTextColor

Get the text color of the execution line.

Signature

getTextColor() => string

Returns

string


getTime

Get the time of the execution line.

Signature

getTime() => number

Returns

number


getTooltip

Get the tooltip of the execution line.

Signature

getTooltip() => string

Returns

string


remove

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

Signature

remove() => void

Returns

void


setArrowColor

Set the arrow color of the execution line.

Signature

setArrowColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new arrow color.

Returns

this


setArrowHeight

Set the arrow height of the execution line.

Signature

setArrowHeight(value: number) => this

Parameters

NameTypeDescription
valuenumberThe new arrow height.

Returns

this


setArrowSpacing

Set the arrow spacing of the execution line.

Signature

setArrowSpacing(value: number) => this

Parameters

NameTypeDescription
valuenumberThe new arrow spacing.

Returns

this


setDirection

Set the direction of the execution line.

Signature

setDirection(value: Direction) => this

Parameters

NameTypeDescription
valueDirectionThe new direction.

Returns

this


setFont

Set the font of the execution line.

Signature

setFont(value: string) => this

Parameters

NameTypeDescription
valuestringThe new font.

Returns

this


setPrice

Set the price of the execution line.

Signature

setPrice(value: number) => this

Parameters

NameTypeDescription
valuenumberThe new price.

Returns

this


setText

Set the text of the execution line.

Signature

setText(value: string) => this

Parameters

NameTypeDescription
valuestringThe new text.

Returns

this


setTextColor

Set the text color of the execution line.

Signature

setTextColor(value: string) => this

Parameters

NameTypeDescription
valuestringThe new text color.

Returns

this


setTime

Set the time of the execution line.

Signature

setTime(value: number) => this

Parameters

NameTypeDescription
valuenumberThe new time.

Returns

this


setTooltip

Set the tooltip of the execution line.

Signature

setTooltip(value: string) => this

Parameters

NameTypeDescription
valuestringThe new tooltip.

Returns

this