Interface: IOrderLineAdapter
Charting Library.IOrderLineAdapter
An API object used to control order lines.
Methods
getBodyBackgroundColor
▸ getBodyBackgroundColor(): string
Get the body background color of the order line.
Returns
string
getBodyBorderColor
▸ getBodyBorderColor(): string
Get the body border color of the order line.
Returns
string
getBodyFont
▸ getBodyFont(): string
Get the body font of the order line.
Returns
string
getBodyTextColor
▸ getBodyTextColor(): string
Get the body text color of the order line.
Returns
string
getCancelButtonBackgroundColor
▸ getCancelButtonBackgroundColor(): string
Get the cancel button background color of the order line.
Returns
string
getCancelButtonBorderColor
▸ getCancelButtonBorderColor(): string
Get the cancel button border color of the order line.
Returns
string
getCancelButtonIconColor
▸ getCancelButtonIconColor(): string
Get the cancel button icon color of the order line.
Returns
string
getCancelTooltip
▸ getCancelTooltip(): string
Get the cancel tooltip of the order line.
Returns
string
getCancellable
▸ getCancellable(): boolean
Get the cancellable flag value of the order line.
Returns
boolean
getEditable
▸ getEditable(): boolean
Get the editable flag value of the order line.
Returns
boolean
getExtendLeft
▸ getExtendLeft(): boolean
Get the extend left flag value of the order line.
Returns
boolean
getLineColor
▸ getLineColor(): string
Get the line color of the order line.
Returns
string
getLineLength
▸ getLineLength(): number
Get the line length of the order line.
Returns
number
getLineLengthUnit
▸ getLineLengthUnit(): OrderLineLengthUnit
Get the unit of length specified for the line length of the order line.
Returns
getLineStyle
▸ getLineStyle(): number
Get the line style of the order line.
Returns
number
getLineWidth
▸ getLineWidth(): number
Get the line width of the order line.
Returns
number
getModifyTooltip
▸ getModifyTooltip(): string
Get the modify tooltip of the order line.
Returns
string
getPrice
▸ getPrice(): number
Get the price of the order line.
Returns
number
getQuantity
▸ getQuantity(): string
Get the quantity of the order line.
Returns
string
getQuantityBackgroundColor
▸ getQuantityBackgroundColor(): string
Get the quantity background color of the order line.
Returns
string
getQuantityBorderColor
▸ getQuantityBorderColor(): string
Get the quantity border color of the order line.
Returns
string
getQuantityFont
▸ getQuantityFont(): string
Get the quantity font of the order line.
Returns
string
getQuantityTextColor
▸ getQuantityTextColor(): string
Get the quantity text color of the order line.
Returns
string
getText
▸ getText(): string
Get the text of the order line.
Returns
string
getTooltip
▸ getTooltip(): string
Get the tooltip of the order line.
Returns
string
onCancel
▸ onCancel(callback): this
Attach a callback to be executed when the order line is cancelled.
Parameters
| Name | Type | Description |
|---|---|---|
callback | () => void | Callback to be executed when the order line is cancelled. |
Returns
this
▸ onCancel<T>(data, callback): this
Attach a callback to be executed when the order line is cancelled.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
data | T | Data to be passed to the callback. |
callback | (data: T) => void | Callback to be executed when the order line is cancelled. |
Returns
this
onModify
▸ onModify(callback): this
Attach a callback to be executed when the order line is modified.
Parameters
| Name | Type | Description |
|---|---|---|
callback | () => void | Callback to be executed when the order line is modified. |
Returns
this
▸ onModify<T>(data, callback): this
Attach a callback to be executed when the order line is modified.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
data | T | Data to be passed to the callback. |
callback | (data: T) => void | Callback to be executed when the order line is modified. |
Returns
this
onMove
▸ onMove(callback): this
Attach a callback to be executed when the order line is moved.
Parameters
| Name | Type | Description |
|---|---|---|
callback | () => void | Callback to be executed when the order line is moved. |
Returns
this
▸ onMove<T>(data, callback): this
Attach a callback to be executed when the order line is moved.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
data | T | Data to be passed to the callback. |
callback | (data: T) => void | Callback to be executed when the order line is moved. |
Returns
this
onMoving
▸ onMoving(callback): this
Attach a callback to be executed while the order line is being moved.
Parameters
| Name | Type | Description |
|---|---|---|
callback | () => void | Callback to be executed while the order line is being moved. |
Returns
this
▸ onMoving<T>(data, callback): this
Attach a callback to be executed while the order line is being moved.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
data | T | Data to be passed to the callback. |
callback | (data: T) => void | Callback to be executed while the order line is being moved. |
Returns
this
remove
▸ remove(): void
Remove the order line. This API object cannot be used after this call.
Returns
void
setBodyBackgroundColor
▸ setBodyBackgroundColor(value): this
Set the body background color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new body background color. |
Returns
this
setBodyBorderColor
▸ setBodyBorderColor(value): this
Set the body border color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new body border color. |
Returns
this
setBodyFont
▸ setBodyFont(value): this
Set the body font of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new body font. |
Returns
this
setBodyTextColor
▸ setBodyTextColor(value): this
Set the body text color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new body text color. |
Returns
this
setCancelButtonBackgroundColor
▸ setCancelButtonBackgroundColor(value): this
Set the cancel button background color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new cancel button background color. |
Returns
this
setCancelButtonBorderColor
▸ setCancelButtonBorderColor(value): this
Set the cancel button border color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new cancel button border color. |
Returns
this
setCancelButtonIconColor
▸ setCancelButtonIconColor(value): this
Set the cancel button icon color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new cancel button icon color. |
Returns
this
setCancelTooltip
▸ setCancelTooltip(value): this
Set the cancel tooltip of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new cancel tooltip |
Returns
this
setCancellable
▸ setCancellable(value): this
Set the cancellable flag value of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | The new cancellable flag value. |
Returns
this
setEditable
▸ setEditable(value): this
Set the editable of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | The new editable. |
Returns
this
setExtendLeft
▸ setExtendLeft(value): this
Set the extend left flag value of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | The new extend left flag value. |
Returns
this
setLineColor
▸ setLineColor(value): this
Set the line color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new line color. |
Returns
this
setLineLength
▸ setLineLength(value, unit?): this
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.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new line length. |
unit? | OrderLineLengthUnit | unit for the line length, defaults to 'percentage'. |
Returns
this
setLineStyle
▸ setLineStyle(value): this
Set the line style of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new line style. |
Returns
this
setLineWidth
▸ setLineWidth(value): this
Set the line width of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new line width. |
Returns
this
setModifyTooltip
▸ setModifyTooltip(value): this
Set the modify tooltip of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new modify tooltip |
Returns
this
setPrice
▸ setPrice(value): this
Set the price of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new price |
Returns
this
setQuantity
▸ setQuantity(value): this
Set the quantity of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new quantity. |
Returns
this
setQuantityBackgroundColor
▸ setQuantityBackgroundColor(value): this
Set the quantity background color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new quantity background color. |
Returns
this
setQuantityBorderColor
▸ setQuantityBorderColor(value): this
Set the quantity border color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new quantity border color. |
Returns
this
setQuantityFont
▸ setQuantityFont(value): this
Set the quantity font of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new quantity font. |
Returns
this
setQuantityTextColor
▸ setQuantityTextColor(value): this
Set the quantity text color of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new quantity text color. |
Returns
this
setText
▸ setText(value): this
Set the text of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new text |
Returns
this
setTooltip
▸ setTooltip(value): this
Set the tooltip of the order line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new tooltip |
Returns
this