Api

IStudyApi

Download Markdown

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

getInputsInfo

getInputsInfo(): StudyInputInformation[];

Use the type signature above and the integration guide for the owning capability.

getInputValues

getInputValues(): StudyInputValueItem[];

Use the type signature above and the integration guide for the owning capability.

setInputValues

setInputValues(values: StudyInputValueItem[]): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`values`	`StudyInputValueItem[]`	Yes

getStyleInfo

getStyleInfo(): StudyStyleInfo;

Use the type signature above and the integration guide for the owning capability.

getStyleValues

getStyleValues(): StudyStyleValues;

Use the type signature above and the integration guide for the owning capability.

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.

changePriceScale

changePriceScale(newPriceScale: StudyPriceScale | EntityId): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`newPriceScale`	`StudyPriceScale \| EntityId`	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.

applyOverrides

applyOverrides<TOverrides extends Partial<SingleIndicatorOverrides>>(
    overrides: TOverrides,
  ): void;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`overrides`	`TOverrides`	Yes

applyToEntireLayout

applyToEntireLayout(): void;

Use the type signature above and the integration guide for the owning capability.

onDataLoaded

onDataLoaded(): ISubscription<() => void>;

Use the type signature above and the integration guide for the owning capability.

onStudyError

onStudyError(): ISubscription<() => void>;

Use the type signature above and the integration guide for the owning capability.