<!-- Public documentation export; not library implementation source. -->
# IPriceScaleApi

[Integration guide](https://docs.lumencharts.com/charting-library/configuration#chart-types-panes-and-scales) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

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}

```ts
getMode(): PriceScaleMode;
```

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

## setMode {#setmode}

```ts
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}

```ts
isInverted(): boolean;
```

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

## setInverted {#setinverted}

```ts
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}

```ts
isLocked(): boolean;
```

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

## setLocked {#setlocked}

```ts
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}

```ts
isAutoScale(): boolean;
```

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

## setAutoScale {#setautoscale}

```ts
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}

```ts
getVisiblePriceRange(): VisiblePriceRange | null;
```

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

## setVisiblePriceRange {#setvisiblepricerange}

```ts
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}

```ts
hasMainSeries(): boolean;
```

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

## getStudies {#getstudies}

```ts
getStudies(): EntityId[];
```

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

## currency {#currency}

```ts
currency(): CurrencyInfo | null;
```

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

## setCurrency {#setcurrency}

```ts
setCurrency(currency: string | null): void;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `currency` | `string &#124; null` | Yes |

## unit {#unit}

```ts
unit(): UnitInfo | null;
```

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

## setUnit {#setunit}

```ts
setUnit(unit: string | null): void;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `unit` | `string &#124; null` | Yes |

## Related types

- [PriceScaleMode](https://docs.lumencharts.com/charting-library/api/PriceScaleMode)
- [VisiblePriceRange](https://docs.lumencharts.com/charting-library/api/VisiblePriceRange)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [CurrencyInfo](https://docs.lumencharts.com/charting-library/api/CurrencyInfo)
- [UnitInfo](https://docs.lumencharts.com/charting-library/api/UnitInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPriceScaleApi