ISeriesApi
Integration guide · Reference index
Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.
isUserEditEnabled
isUserEditEnabled(): boolean;Use the type signature above and the integration guide for the owning capability.
setUserEditEnabled
setUserEditEnabled(enabled: boolean): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
enabled | boolean | Yes |
mergeUp
mergeUp(): void;Use the type signature above and the integration guide for the owning capability.
mergeDown
mergeDown(): void;Use the type signature above and the integration guide for the owning capability.
unmergeUp
unmergeUp(): void;Use the type signature above and the integration guide for the owning capability.
unmergeDown
unmergeDown(): void;Use the type signature above and the integration guide for the owning capability.
detachToRight
detachToRight(): void;Use the type signature above and the integration guide for the owning capability.
detachToLeft
detachToLeft(): void;Use the type signature above and the integration guide for the owning capability.
detachNoScale
detachNoScale(): void;Use the type signature above and the integration guide for the owning capability.
changePriceScale
changePriceScale(newPriceScale: SeriesPriceScale): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
newPriceScale | SeriesPriceScale | Yes |
isVisible
isVisible(): boolean;Use the type signature above and the integration guide for the owning capability.
setVisible
setVisible(visible: boolean): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
visible | boolean | Yes |
bringToFront
bringToFront(): void;Use the type signature above and the integration guide for the owning capability.
sendToBack
sendToBack(): void;Use the type signature above and the integration guide for the owning capability.
entityId
entityId(): EntityId;Use the type signature above and the integration guide for the owning capability.
chartStyleProperties
chartStyleProperties<T extends ChartStyle>(
chartStyle: T,
): SeriesPreferencesMap[T];Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
chartStyle | T | Yes |
setChartStyleProperties
setChartStyleProperties<T extends ChartStyle>(
chartStyle: T,
newPrefs: Partial<SeriesPreferencesMap[T]>,
): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
chartStyle | T | Yes |
newPrefs | Partial<SeriesPreferencesMap[T]> | Yes |