Interface: IExecutionLineAdapter
Charting Library.IExecutionLineAdapter
An API object that controls execution lines created with IChartWidgetApi.createExecutionShape. For more information, refer to Trading primitives.
Methods
getArrowColor
getArrowColor(): string
Get the arrow color of the execution line.
Returns
string
getArrowHeight
getArrowHeight(): number
Get the arrow height of the execution line.
Returns
number
getArrowSpacing
getArrowSpacing(): number
Get the arrow spacing of the execution line.
Returns
number
getDirection
getDirection(): Direction
Get the direction of the execution line.
Returns
getFont
getFont(): string
Get the font of the execution line.
Returns
string
getPrice
getPrice(): number
Get the price of the execution line.
Returns
number
getText
getText(): string
Get the text of the execution line.
Returns
string
getTextColor
getTextColor(): string
Get the text color of the execution line.
Returns
string
getTime
getTime(): number
Get the time of the execution line.
Returns
number
getTooltip
getTooltip(): string
Get the tooltip of the execution line.
Returns
string
getVisible
getVisible(): boolean
Get the visibility of the execution line, as set with setVisible.
Note that this is not whether the execution line is currently drawn: the
tradingProperties.showExecutions chart property and the chart's current symbol
also have to allow it.
Returns
boolean
remove
remove(): void
Remove the execution line. This API object cannot be used after this call.
setArrowColor
setArrowColor(value): IExecutionLineAdapter
Set the arrow color of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new arrow color. |
Returns
setArrowHeight
setArrowHeight(value): IExecutionLineAdapter
Set the arrow height of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new arrow height. |
Returns
setArrowSpacing
setArrowSpacing(value): IExecutionLineAdapter
Set the arrow spacing of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new arrow spacing. |
Returns
setDirection
setDirection(value): IExecutionLineAdapter
Set the direction of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | Direction | The new direction. |
Returns
setFont
setFont(value): IExecutionLineAdapter
Set the font of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new font. |
Returns
setPrice
setPrice(value): IExecutionLineAdapter
Set the price of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new price. |
Returns
setText
setText(value): IExecutionLineAdapter
Set the text of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new text. |
Returns
setTextColor
setTextColor(value): IExecutionLineAdapter
Set the text color of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new text color. |
Returns
setTime
setTime(value): IExecutionLineAdapter
Set the time of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The new time. |
Returns
setTooltip
setTooltip(value): IExecutionLineAdapter
Set the tooltip of the execution line.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The new tooltip. |
Returns
setVisible
setVisible(value): IExecutionLineAdapter
Show or hide the execution line, including its price axis label.
A hidden execution line keeps its state and callbacks, so it can be shown
again without being re-created.
Hiding or showing the execution line also emits a drawing_event for its ID.
Note that the tradingProperties.showExecutions chart property hides every
execution line at once; this flag applies to a single execution line and both have to
allow the execution line for it to be displayed.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | The new visibility, where true shows the execution line. |
Returns
Default
true