Interface: ISeriesApi
Charting Library.ISeriesApi
Series API
You can retrieve this interface by using the IChartWidgetApi.getSeries method
Methods
bringToFront
bringToFront(): void
Places main series on top of all other chart objects
changePriceScale
changePriceScale(newPriceScale): void
Changes the price scale of the main series
Parameters
| Name | Type |
|---|---|
newPriceScale | SeriesPriceScale |
chartStyleProperties
chartStyleProperties<T>(chartStyle): SeriesPreferencesMap[T]
Returns properties for a specific chart style
Type parameters
| Name | Type |
|---|---|
T | extends ChartStyle |
Parameters
| Name | Type |
|---|---|
chartStyle | T |
Returns
detachNoScale
detachNoScale(): void
Makes the main series to be an overlay source
detachToLeft
detachToLeft(): void
Pins the main series to a new price axis at left
detachToRight
detachToRight(): void
Pins the main series to a new price axis at right
entityId
entityId(): EntityId
Value that is returned when a study is created via API
Returns
isUserEditEnabled
isUserEditEnabled(): boolean
Returns true if a user is able to remove/change/hide the main series
Returns
boolean
isVisible
isVisible(): boolean
Returns true if the main series is visible
Returns
boolean
mergeDown
mergeDown(): void
Moves the main series to the pane below. Note that this method works only if the pane exists.
mergeUp
mergeUp(): void
Moves the main series to the pane above. Note that this method works only if the pane exists.
sendToBack
sendToBack(): void
Places main series behind all other chart objects
setChartStyleProperties
setChartStyleProperties<T>(chartStyle, newPrefs): void
Sets properties for a specific chart style
Type parameters
| Name | Type |
|---|---|
T | extends ChartStyle |
Parameters
| Name | Type |
|---|---|
chartStyle | T |
newPrefs | DeepPartial<SeriesPreferencesMap[T]> |
setUserEditEnabled
setUserEditEnabled(enabled): void
Enables or disables removing/changing/hiding the main series by the user
Parameters
| Name | Type |
|---|---|
enabled | boolean |
setVisible
setVisible(visible): void
Shows/hides the main series
Parameters
| Name | Type |
|---|---|
visible | boolean |
statusVW
statusVW(): IWatchedValueReadonly<Status>
Returns a watched value representing the current series status.
Returns
unmergeDown
unmergeDown(): void
Moves the main series to a new pane below. Note that this method does not work if the main series is the only series on the current pane.
unmergeUp
unmergeUp(): void
Moves the main series to a new pane above. Note that this method does not work if the main series is the only series on the current pane.