IPriceScaleApi
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.
getMode
getMode(): PriceScaleMode;Use the type signature above and the integration guide for the owning capability.
setMode
setMode(newMode: PriceScaleMode): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
newMode | PriceScaleMode | Yes |
isInverted
isInverted(): boolean;Use the type signature above and the integration guide for the owning capability.
setInverted
setInverted(isInverted: boolean): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
isInverted | boolean | Yes |
isLocked
isLocked(): boolean;Use the type signature above and the integration guide for the owning capability.
setLocked
setLocked(isLocked: boolean): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
isLocked | boolean | Yes |
isAutoScale
isAutoScale(): boolean;Use the type signature above and the integration guide for the owning capability.
setAutoScale
setAutoScale(isAutoScale: boolean): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
isAutoScale | boolean | Yes |
getVisiblePriceRange
getVisiblePriceRange(): VisiblePriceRange | null;Use the type signature above and the integration guide for the owning capability.
setVisiblePriceRange
setVisiblePriceRange(range: VisiblePriceRange): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
range | VisiblePriceRange | Yes |
hasMainSeries
hasMainSeries(): boolean;Use the type signature above and the integration guide for the owning capability.
getStudies
getStudies(): EntityId[];Use the type signature above and the integration guide for the owning capability.
currency
currency(): CurrencyInfo | null;Use the type signature above and the integration guide for the owning capability.
setCurrency
setCurrency(currency: string | null): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
currency | string | null | Yes |
unit
unit(): UnitInfo | null;Use the type signature above and the integration guide for the owning capability.
setUnit
setUnit(unit: string | null): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
unit | string | null | Yes |