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

[Integration guide](https://docs.lumencharts.com/charting-library/reference/compatibility) · [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.

## isUserEditEnabled {#isusereditenabled}

```ts
isUserEditEnabled(): boolean;
```

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

## setUserEditEnabled {#setusereditenabled}

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

```ts
mergeUp(): void;
```

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

## mergeDown {#mergedown}

```ts
mergeDown(): void;
```

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

## unmergeUp {#unmergeup}

```ts
unmergeUp(): void;
```

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

## unmergeDown {#unmergedown}

```ts
unmergeDown(): void;
```

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

## detachToRight {#detachtoright}

```ts
detachToRight(): void;
```

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

## detachToLeft {#detachtoleft}

```ts
detachToLeft(): void;
```

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

## detachNoScale {#detachnoscale}

```ts
detachNoScale(): void;
```

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

## changePriceScale {#changepricescale}

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

```ts
isVisible(): boolean;
```

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

## setVisible {#setvisible}

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

```ts
bringToFront(): void;
```

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

## sendToBack {#sendtoback}

```ts
sendToBack(): void;
```

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

## entityId {#entityid}

```ts
entityId(): EntityId;
```

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

## chartStyleProperties {#chartstyleproperties}

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

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

## Related types

- [SeriesPriceScale](https://docs.lumencharts.com/charting-library/api/SeriesPriceScale)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [ChartStyle](https://docs.lumencharts.com/charting-library/api/ChartStyle)
- [SeriesPreferencesMap](https://docs.lumencharts.com/charting-library/api/SeriesPreferencesMap)

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