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
Returns
void
changePriceScale
▸ changePriceScale(newPriceScale): void
Changes the price scale of the main series
Parameters
| Name | Type |
|---|---|
newPriceScale | SeriesPriceScale |
Returns
void
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
Returns
void
detachToLeft
▸ detachToLeft(): void
Pins the main series to a new price axis at left
Returns
void
detachToRight
▸ detachToRight(): void
Pins the main series to a new price axis at right
Returns
void
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
Merges the main series down (if possible)
Returns
void
mergeUp
▸ mergeUp(): void
Merges the main series up (if possible)
Returns
void
sendToBack
▸ sendToBack(): void
Places main series behind all other chart objects
Returns
void
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 | Partial<SeriesPreferencesMap[T]> |
Returns
void
setUserEditEnabled
▸ setUserEditEnabled(enabled): void
Enables or disables removing/changing/hiding the main series by the user
Parameters
| Name | Type |
|---|---|
enabled | boolean |
Returns
void
setVisible
▸ setVisible(visible): void
Shows/hides the main series
Parameters
| Name | Type |
|---|---|
visible | boolean |
Returns
void
unmergeDown
▸ unmergeDown(): void
Unmerges the main series down (if possible)
Returns
void
unmergeUp
▸ unmergeUp(): void
Unmerges the main series up (if possible)
Returns
void