Skip to main content
Version: v27

ISeriesApi

Interface

Series API

You can retrieve this interface by using the IChartWidgetApi.getSeries method

Methods

bringToFront

Places main series on top of all other chart objects

Signature

bringToFront() => void

Returns

void


changePriceScale

Changes the price scale of the main series

Signature

changePriceScale(newPriceScale: SeriesPriceScale) => void

Parameters

NameType
newPriceScaleSeriesPriceScale

Returns

void


chartStyleProperties

Returns properties for a specific chart style

Signature

chartStyleProperties<T>(chartStyle: T) => SeriesPreferencesMap[T]

Type parameters

NameType
Textends ChartStyle

Parameters

NameType
chartStyleT

Returns

SeriesPreferencesMap[T]


detachNoScale

Makes the main series to be an overlay source

Signature

detachNoScale() => void

Returns

void


detachToLeft

Pins the main series to a new price axis at left

Signature

detachToLeft() => void

Returns

void


detachToRight

Pins the main series to a new price axis at right

Signature

detachToRight() => void

Returns

void


entityId

Value that is returned when a study is created via API

Signature

entityId() => EntityId

Returns

EntityId


isUserEditEnabled

Returns true if a user is able to remove/change/hide the main series

Signature

isUserEditEnabled() => boolean

Returns

boolean


isVisible

Returns true if the main series is visible

Signature

isVisible() => boolean

Returns

boolean


mergeDown

Merges the main series down (if possible)

Signature

mergeDown() => void

Returns

void


mergeUp

Merges the main series up (if possible)

Signature

mergeUp() => void

Returns

void


sendToBack

Places main series behind all other chart objects

Signature

sendToBack() => void

Returns

void


setChartStyleProperties

Sets properties for a specific chart style

Signature

setChartStyleProperties<T>(chartStyle: T, newPrefs: Partial<SeriesPreferencesMap[T]>) => void

Type parameters

NameType
Textends ChartStyle

Parameters

NameType
chartStyleT
newPrefsPartial<SeriesPreferencesMap[T]>

Returns

void


setUserEditEnabled

Enables or disables removing/changing/hiding the main series by the user

Signature

setUserEditEnabled(enabled: boolean) => void

Parameters

NameType
enabledboolean

Returns

void


setVisible

Shows/hides the main series

Signature

setVisible(visible: boolean) => void

Parameters

NameType
visibleboolean

Returns

void


unmergeDown

Unmerges the main series down (if possible)

Signature

unmergeDown() => void

Returns

void


unmergeUp

Unmerges the main series up (if possible)

Signature

unmergeUp() => void

Returns

void