# Lumen Charts documentation

Public integration documentation for a proprietary library. Runtime access is separately authorized. Exported API signatures do not imply that all legacy capabilities are supported; preserve compatibility notes when using these documents.

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

Lumen Charts is a standalone proprietary charting product.

Add interactive financial charts to your web app, powered by your own data. Lumen Charts gives you the browser runtime, chart controls, drawings, indicators and APIs for saving and loading. Your app brings the market data, sign-in and storage.

## Choose your path

| I want to… | Start here |
| --- | --- |
| Show my first chart | [Your first chart](https://docs.lumencharts.com/charting-library/getting-started/quickstart) |
| Use React, Vue or Nuxt | [Lifecycle and frameworks](https://docs.lumencharts.com/charting-library/getting-started/lifecycle#framework-integrations) |
| Feed in historical and live prices | [Datafeed contract](https://docs.lumencharts.com/charting-library/datafeed) |
| Match my product's look | [Themes and UI](https://docs.lumencharts.com/charting-library/configuration/themes) |
| Save and restore a user's analysis | [Saving and loading](https://docs.lumencharts.com/charting-library/persistence) |
| Add automation or AI-assisted workflows | [AI integration](https://docs.lumencharts.com/charting-library/automation/) |
| Let users trade from the chart | [Trading](https://docs.lumencharts.com/charting-library/trading/) |
| Look up a method or type | [API reference](https://docs.lumencharts.com/charting-library/api/) |
| Fix something that isn't working | [Troubleshooting](https://docs.lumencharts.com/charting-library/reference/troubleshooting) |
| Try it right now | [Examples](https://docs.lumencharts.com/examples/) or the [interactive demo](https://docs.lumencharts.com/demo/) |

## Get started

You need three things to see a chart: the runtime files on a web server, a container with a real height, and a datafeed. It's fine to begin with sample data and swap in your own service later.

1. [Get and host the runtime](https://docs.lumencharts.com/charting-library/getting-started/installation).
2. [Show your first chart](https://docs.lumencharts.com/charting-library/getting-started/quickstart).
3. [Connect your market data](https://docs.lumencharts.com/charting-library/datafeed).
4. [Clean up when the view closes](https://docs.lumencharts.com/charting-library/getting-started/lifecycle).
5. [Save layouts](https://docs.lumencharts.com/charting-library/persistence).

The [demo](https://docs.lumencharts.com/demo/) needs no sign-in. The examples use a fixed sample period in UTC, not live market prices.

## How it fits into your app

The widget you create adds an iframe that holds the chart and its controls. Your datafeed sends bars to the chart through callbacks. The public widget and chart APIs give you commands and event subscriptions. Pine, native automation and trading are optional and load from separate assets. Your application supplies AI providers, the broker connection, uploads, account access and other hosted services.

Call the public API once its ready callback fires. Avoid reaching into iframe globals, canvas state or internal model objects; they can change without notice. When the view that hosts the chart goes away, remove the widget.

## What's in scope

The runtime supports a focused set of compatible features. The type declarations also include some legacy interfaces, and those are not a promise that the behavior works. The [compatibility guide](https://docs.lumencharts.com/charting-library/reference/compatibility) explains how to tell them apart. The runtime does not include a broker connection, an exchange feed or a hosted storage service with sign-in. [Trading](https://docs.lumencharts.com/charting-library/trading/) connects to a broker through an adapter you write.

[Start building →](https://docs.lumencharts.com/charting-library/getting-started/quickstart)

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


---

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

Want help from an AI assistant? These exports give it the same public docs you're reading here. To share a single article, use **Copy for LLM** or **Download Markdown** under its title.

## Complete documentation

- [Download all documentation as Markdown](https://docs.lumencharts.com/markdown/all.md) — all public guides, API reference and examples in one file, approximately 2 MB.
- [View the LLM documentation index](https://docs.lumencharts.com/llms.txt) — the pages to start with, common integration mistakes, then every guide with a one-line summary, in reading order.
- [View the complete documentation as text](https://docs.lumencharts.com/llms-full.txt) — the same full content in a plain-text file.

The full export may be too big for some AI tools. If so, start with the section for your task, then add the API pages it links to.

## Section exports

| Section | Markdown |
| --- | --- |
| Overview | [Download overview](https://docs.lumencharts.com/markdown/sections/overview.md) |
| Getting started | [Download getting started](https://docs.lumencharts.com/markdown/sections/getting-started.md) |
| Connect data | [Download datafeed guides](https://docs.lumencharts.com/markdown/sections/datafeed.md) |
| Configure the chart | [Download configuration guides](https://docs.lumencharts.com/markdown/sections/configuration.md) |
| Drawings | [Download drawing guides](https://docs.lumencharts.com/markdown/sections/drawings.md) |
| Indicators and Pine | [Download indicator guides](https://docs.lumencharts.com/markdown/sections/studies.md) |
| Save and restore | [Download saving guides](https://docs.lumencharts.com/markdown/sections/persistence.md) |
| AI integration | [Download AI integration guides](https://docs.lumencharts.com/markdown/sections/automation.md) |
| Reference | [Download reference guides](https://docs.lumencharts.com/markdown/sections/reference.md) |
| Examples | [Download examples](https://docs.lumencharts.com/markdown/sections/examples.md) |
| Demo | [Download demo documentation](https://docs.lumencharts.com/markdown/sections/demo.md) |
| API reference | [Download API reference](https://docs.lumencharts.com/markdown/sections/api.md) |

## What is included

Exports include the public guides, API signatures and integration examples. Interactive charts are replaced with links to the browser examples. Compatibility notes are kept, because they're part of the API contract: a legacy declaration doesn't guarantee that a feature is available.

Library source files, runtime downloads, source maps and private repository documents are never included. Access to the runtime is still [authorized separately](https://docs.lumencharts.com/charting-library/getting-started/installation).

`llms.txt` helps AI tools find these docs, but there's no guarantee a given tool will read it automatically. If needed, give the tool the document or its URL directly.

---
Documentation page: https://docs.lumencharts.com/charting-library/llm-resources


---

<!-- Public documentation export; not library implementation source. -->
# Installation and asset hosting

Lumen Charts is proprietary software. This site gives you technical documentation and an interactive demo to try it out. It is not a public library download or source repository, and there is no public npm install command. Two parts are the exception: the [AI integration SDK](https://docs.lumencharts.com/charting-library/automation/) and the [trading platform](https://docs.lumencharts.com/charting-library/trading/) are open source under the Apache License 2.0 and install from npm.

## Runtime access

To use the chart in production you need [a licence](https://lumencharts.com/pricing), which gives you the runtime and its matching TypeScript declarations as a download from your account. The runtime is a minified production build without source maps; the declarations describe the whole public API. It makes no network calls of its own and needs no licence key. Source code is not part of a standard licence; ask us about Enterprise if you need it.

You can try the chart in the [interactive demo](https://docs.lumencharts.com/demo/) without installing anything. The demo loads compiled browser files so it can run in your browser. That doesn't give permission to reuse or redistribute them.

The hosting steps below apply once you have an authorized copy. Serve the files over HTTP; opening the page as a `file:` URL won't work.

## Directory layout

```text
index.html
your-datafeed.js
lumen_charting_library/
  lumen_charting_library.js
  lumen_charting_library.inner.js
  lumen_charting_library.inner.css
  assets/
    chart-automation.js           # automation runtime, loaded by openAutomation()
    chart-trading.js              # trading runtime, loaded by loadTrading()
    chart-trading.css
  bundles/                       # optional Pine assets
  lumen_charting_library.d.ts
  datafeed-api.d.ts
```

Set `library_path` to the runtime folder, including the trailing slash. The script URL and `library_path` must point to the same release. Serve JavaScript and CSS with the correct MIME types, and return a real 404 for missing files. If your server returns an HTML page in place of a missing script, the chart will fail to start.

## Automation runtime

Every release includes `assets/chart-automation.js`. Host it with the other files and keep it from the same build as the core. The chart downloads it only on the first `openAutomation()` or `widget.loadAutomation()` call, so charts that never use automation never load it. The SDK that drives it is open source and installs from npm; shipping the runtime file doesn't import the SDK or configure an AI provider. See [AI integration](https://docs.lumencharts.com/charting-library/automation/) for the product boundaries and SDK setup.

## Trading runtime

Every release also includes `assets/chart-trading.js` and `assets/chart-trading.css`. Host them with the other files, from the same build as the core. The chart downloads them only when you call `widget.loadTrading()`, so charts without trading never load them. See [Trading](https://docs.lumencharts.com/charting-library/trading/) to connect a broker.

## Base paths and caching

If your app lives under `/terminal/`, use `/terminal/lumen_charting_library/` or another path that resolves to the same place. Putting the version in the path lets you cache files forever without mixing an old wrapper with new inner files. Deploy all the files together in one step, and keep the previous release around so you can roll back.

To start, serve the runtime files from the same origin as your app. Moving them to a CDN means also handling iframe access, CSS, worker loading and CSP. Moving images to another host is fine, but that doesn't mean the runtime scripts can move safely too.

## Content security policy

Right now the startup script writes the iframe document and uses inline startup configuration. Test your app's script, frame and style policies against the actual release rather than copying a strict generic policy. Optional Pine also needs permission to run a worker. If something is blocked, don't turn off CSP entirely. Find the blocked resource in the browser console and allow only what it needs.

[Show your first chart →](https://docs.lumencharts.com/charting-library/getting-started/quickstart)

---
Documentation page: https://docs.lumencharts.com/charting-library/getting-started/installation


---

<!-- Public documentation export; not library implementation source. -->
# Your first chart

You'll need an [authorized copy of the runtime](https://docs.lumencharts.com/charting-library/getting-started/installation) and a datafeed. Just want to see it work? The interactive example at the bottom of this page uses sample data and needs no install.

## Create a container

Give the chart container a real height. `autosize` makes the chart fill its container, but it can't give an empty container a height.

```html
<div id="chart" style="width:100%;height:560px"></div>
<script src="./lumen_charting_library/lumen_charting_library.js"></script>
```

## Mount the widget

```js
import { createDatafeed } from './your-datafeed.js';

const feed = createDatafeed();
const widget = new LumenChartingLibrary.widget({
  container: 'chart',
  library_path: './lumen_charting_library/',
  datafeed: feed.datafeed,
  symbol: 'AAPL',
  interval: '1D',
  locale: 'en',
  timezone: 'Etc/UTC',
  autosize: true,
  theme: 'light',
});

widget.onChartReady(() => {
  console.log(widget.activeChart().symbol());
});

// When the view is destroyed:
// widget.remove();
// feed.dispose();
```

## TypeScript

Import types from the declaration files that ship next to your runtime. The script tag above loads the browser global. A type-only import gives you types but doesn't load the runtime.

```ts
import type { LumenChartingLibraryWidgetOptions, ResolutionString } from './lumen_charting_library/lumen_charting_library';
const options: LumenChartingLibraryWidgetOptions = {
  container: 'chart', library_path: './lumen_charting_library/',
  datafeed, symbol: 'AAPL', interval: '1D' as ResolutionString, locale: 'en',
};
```

Here `datafeed` is your own datafeed. The library doesn't come with a market data connection. In TypeScript, resolutions use the `ResolutionString` type. Decide which values you support and check them in your datafeed.

## Check that it works

You should see candles and volume, a symbol toolbar and drawing controls. If the container stays blank, the usual causes are a missing runtime file, a parent with zero height, or a datafeed callback that never gets called. See [troubleshooting](https://docs.lumencharts.com/charting-library/reference/troubleshooting) for more help.

[Interactive chart example](https://docs.lumencharts.com/charting-library/getting-started/quickstart) — runs in a browser with synthetic data.

[Connect real data →](https://docs.lumencharts.com/charting-library/datafeed)

---
Documentation page: https://docs.lumencharts.com/charting-library/getting-started/quickstart


---

<!-- Public documentation export; not library implementation source. -->
# Lifecycle and frameworks

Each widget belongs to the view that hosts it. Create it once, wait until it's ready, and remove it when the view goes away.

## Two "ready" moments

`onChartReady(callback)` tells you the chart API is ready to use. `headerReady()` tells you when you can add header controls. A ready chart may still be waiting for data from the network. To know when bars have arrived, use the chart's data status or subscriptions.

```js
widget.onChartReady(() => {
  const chart = widget.activeChart();
  const owner = {};
  const handle = chart.onDataLoaded();
  const onLoaded = () => console.log('Bars available');
  handle.subscribe(owner, onLoaded);
  // Before disposal: handle.unsubscribe(owner, onLoaded);
});
```

## Avoid charts that appear too late

If you load the runtime asynchronously, make sure the host view is still on screen before you create the widget. Say the user changes route while the script is still downloading. When the download finishes, it shouldn't create a chart that nobody can see. Keep one generation counter or cancellation token for each mount.

## Clean up everything you started

Call `widget.remove()`, then close your datafeed's subscriptions, timers and network requests. Remove your own subscriptions and resize observers too. Before you retry after a failure, remove the failed widget first. Removing the visible iframe doesn't stop timers that your own code started.

When you load a saved layout, let the chart finish loading it before you apply separate history checkpoints. An undo stack is no substitute for real saving.

## Framework integrations

The runtime works with any framework. Each host component should own exactly one widget and its datafeed, from creation to cleanup.

| Host | Create the chart in | Clean up in |
| --- | --- | --- |
| Plain HTML/JS | After the document loads and the container exists | Remove the widget and stop the datafeed |
| Vue | `onMounted` | `onBeforeUnmount` |
| Nuxt | A client-only component, once mounted | The same Vue cleanup |
| React | An effect, using a DOM ref | The effect's cleanup, including the extra remount in development |

Only load runtime scripts in the browser. Type-only imports are safe at build time. Importing browser code during server-side rendering can fail because `window` or `document` doesn't exist there.

## React

Create the widget once the container has mounted, and remove it in the same effect's cleanup. In development, React may mount, clean up and mount again. Make sure the first load, if it's still pending, doesn't create a chart after cleanup has run.

```tsx
import { useEffect, useRef } from 'react';
import { loadChartLibrary } from './chart-loader';
import { createDemoDatafeed } from './sample-datafeed';
export function Chart() {
  const container = useRef<HTMLDivElement>(null);
  useEffect(() => {
    let cancelled = false;
    let widget: { remove(): void } | undefined;
    const feed = createDemoDatafeed();
    loadChartLibrary('/lumen_charting_library/').then(library => {
      if (cancelled || !container.current) return;
      widget = new library.widget({
        container: container.current, library_path: '/lumen_charting_library/',
        datafeed: feed.datafeed, symbol: 'AAPL', interval: '1D',
        locale: 'en', autosize: true,
      });
    }).catch(console.error);
    return () => { cancelled = true; widget?.remove(); feed.dispose(); };
  }, []);
  return <div ref={container} style={{ height: 560 }} />;
}
```

In a real component, replace `console.error` with an error state and a retry option. You write the loader and sample datafeed yourself as part of your integration; they don't come from React. For chart commands that change often, call them on the existing widget. Don't add them all to the mount effect's dependencies, or the chart will be rebuilt each time.

## Vue and Nuxt

Create the chart in a client-side lifecycle hook. If loading is asynchronous, check that the component is still mounted before creating the widget.

```vue
<script setup lang="ts">
import { onMounted, onBeforeUnmount, ref } from 'vue';
import { loadChartLibrary } from './chart-loader';
import { createDemoDatafeed } from './sample-datafeed';
const container = ref<HTMLElement>();
let cancelled = false;
let widget: { remove(): void } | undefined;
const feed = createDemoDatafeed();
onMounted(async () => {
  const library = await loadChartLibrary('/lumen_charting_library/');
  if (cancelled || !container.value) return;
  widget = new library.widget({
    container: container.value, library_path: '/lumen_charting_library/',
    datafeed: feed.datafeed, symbol: 'AAPL', interval: '1D',
    locale: 'en', autosize: true,
  });
});
onBeforeUnmount(() => {
  cancelled = true;
  widget?.remove();
  feed.dispose();
});
</script>
<template><div ref="container" style="height:560px" /></template>
```

The loader and datafeed are helpers you write as part of your integration. They aren't Vue APIs, and they aren't library source you can download. Use your authorized copy of the runtime and build these helpers in your app. If the loader fails, show the error in your UI and offer a way to retry.

### Nuxt

Wrap the host in `<ClientOnly>` or use a client component, and keep browser imports on the client side. Serve the runtime files from your app's configured asset path, and remember any deployment prefix. Avoid route watchers that rebuild the chart every time some unrelated state changes.

[Lifecycle example](https://docs.lumencharts.com/examples?example=lifecycle)

---
Documentation page: https://docs.lumencharts.com/charting-library/getting-started/lifecycle


---

<!-- Public documentation export; not library implementation source. -->
# The datafeed contract

The chart gets symbols, historical bars and live updates by asking your datafeed. A datafeed is just an object with callback methods. The chart never connects to an exchange on its own.

## The order of requests

1. `onReady` tells the chart what your datafeed supports overall.
2. `searchSymbols` returns search results when the user searches.
3. `resolveSymbol` returns the details for one symbol.
4. `getBars` returns historical OHLCV bars.
5. `subscribeBars` streams live updates, and `unsubscribeBars` stops each stream.

Call the success and error callbacks asynchronously, so requests don't stack up recursively. Call back exactly once for each request. If your cache shares mutable objects, hand the chart copies so that later changes don't leak back into your cache.

## Start from a working datafeed

This sample datafeed follows the same public contract and needs no network. It only returns history for a fixed period, and it tells the chart clearly when there's no more data.

```ts
// Import these public types from the declarations in your authorized distribution.

export const symbols = ['AAPL', 'MSFT', 'BTCUSD'] as const
export const resolutions = ['15', '60', '1D'] as ResolutionString[]
const day = 86_400_000
export const sampleEnd = Date.UTC(2026, 9, 15)
const sampleStart = sampleEnd - 730 * day

export function resolutionMs(resolution: string): number {
  if (resolution === '1D' || resolution === 'D') return day
  const minutes = Number(resolution)
  if (!Number.isFinite(minutes) || minutes <= 0) throw new Error('Unsupported sample interval')
  return minutes * 60_000
}
export function sampleBar(symbol: string, time: number, step: number): Bar {
  const index = (time - sampleStart) / step
  const base = symbol === 'BTCUSD' ? 62000 : symbol === 'MSFT' ? 400 : 180
  const wave = Math.sin(index * .17) * base * .025 + Math.cos(index * .043) * base * .04
  const open = base + wave + index * base * .00002
  const close = open + Math.sin(index * 1.71) * base * .008
  return { time, open, close, high: Math.max(open, close) + base * .003, low: Math.min(open, close) - base * .003, volume: Math.round(100000 + Math.abs(Math.sin(index)) * 400000) }
}
export function historicalBars(symbol: string, resolution: string, from: number, to: number, countBack: number): Bar[] {
  const step = resolutionMs(resolution)
  const end = Math.min(Math.ceil(to * 1000 / step) * step, sampleEnd)
  const requestedStart = Math.min(from * 1000, end - Math.min(Math.max(0, countBack), 5000) * step)
  const start = Math.max(sampleStart, Math.ceil(requestedStart / step) * step, end - 5000 * step)
  const bars: Bar[] = []
  for (let time = start; time < end; time += step) bars.push(sampleBar(symbol, time, step))
  return bars
}
export function createDemoDatafeed(options: { realtime?: boolean; empty?: boolean } = {}) {
  const timers = new Map<string, ReturnType<typeof setInterval>>()
  let disposed = false
  const later = (callback: () => void) => setTimeout(() => { if (!disposed) callback() }, 0)
  const datafeed: IBasicDataFeed = {
    onReady(callback) { later(() => callback({ supported_resolutions: resolutions, supports_marks: false, supports_timescale_marks: false, supports_time: true })) },
    getServerTime(callback) { later(() => callback(sampleEnd / 1000)) },
    searchSymbols(input, _exchange, _type, callback) {
      later(() => callback(symbols.filter(symbol => symbol.includes(input.toUpperCase())).map(symbol => ({ symbol, full_name: symbol, ticker: symbol, description: `${symbol} · synthetic sample`, exchange: 'DEMO', type: 'stock' }))))
    },
    resolveSymbol(name, success, failure) {
      if (!symbols.includes(name as typeof symbols[number])) { later(() => failure('unknown_symbol')); return }
      const info: LibrarySymbolInfo = { name, ticker: name, description: `${name} · sample data`, type: 'stock', exchange: 'DEMO', listed_exchange: 'DEMO', session: '24x7', timezone: 'Etc/UTC', minmov: 1, pricescale: 100, has_intraday: true, has_daily: true, supported_resolutions: resolutions, volume_precision: 0, format: 'price', data_status: 'streaming' }
      later(() => success(info))
    },
    getBars(info, resolution, period, success, failure) {
      try {
        const bars = options.empty ? [] : historicalBars(info.ticker ?? info.name, resolution, period.from, period.to, period.countBack)
        later(() => success(bars, { noData: bars.length === 0 }))
      } catch (error) { later(() => failure(error instanceof Error ? error.message : 'Sample data unavailable')) }
    },

    subscribeBars(info, resolution, callback, id) {
      datafeed.unsubscribeBars(id)
      if (!options.realtime || options.empty || disposed) return
      const step = resolutionMs(resolution)
      let sequence = 0
      const bar = sampleBar(info.ticker ?? info.name, sampleEnd - step, step)
      timers.set(id, setInterval(() => {
        sequence += 1
        const close = bar.close + Math.sin(sequence * .4) * bar.close * .0005
        callback({ ...bar, close, high: Math.max(bar.high, close), low: Math.min(bar.low, close), volume: (bar.volume ?? 0) + sequence * 100 })
      }, 1000))
    },
    unsubscribeBars(id) { const timer = timers.get(id); if (timer) clearInterval(timer); timers.delete(id) },

  }
  return { datafeed, activeSubscriptions: () => timers.size, dispose() { disposed = true; for (const id of timers.keys()) datafeed.unsubscribeBars(id) } }
}
```

## Your responsibilities in production

Your service should check that the user is signed in and allowed to see the market data before it returns anything. Keep API keys on your server. Convert vendor symbols, sessions and timestamps inside your datafeed. Report errors through the matching callback.

## Symbol search and metadata

`searchSymbols` returns the symbols that match a search. `resolveSymbol` returns enough detail for the chart to format prices, follow trading sessions and offer the right resolutions.

### Fields to fill in

| Field | Meaning |
| --- | --- |
| `name` / `ticker` | The label people see, and the stable ID used in requests |
| `description` | Text shown in search and on the chart |
| `exchange` / `listed_exchange` | Which market the symbol trades on |
| `type` | Kind of instrument |
| `session` | Trading hours; the sample uses `24x7` |
| `timezone` | IANA or exchange timezone supported by the contract |
| `minmov` / `pricescale` | Tick size and price formatting |
| `supported_resolutions` | Resolutions you can deliver for this symbol |
| `has_intraday` / `has_daily` | Whether you have intraday and daily data |
| `volume_precision` | Decimal places for volume |

For decimal prices, `minmov: 1` and `pricescale: 100` give a price step of 0.01. Check each instrument's real tick size rather than copying these values everywhere.

### Unknown symbols

If a symbol isn't found, call the error callback. Don't fall back to some other symbol. Search results should resolve to the same canonical ID they were listed under. If one symbol has several aliases, make sure they don't open competing subscriptions.

The sample uses the labels AAPL, MSFT and BTCUSD with made-up 24×7 data. Its session is only for illustration. It doesn't reflect the real trading hours of those instruments.

## Time units and trading sessions

Convert all times inside your datafeed. Passing a number without knowing its unit (seconds or milliseconds) is one of the most common integration mistakes.

| Value | Unit |
| --- | --- |
| Historical request `from` / `to` | Unix seconds |
| `Bar.time` | Epoch milliseconds |
| Public drawing point `time` | Unix seconds |
| Server time callback | Unix seconds |
| Visible time range | Use the public range contract; seconds |

### Sessions and timezone

Include the exchange session and timezone in your symbol metadata. Changing the display timezone doesn't change the original timestamps. A 24×7 sample feed can't stand in for a real exchange calendar.

Stamp daily bars at the UTC trading-day boundary the contract uses. Test weekends, session changes and daylight-saving changes against real records from your provider. Don't shift bars to match the browser's local timezone.

### Keep resolutions consistent

Every bar must line up with the resolution you advertised. Convert resolution aliases once, inside your datafeed, and use the same IDs for history and realtime subscriptions. If an interval isn't supported, reject it clearly.

## Event marks

Event marks add context such as news or earnings to specific dates or bars. Only provide the mark callbacks if you also say your datafeed supports marks.

### Bar marks and timescale marks

Bar marks sit on the chart's bars. Timescale marks sit on the time axis. Their data and IDs are kept separate from price history. The datafeed reference lists their callbacks.

Give marks stable IDs and valid timestamps. Keep labels short and descriptions useful. If marks show richer content, check provider URLs and text in your datafeed before they reach the chart.

### Refresh and clear

Call `refreshMarks()` to fetch the latest marks and `clearMarks(mode)` to clear one kind of mark. An empty list of marks is a valid answer. After a symbol or resolution change, ignore mark responses that arrive for the old one.

The public demo doesn't offer marks by default. Only turn them on when your provider actually implements the callbacks.

Next: [Historical bars](https://docs.lumencharts.com/charting-library/datafeed/history) · [Realtime updates](https://docs.lumencharts.com/charting-library/datafeed/realtime) · [Datafeed API](https://docs.lumencharts.com/charting-library/api/IDatafeedChartApi)

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


---

<!-- Public documentation export; not library implementation source. -->
# Historical bars and countBack

`getBars(symbolInfo, resolution, period, onHistory, onError)` returns OHLCV bars in time order. `period.from` and `period.to` are in Unix seconds, but each bar's `time` is in epoch milliseconds.

## Return the history the chart asks for

The time window is `[from, to)`: it includes `from` and excludes `to`. `countBack` is the number of bars the chart actually needs, so treat it as the main target. If the window has too few bars, add earlier bars when you have them. If the window has more bars than `countBack`, it's fine to return them all; don't cut the response short.

Return bars with unique timestamps in ascending order and OHLC values that make sense. Daily, weekly and monthly bars are stamped at 00:00 UTC on the trading day. Don't use a local session-open time.

## Match historical and realtime boundaries

History and realtime updates must use the same interval boundaries, symbol, and price basis. For UTC-aligned H1 bars, each candle starts at `11:00`, `12:00`, and so on. A tick at `11:06` updates the candle starting at `11:00`; it doesn't start a new hour-long candle at `11:06`.

The chart uses the timestamps your datafeed supplies. It doesn't automatically realign provider candles. Align the provider's aggregation request **before** it calculates OHLCV. Rounding a returned candle's timestamp cannot correct its contents: a candle covering `11:06–12:06` contains different trades or quotes from one covering `11:00–12:00`.

### Example: Polygon minute multipliers

Polygon's `60/minute` aggregation can preserve a request's starting minute. A request starting at `11:06` can therefore produce H1 candles at `11:06`, `12:06`, and so on. For fixed UTC intervals, align the request start to the same boundary used by your live aggregator:

```js
const intervalMs = 60 * 60_000; // H1; use 15 * 60_000 for M15.
const fromMs = period.from * 1000; // getBars uses seconds.
const alignedFromMs = Math.floor(fromMs / intervalMs) * intervalMs;
const inclusiveToMs = period.to * 1000 - 1; // Convert [from, to) for this provider.

// Use alignedFromMs and inclusiveToMs in the provider's aggregate request.
// Keep the returned OHLCV values and candle-start timestamps together.
```

This may request an earlier candle that overlaps `period.from`; account for that when selecting enough history to satisfy `countBack`. Providers can also expand request boundaries or limit the number of base aggregates they scan. Validate the returned timestamps against your exclusive `to`, page as needed, and return bars in ascending order. See [Polygon/Massive's aggregation rules](https://massive.com/blog/aggs-api-updates) for its snapping and stretching behavior.

The [tick-to-candle helper](https://docs.lumencharts.com/charting-library/datafeed/tick-aggregation#match-your-history-boundaries) uses fixed UTC boundaries by default. For exchange-session or calendar-based intervals, use a shared market-calendar policy for historical aggregation and the helper's `bucketStart` callback instead of assuming fixed UTC blocks.

## "No more data" versus "something went wrong"

```js
onHistory([], { noData: true }); // no older data exists
onError('History is temporarily unavailable'); // request failed
```

A temporary error doesn't mean the history has run out. If you return only a few bars, the chart may ask for older data a limited number of times. When your provider pages its results, keep fetching pages until you have enough bars or you've truly reached the start of the data.

## Handle late responses safely

Keep track of which symbol, resolution and request each response belongs to. An old request that finishes late shouldn't overwrite newer data. Cache keys should include the provider and any metadata that changes what a bar means.

[Runnable example](https://docs.lumencharts.com/examples?example=minimal) · [Time and sessions](https://docs.lumencharts.com/charting-library/datafeed#time-units-and-trading-sessions)

---
Documentation page: https://docs.lumencharts.com/charting-library/datafeed/history


---

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

`subscribeBars` hands you a subscriber ID and a callback. Keep separate state for each ID, because several charts can subscribe at the same time, to the same data or to different data.

## Choose your data path

The chart works with any data provider and any connection type. Your adapter takes care of the socket, sign-in, reconnects, symbol mapping and cleanup. The chart only ever receives **complete bars**, never raw WebSocket messages.

| Provider sends | Adapter does | Chart receives |
| --- | --- | --- |
| Raw trades or quotes | Normalize ticks, then call `createTickCandleAggregator` | Complete updated OHLCV bar |
| Complete candles for the selected resolution | Normalize and validate candles; skip tick aggregation | Complete updated OHLCV bar |

```text
Raw ticks → normalize → tick-to-candle helper → onRealtime(bar) → chart
Complete candles → normalize/validate → onRealtime(bar) → chart
```

Load the starting history with `getBars` before you send live updates. History and live updates need to agree on the symbol, the price basis, where intervals start and end, and Unix millisecond timestamps. Send each event to the subscription with the matching symbol and resolution, and keep separate state for each subscriber ID.

## Example: raw ticks

This M5 (5-minute) example starts the current candle from the last history bar, then updates it on every accepted tick. `transport.subscribe` is an adapter method that supplies normalized ticks and returns a cleanup function. `lastHistoryBar` and `onRealtime` come from your datafeed's history and subscription lifecycle.

```js
const candles = LumenChartingLibrary.createTickCandleAggregator({
  intervalMs: 5 * 60_000,
  volumeMode: 'incremental', // Each trade supplies a volume delta.
});
candles.reset({ ...lastHistoryBar, volume: lastHistoryBar.volume ?? 0 });

let active = true;
const stop = transport.subscribe(symbol, tick => {
  if (!active) return;
  // tick = { time: Unix milliseconds, price: trade price, volume: trade size }
  const update = candles.push(tick);
  if (update) onRealtime({ ...update.bar });
});

function unsubscribe() {
  active = false;
  stop();
}
```

If your feed only sends quotes, use `volumeMode: 'none'` and stick to one price basis, such as the bid/ask midpoint. Don't pass a running (cumulative) volume total as if it were the volume of a single tick.

With M5, a tick at 10:02 updates the candle that started at 10:00. The open stays the same, high and low stretch to the extremes, and close follows the latest price. The first tick at or after 10:05 starts a new candle and returns the finished one as `closedBar`. If no ticks arrive, no candle is created: there's no timer. M1 works the same way with `intervalMs: 60_000`.

See [Build candles from ticks](https://docs.lumencharts.com/charting-library/datafeed/tick-aggregation) for the full `subscribeBars` implementation, provider normalization, calendar alignment, and reconciliation.

## Example: complete candles

If your provider already streams complete candles for the timeframe the chart asked for, pass them straight to the callback. Don't turn their close prices into fake ticks, because you'd lose the open, high, low and volume.

In this example, the transport subscribes to the requested symbol and resolution. It checks that the OHLCV fields are numbers and converts timestamps before calling its handler. Keep provider-specific field names inside the transport.

```js
let active = true;
let latestTime = lastHistoryBar.time;
const stop = candleTransport.subscribe(symbol, resolution, candle => {
  if (!active || candle.time < latestTime) return;
  latestTime = candle.time;
  onRealtime({
    time: candle.time, // Candle START in Unix milliseconds, not arrival time.
    open: candle.open,
    high: candle.high,
    low: candle.low,
    close: candle.close,
    volume: candle.volume,
  });
});

function unsubscribe() {
  active = false;
  stop();
}
```

Pass along every update to the candle that's still forming. Don't wait for the provider to mark it “closed”. If your feed only sends finished candles, the chart can't show price movement inside a bar this way. If the feed sends M1 candles but the chart asks for M5, combine them into M5 candles first, keeping the highs, lows and volume. Never pass M1 bars off as M5 bars.

## Update the current bar

Whenever the price or volume changes, send the whole current OHLCV bar. A bar with the same timestamp replaces every OHLCV value of the last bar. It isn't a partial update of just the changed fields. A newer timestamp starts the next bar. Don't use the realtime callback to correct older history.

## Unsubscribe reliably

```js
const subscriptions = new Map();
function unsubscribeBars(id) {
  subscriptions.get(id)?.close();
  subscriptions.delete(id);
}
```

If several subscribers share a connection, count how many are using each underlying feed, but keep each subscriber's state separate. When the last one leaves, release the timers, sockets and listeners. Ignore any events that arrive after unsubscribing.

## Historical corrections

When older data changes, use the documented cache reset and reload flow. After the provider reconnects, bring the current bar up to date before you resume updates. Never fill a gap with made-up market bars.

The example below updates a sample bar once per second. It only simulates live updates; it isn't connected to a real market.

[Interactive chart example](https://docs.lumencharts.com/charting-library/datafeed/realtime) — runs in a browser with synthetic data.

---
Documentation page: https://docs.lumencharts.com/charting-library/datafeed/realtime


---

<!-- Public documentation export; not library implementation source. -->
# Build candles from ticks

`createTickCandleAggregator` turns a stream of price ticks into the complete OHLCV bars that `subscribeBars` needs. You'll find it in the licensed browser bundle as `LumenChartingLibrary.createTickCandleAggregator`, and as a named export from the ESM and CommonJS entry points. It doesn't need any provider SDK or framework. The licensed distribution also includes a small standalone script, `assets/tick-candle-aggregator.js`. It exposes `LumenChartingLibraryDatafeed.createTickCandleAggregator` so you can use the helper without loading a chart widget.

The helper only builds candles. Your adapter still handles symbol mapping, WebSocket sign-in, reconnects, history requests and subscription cleanup. Create **one aggregator for each subscriber ID**, even when subscribers share a socket.

## Quick start

If your provider already sends complete candles for the requested timeframe, skip this helper and use the [complete-candle example](https://docs.lumencharts.com/charting-library/datafeed/realtime#example-complete-candles). Both paths feed the same realtime callback.

```js
const candles = LumenChartingLibrary.createTickCandleAggregator({
  intervalMs: 5 * 60_000,
  volumeMode: 'incremental',
});

candles.push({ time: 1_000, price: 100, volume: 2 });
candles.push({ time: 2_000, price: 103, volume: 1 });
const current = candles.push({ time: 3_000, price: 101, volume: 4 });
// current.bar: { time: 0, open: 100, high: 103, low: 100, close: 101, volume: 7 }
// current.isNewBar: false

const next = candles.push({ time: 300_000, price: 102, volume: 1 });
// next.bar.time: 300000; next.isNewBar: true
// next.closedBar: the completed candle starting at 0
```

All times are Unix **milliseconds**, candle timestamps included. By default a candle starts at `floor(tick.time / intervalMs) * intervalMs`. The open stays the same, high and low stretch to the extremes, and close follows the latest accepted tick. The first tick in a later interval returns the finished candle as `closedBar`. The helper has no timer, so it never calls back during a quiet interval and never invents candles to fill gaps.

## Match your history boundaries

The helper's default UTC buckets must match the historical candles you supply through `getBars`. With `intervalMs: 3_600_000`, ticks at `11:06` and `11:59` update the H1 candle starting at `11:00`. The first tick at or after `12:00` starts the next candle.

Align historical aggregation requests to those boundaries too. For example, a Polygon `60/minute` request starting at `11:06` can produce offset candles that don't match the helper's whole-hour buckets. See the [historical alignment example](https://docs.lumencharts.com/charting-library/datafeed/history#example-polygon-minute-multipliers) for the request conversion.

Don't fix a mismatch by rounding returned candle timestamps or passing a misaligned seed to `reset` or `reconcile`. Those methods don't rebuild OHLCV from the original trades or quotes. Request correctly aligned history, or aggregate the underlying data using the same boundary policy. The chart itself doesn't realign your provider's candles.

For exchange-session or calendar-based intervals, configure [custom boundaries](https://docs.lumencharts.com/charting-library/datafeed/tick-aggregation#exchange-sessions-and-calendar-bars) with `bucketStart` and use the same calendar policy in your history adapter.

## API

| Method / option | Behavior |
| --- | --- |
| `intervalMs` | Required positive integer. Supports fixed durations, including seconds, minutes, and UTC days. |
| `volumeMode` | `'none'` (default) ignores tick volume; `'incremental'` adds each tick's volume delta. |
| `bucketStart(time)` | Optional function returning an integer bucket start at or before the tick. Use for session or calendar alignment. |
| `push({ time, price, volume? })` | Returns `{ bar, isNewBar, closedBar? }`, or `null` for an older tick/bucket. |
| `reset(lastBar?)` | Clears ordering and current state, optionally seeding a complete history bar. |
| `reconcile(bar, preserveLive = true)` | Merges a history/provider snapshot. Same-bucket live high/low and close are preserved by default; volume is replaced. Older bars return `null`. |
| `snapshot()` | Returns a frozen copy of the current bar, or `null`. |

`bar` contains `time`, `open`, `high`, `low`, `close` and `volume`. Changing an update or snapshot can't affect the helper's internal state. Invalid timestamps, non-finite prices, negative volume, impossible OHLC values or invalid options all throw an error before anything changes. Negative prices are allowed for markets that have them, as long as they're finite.

Ticks with the same timestamp are applied in the order they arrive. The helper can't spot duplicate provider events without an ID, so remove duplicate trade IDs before passing incremental volume. Don't pass a running session or per-minute volume total as if it were the volume of a single tick.

## Connect it to subscribeBars

This example assumes your history adapter caches its latest bar per symbol/resolution, and your transport's `subscribe` method returns an unsubscribe function. The socket can be shared; each subscriber still gets its own aggregator.

```js
const subscriptions = new Map();
const lastHistoryBars = new Map(); // Populate from successful getBars responses.
const intervals = { '1': 60_000, '5': 300_000, '15': 900_000, '60': 3_600_000, '1D': 86_400_000 };

function subscribeBars(symbolInfo, resolution, onRealtime, subscriberId) {
  unsubscribeBars(subscriberId);
  const symbol = symbolInfo.ticker || symbolInfo.name;
  const intervalMs = intervals[resolution];
  if (!intervalMs) throw new Error(`Unsupported resolution: ${resolution}`);
  const candles = LumenChartingLibrary.createTickCandleAggregator({ intervalMs });
  const last = lastHistoryBars.get(`${symbol}|${resolution}`);
  if (last) candles.reset({ ...last, volume: last.volume ?? 0 });

  const entry = { candles, close: () => {} };
  subscriptions.set(subscriberId, entry);
  entry.close = transport.subscribe(symbol, tick => {
    if (subscriptions.get(subscriberId) !== entry) return;
    const update = candles.push(tick);
    if (update) onRealtime({ ...update.bar });
  });
}

function unsubscribeBars(subscriberId) {
  const entry = subscriptions.get(subscriberId);
  subscriptions.delete(subscriberId);
  entry?.close();
}
```

The library gets a full bar every time. If the timestamp is the same, the current candle is updated; if it's newer, a new candle is added. How often ticks arrive has nothing to do with the selected timeframe.

## Normalize different providers

The aggregator never sees provider-specific messages. Your transport translates them first:

```js
// Provider A: executed trade, already timestamped in milliseconds.
const tradeTick = { time: message.timestampMs, price: message.tradePrice, volume: message.tradeSize };

// Provider B: bid/ask quote, timestamped in seconds. Choose a consistent price basis.
const quoteTick = { time: Math.trunc(message.timestampSeconds * 1000), price: (message.bid + message.ask) / 2 };

// Provider C: cumulative volume is NOT a per-trade delta. Omit it here.
const priceTick = { time: message.timeMs, price: message.lastPrice };
```

Check provider message formats and trade conditions in your transport. Keep in mind that a forex quote's midpoint isn't an actual trade. Also, providers sometimes leave certain stock trades out of their aggregate bars. If you include those trades, your live OHLC can differ from the provider's historical bars until they're reconciled.

## Volume and history reconciliation

For quote feeds, or feeds that mix ticks with aggregate bars, keep the default volume mode. Apply provider OHLCV snapshots with `reconcile`. Their volume replaces the current volume, so it isn't counted twice.

```js
const merged = candles.reconcile(providerBar);
if (merged) onRealtime({ ...merged });
```

Sometimes a snapshot for the current interval should win over the live values. In that case, call `reconcile(providerBar, false)`. This also resets tick ordering, so only do it once you've decided the snapshot replaces the live data.

Don't call `reset` on every tick. Seed the helper once before subscribing, then use `reconcile` only for history or aggregate updates. When you reconnect, fetch any missing history and use your subscription ID or a generation counter to ignore results that arrive too late. The helper can't tell whether a REST response was fetched before or after a given WebSocket tick. If older candles need correcting, resetting the chart's history cache is still up to your adapter.

## Exchange sessions and calendar bars

By default, intervals are fixed blocks of UTC time. That doesn't account for exchange holidays, daylight-saving changes, weekly or monthly calendars, or bars based on tick counts. If any of those apply, pass a `bucketStart` function that uses your market calendar. Its results must match the timestamps your history provider uses.

```js
const candles = LumenChartingLibrary.createTickCandleAggregator({
  intervalMs: 5 * 60_000,
  bucketStart(time) {
    const sessionStart = marketCalendar.sessionStartFor(time);
    return sessionStart + Math.floor((time - sessionStart) / 300_000) * 300_000;
  },
});
```

Filter out ticks from outside the trading session before calling `push`. The helper keeps prices exactly as precise as your adapter sends them. Rounding and display precision are up to your provider and display settings.

---
Documentation page: https://docs.lumencharts.com/charting-library/datafeed/tick-aggregation


---

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

You pass options to the widget when you create it. The container, datafeed, symbol, interval and runtime file location decide what the chart shows first. Keep your app's credentials out of these options.

## Common options

| Option | What it does | Tips |
| --- | --- | --- |
| `container` | The element, or its ID, to draw the chart in | Make sure it exists before you create the widget |
| `library_path` | Folder that holds the runtime files | Include the trailing slash |
| `datafeed` | Your datafeed callbacks | Always call either the success or the error callback |
| `symbol` | The first symbol to show | Your datafeed must be able to resolve it |
| `interval` | The first resolution to show | Pick a resolution you support |
| `autosize` | Fill the container | Give the parent a height |
| `theme` | `light` or `dark` | You can switch later with `changeTheme` |
| `locale` | UI language | Set it when you create the widget |
| `timezone` | Timezone used for display | Doesn't change the units of bar timestamps |
| `enabled_features` / `disabled_features` | Turn features on or off | Use names from the [feature catalog](https://docs.lumencharts.com/charting-library/configuration/features) |
| `save_load_adapter` | Saving and loading | Provide all four methods for each capability you turn on |

## Defaults and updates

By default the runtime uses interval `1D`, timezone `Etc/UTC`, locale `en` and a size of 800 × 500, with `autosize` and `fullscreen` turned off. To change things after the chart starts, call the public methods. Changing the original options object afterwards has no effect.

Use `applyOverrides` to change supported chart appearance properties. `applyStudiesOverrides` is accepted, but this release doesn't apply indicator defaults yet; set an indicator's properties after adding it instead. Some options can only be set at creation time. To change those, remove the widget and create a new one.

## Symbols and intervals

A symbol is a name your datafeed knows how to look up. A resolution (or interval) sets how much time each bar covers. Keep the labels you show users separate from the actual values you pass to the chart.

### Switch symbol or interval

```js
widget.onChartReady(() => {
  widget.setSymbol('MSFT', '60', () => {
    console.log('Symbol and interval changed');
  });
});
```

In a multi-chart workspace, use that chart's own API to change just one chart. If you want charts to stay in sync, set up the workspace linking controls on purpose.

### Writing resolutions

Minute resolutions are plain number strings such as `15` and `60`. Daily, weekly and monthly resolutions add a suffix, for example `1D`, `1W` and `1M`. Seconds and tick resolutions also need the matching feature, configuration and provider metadata. Only offer intervals your data provider can actually deliver.

Return `supported_resolutions` from both your configuration and symbol lookup. Check inputs before you request history. When the user switches symbol or interval, cancel or ignore any history and realtime work still running for the old one. That way a late reply for the old symbol can't end up on the new chart.

## Chart types, panes and scales

To pick a chart style, pass one of the supported style IDs to the chart API. The runtime rejects any style that isn't in its supported list.

| ID | Style |
| --- | --- |
| 0 | Bars |
| 1 | Candles |
| 2 | Line |
| 3 | Area |
| 8 | Heikin Ashi |
| 9 | Hollow candles |
| 10 | Baseline |
| 12 | High-low |
| 13 | Columns |
| 14 | Line with markers |
| 15 | Step line |
| 16 | HLC area |

### Set a style

```js
widget.onChartReady(() => {
  widget.activeChart().setChartType(1);
});
```

The high-low style is controlled by a feature flag. To build a style picker, call `supportedChartTypes()` for the current widget. Don't list every value from the declaration enum, because some of them aren't supported.

### Panes and price scales

An indicator can share the main pane or get a pane of its own. Pane and scale handles let you move, resize and adjust scales where supported. Each source ID and handle belongs to one chart, so keep them with that chart. After loading a layout, get them again.

Visible time ranges use the documented time units. Pass a timestamp where one is expected, not a screen coordinate. Avoid changing canvas geometry directly. The [API reference](https://docs.lumencharts.com/charting-library/api/) lists every method you can use.

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


---

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

This list comes straight from the runtime, so it always matches what ships. Put any of these names in `enabled_features` or `disabled_features`. Features marked `initialization` only take effect when you create a new widget. Features marked `runtime` can be switched on a running chart with the feature API. Names that aren't on this list are ignored and won't add anything. Features marked **Beta** work but may change in a later release.

| Feature | Default | Lifecycle |
| --- | --- | --- |
| `chart_style_volume_footprint` **Beta** | Disabled | initialization |
| `accessibility` | Enabled | runtime |
| `accessible_keyboard_shortcuts` | Disabled | runtime |
| `axis_pressed_mouse_move_scale` | Enabled | runtime |
| `chart_scroll` | Enabled | runtime |
| `chart_style_hilo` | Enabled | runtime |
| `chart_style_hilo_last_price` | Disabled | runtime |
| `chart_template_storage` | Disabled | runtime |
| `chart_zoom` | Enabled | runtime |
| `charting_library` | Enabled | runtime |
| `collapsible_header` | Disabled | runtime |
| `context_menus` | Enabled | runtime |
| `create_volume_indicator_by_default` | Enabled | initialization |
| `create_volume_indicator_by_default_once` | Enabled | initialization |
| `volume_force_overlay` | Enabled | initialization |
| `go_to_date` | Enabled | runtime |
| `insert_indicator_dialog_shortcut` | Enabled | runtime |
| `header_chart_type` | Enabled | runtime |
| `header_compare` | Enabled | runtime |
| `header_fullscreen_button` | Enabled | runtime |
| `header_indicators` | Enabled | runtime |
| `header_layouttoggle` | Enabled | initialization |
| `header_quick_search` | Enabled | runtime |
| `header_resolutions` | Enabled | runtime |
| `header_saveload` | Enabled | runtime |
| `header_save_status` | Disabled | runtime |
| `header_screenshot` | Enabled | runtime |
| `header_settings` | Enabled | runtime |
| `header_symbol_search` | Enabled | runtime |
| `header_undo_redo` | Enabled | runtime |
| `header_widget` | Enabled | runtime |
| `right_toolbar` | Enabled | initialization |
| `hide_right_toolbar` | Disabled | runtime |
| `horz_touch_drag_scroll` | Enabled | runtime |
| `iframe_loading_compatibility_mode` | Disabled | runtime |
| `items_favoriting` | Enabled | runtime |
| `left_toolbar` | Enabled | runtime |
| `mouse_wheel_scale` | Enabled | runtime |
| `mouse_wheel_scroll` | Enabled | runtime |
| `pinch_scale` | Enabled | runtime |
| `pressed_mouse_move_scroll` | Enabled | runtime |
| `property_pages` | Enabled | runtime |
| `right_bar_stays_on_scroll` | Enabled | runtime |
| `saveload_separate_drawings_storage` | Disabled | runtime |
| `series_data_error_overlay` | Enabled | runtime |
| `seconds_resolution` | Disabled | runtime |
| `save_shortcut` | Enabled | runtime |
| `show_chart_property_page` | Enabled | runtime |
| `show_interval_dialog_on_key_press` | Enabled | runtime |
| `show_symbol_logos` | Disabled | runtime |
| `show_symbol_logo_in_legend` | Disabled | runtime |
| `study_templates` | Disabled | runtime |
| `support_multicharts` | Enabled | initialization |
| `symbol_search_hot_key` | Enabled | runtime |
| `tick_resolution` | Disabled | runtime |
| `timeframes_toolbar` | Enabled | runtime |
| `two_character_bar_marks_labels` | Disabled | runtime |
| `vert_touch_drag_scroll` | Enabled | runtime |

Some features depend on storage or optional services. Those still need their full adapters or assets: turning the flag on doesn't set the feature up for you.

---
Documentation page: https://docs.lumencharts.com/charting-library/configuration/features


---

<!-- Public documentation export; not library implementation source. -->
# Themes and UI

Set `theme: 'light'` or `theme: 'dark'` in the widget options. To switch the theme of a chart that's already running, call the public theme method.

```js
await widget.changeTheme('dark');
widget.applyOverrides({
  'paneProperties.background': '#101216',
  'paneProperties.backgroundType': 'solid',
});
```

## Styling stops at the iframe

The chart lives in its own iframe, so your page's CSS doesn't reach it. Use the supported overrides and CSS customization methods. Don't target the chart's internal DOM with selectors; it isn't a stable public contract and can change.

## Chart and indicator appearance

`applyOverrides` changes supported chart properties. `applyStudiesOverrides` is accepted but doesn't apply indicator defaults in this release; indicators on the chart have their own property methods. Note that a property you can use when creating a drawing isn't always valid in a saved drawing.

## Check both themes

Look at text, grid lines, drawing labels, focused controls and dialogs in light and dark. Don't rely on color alone to show state. If your app has its own theme switcher, have it call the widget API. Changing your page's theme won't change the chart on its own. The chart below does this: use the site's theme toggle and it switches without reloading.

[Interactive chart example](https://docs.lumencharts.com/charting-library/configuration/themes) — runs in a browser with synthetic data.

## Header extensions

Wait for `headerReady()` before you add your own header controls. Hold on to the handle the public API gives you, and follow its documented lifecycle.

```js
await widget.headerReady();
const button = widget.createButton();
button.textContent = 'Reset view';
button.setAttribute('aria-label', 'Reset chart view');
button.addEventListener('click', () => widget.activeChart().resetView());
```

### Use public actions

Have your controls call public chart actions. Don't search inside the iframe for the chart's own toolbar elements. When the chart is removed, remove your listeners too, and don't keep references to DOM nodes that are no longer on the page.

### Only show what works

Show save, load, template and similar controls only when that feature is fully set up. If there's no backend behind a button, hide it rather than showing a button that always fails. In small containers, keep labels short and check keyboard focus and overflow.

## Localization and accessibility

Set the widget's locale when you create it. Use a supported locale value and test with the real language, including right-to-left layouts if you need them.

### Keyboard and focus

The chart handles chart gestures. Dialogs, menus and text fields handle typing inside them. Don't capture every key on your page, and don't forward shortcuts while someone is typing in an input. Keep Escape, focus return and browser zoom working.

Give the chart region an accessible label, and give your own controls clear labels. Don't use color alone to tell series or states apart. Assistive technology can't read everything drawn on a canvas. If your users need an equivalent, offer a text summary or a data table.

### Responsive containers

Give the chart a fixed or limited height, and let its controls adjust to the available width. On mobile, make sure the rest of the page still scrolls and that fixed navigation doesn't cover any controls. Check dialogs and their close buttons on narrow screens.

These docs support keyboard navigation, search and theme switching. For the chart itself, test accessibility against the specific workflows your app offers.

---
Documentation page: https://docs.lumencharts.com/charting-library/configuration/themes


---

<!-- Public documentation export; not library implementation source. -->
# Workspaces and comparisons

One widget can hold several charts. Each chart keeps its own data, analysis and lifecycle, while the widget handles the layout and keeps the charts in sync.

```js
widget.onChartReady(() => {
  widget.setLayout('2h');
  widget.chart(1).setSymbol('MSFT');
});
```

## Synchronization

Use the built-in controls to sync symbol, interval, crosshair, time and date range across charts. Don't copy every event from one chart to another by hand, because that can cause loops. When you switch to a smaller layout, hidden charts may be kept around. Changing the grid doesn't necessarily clear their state.

## Comparisons

Comparison series belong to their chart. If your release offers the public comparison API, use it, and keep comparisons, indicators and the main series separate. Get fresh handles after restoring a layout.

## Sharing drawings

Which drawings are shared depends on symbol and layout ownership. Sharing keeps drawing IDs stable and checks saved metadata. Don't copy internal model objects from one chart to another.

[Interactive chart example](https://docs.lumencharts.com/charting-library/configuration/workspaces) — runs in a browser with synthetic data.

---
Documentation page: https://docs.lumencharts.com/charting-library/configuration/workspaces


---

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

You create drawings with a public tool name, and each drawing gets a source ID and a set of time/price points. The chart draws them and handles mouse and touch interaction. Your app decides what to draw and with what data.

## Create a trend line

```js
const chart = widget.activeChart();
const id = chart.createMultipointShape([
  { time: 1790035200, price: 180 },
  { time: 1791676800, price: 195 },
], { shape: 'trend_line' });
if (id === null) throw new Error('Drawing creation failed');
```

Drawing timestamps are in Unix seconds. That's different from `Bar.time`, which uses milliseconds. Give each tool the number of points it needs, using finite numbers. Use `createShape` for single-point tools, and the supported anchored API for tools pinned to the screen.

## Edit or remove

Get a drawing's handle with `getShapeById(id)`, then use its supported point and property methods. Remove a drawing with `removeEntity(id)`. Don't hold on to a handle after the drawing is removed or a different saved layout is loaded.

## Interaction flags

Selection, locking, saving, editing and Object Tree visibility are each controlled separately. For example, a locked drawing can still be saved, and an overlay marked as not saved must stay unsaved. Keep these flags where the docs put them, not mixed in with style properties.

The chart rejects invalid property keys and broken saved data. Read [drawing storage](https://docs.lumencharts.com/charting-library/persistence/templates#separate-drawing-storage) before you save drawings in your own format.

[Interactive chart example](https://docs.lumencharts.com/charting-library/drawings/) — runs in a browser with synthetic data.

## Selection, groups and ordering

Use the chart's selection and group controller APIs to work with drawings by their IDs. Groups help you organize related drawings, but they don't decide which symbol a drawing belongs to.

### Selection

Each chart has its own selection. Change or clear it with the public selection handle. Drawings that have selection turned off shouldn't show up when users select things. Subscribe with the documented subscription object, and unsubscribe with the same owner and callback you used.

### Groups and stacking order

Only group drawings that fit together and live in the same chart. To group drawings or move them to the front or back, use the public group controller and ordering commands. Don't edit saved source arrays directly. Before you show an ordering action, check that it's available, since some may be disabled.

### Sharing across charts

When layouts are saved or loaded, drawing sharing and symbol ownership are sorted out for you. IDs are only unique within one chart. Restoring a saved layout can change IDs and sync copies of a drawing, so get fresh handles after a restore rather than reusing old ones.

## Host trading overlays

Order lines, position lines and execution shapes show trading activity on the chart. They're visual only: they don't place orders with a broker.

```js
const order = widget.activeChart().createOrderLine();
order.setPrice(190).setText('Limit order').setQuantity('10');
// When the host order is removed:
// order.remove();
```

### Your app stays in charge

Your broker or order system is the source of truth. When a user moves or cancels a line, check the change with your backend first. Update the real order only after that succeeds. If it's rejected, put the line back where it should be.

### When to remove overlays

Remove an overlay when its order or position goes away, the symbol changes, or the chart is destroyed. Keep each listener tied to its own order. Don't add the same overlay again every time data refreshes.

### Saving and PnL

Don't save temporary broker overlays into a user's analysis unless you mean to. Your app is responsible for PnL in the account currency and for how broker executions work. The line on the chart doesn't do any accounting.

[Order handle](https://docs.lumencharts.com/charting-library/api/IOrderLineAdapter) · [Position handle](https://docs.lumencharts.com/charting-library/api/IPositionLineAdapter) · [Execution handle](https://docs.lumencharts.com/charting-library/api/IExecutionLineAdapter)

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


---

<!-- Public documentation export; not library implementation source. -->
# Drawing tool catalog

This list comes straight from the tools registered in the runtime. The public name is the value you pass to the creation API. It's not the label users see in the toolbar. **Points** is how many points it takes to create the drawing. Tools marked *Variable* keep taking points until the user finishes them. Some tools are available through the API but don't appear in the toolbar.

| Public name | Points | Toolbar | Style |
| --- | --- | --- | --- |
| `vertical_line` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#vertlinelinetooloverrides) |
| `horizontal_line` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#horzlinelinetooloverrides) |
| `trend_line` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendlinelinetooloverrides) |
| `ray` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#raylinetooloverrides) |
| `extended` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#extendedlinetooloverrides) |
| `horizontal_ray` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#horzraylinetooloverrides) |
| `rectangle` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#rectanglelinetooloverrides) |
| `text` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#textlinetooloverrides) |
| `anchored_text` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#textabsolutelinetooloverrides) |
| `note` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#notelinetooloverrides) |
| `anchored_note` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#noteabsolutelinetooloverrides) |
| `polyline` | Variable | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#polylinelinetooloverrides) |
| `path` | Variable | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pathlinetooloverrides) |
| `brush` | Variable | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#brushlinetooloverrides) |
| `highlighter` | Variable | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#highlighterlinetooloverrides) |
| `arrow_marker` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkerlinetooloverrides) |
| `arrow` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowlinetooloverrides) |
| `arrow_up` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkuplinetooloverrides) |
| `arrow_down` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkdownlinetooloverrides) |
| `arrow_left` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkleftlinetooloverrides) |
| `arrow_right` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkrightlinetooloverrides) |
| `flag` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#flagmarklinetooloverrides) |
| `balloon` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#balloonlinetooloverrides) |
| `comment` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#commentlinetooloverrides) |
| `icon` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#iconlinetooloverrides) |
| `emoji` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#emojilinetooloverrides) |
| `sticker` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#stickerlinetooloverrides) |
| `rotated_rectangle` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#rotatedrectanglelinetooloverrides) |
| `circle` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#circlelinetooloverrides) |
| `ellipse` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#ellipselinetooloverrides) |
| `triangle` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trianglelinetooloverrides) |
| `arc` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arclinetooloverrides) |
| `curve` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#bezierquadrolinetooloverrides) |
| `double_curve` | 4 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#beziercubiclinetooloverrides) |
| `info_line` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#infolinelinetooloverrides) |
| `trend_angle` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendanglelinetooloverrides) |
| `disjoint_angle` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#disjointanglelinetooloverrides) |
| `flat_bottom` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#flatbottomlinetooloverrides) |
| `regression_trend` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#regressiontrendlinetooloverrides) |
| `cross_line` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#crosslinelinetooloverrides) |
| `price_label` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pricelabellinetooloverrides) |
| `price_note` | 2 | Yes |  |
| `callout` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#calloutlinetooloverrides) |
| `signpost` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#signpostlinetooloverrides) |
| `fib_retracement` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibretracementlinetooloverrides) |
| `fib_extension` | 3 | No |  |
| `fib_trend_ext` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendbasedfibextensionlinetooloverrides) |
| `fib_channel` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibchannellinetooloverrides) |
| `fib_timezone` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibtimezonelinetooloverrides) |
| `fib_speed_resist_fan` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibspeedresistancefanlinetooloverrides) |
| `fib_speed_resist_arcs` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibspeedresistancearcslinetooloverrides) |
| `fib_trend_time` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendbasedfibtimelinetooloverrides) |
| `fib_circles` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibcircleslinetooloverrides) |
| `fib_spiral` | 2 | Yes |  |
| `fib_wedge` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibwedgelinetooloverrides) |
| `pitchfork` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pitchforklinetooloverrides) |
| `schiff_pitchfork_modified` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#schiffpitchforklinetooloverrides) |
| `schiff_pitchfork` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#schiffpitchfork2linetooloverrides) |
| `inside_pitchfork` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#insidepitchforklinetooloverrides) |
| `pitchfan` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pitchfanlinetooloverrides) |
| `gannbox` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#gannsquarelinetooloverrides) |
| `gannbox_square` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#ganncomplexlinetooloverrides) |
| `gannbox_fixed` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#gannfixedlinetooloverrides) |
| `gannbox_fan` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#gannfanlinetooloverrides) |
| `parallel_channel` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#parallelchannellinetooloverrides) |
| `date_and_price_range` | 2 | Yes |  |
| `price_range` | 2 | Yes |  |
| `date_range` | 2 | Yes |  |
| `long_position` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#riskrewardlonglinetooloverrides) |
| `short_position` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#riskrewardshortlinetooloverrides) |
| `forecast` | 2 | Yes |  |
| `bars_pattern` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#barspatternlinetooloverrides) |
| `ghost_feed` | Variable | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#ghostfeedlinetooloverrides) |
| `projection` | 3 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#projectionlinetooloverrides) |
| `anchored_vwap` | 1 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#anchoredvwaplinetooloverrides) |
| `fixed_range_volume_profile` | 2 | Yes |  |
| `cyclic_lines` | 2 | Yes |  |
| `time_cycles` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#timecycleslinetooloverrides) |
| `sine_line` | 2 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#sinelinelinetooloverrides) |
| `xabcd_pattern` | 5 | Yes |  |
| `cypher_pattern` | 5 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#cypherpatternlinetooloverrides) |
| `abcd_pattern` | 4 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#abcdlinetooloverrides) |
| `triangle_pattern` | 4 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trianglepatternlinetooloverrides) |
| `3divers_pattern` | 7 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#threedriverslinetooloverrides) |
| `head_and_shoulders` | 7 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#headandshoulderslinetooloverrides) |
| `elliott_impulse_wave` | 6 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliottimpulselinetooloverrides) |
| `elliott_triangle_wave` | 6 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliotttrianglelinetooloverrides) |
| `elliott_triple_combo` | 6 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliotttriplecombolinetooloverrides) |
| `elliott_correction` | 4 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliottcorrectionlinetooloverrides) |
| `elliott_double_combo` | 4 | Yes | [Overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliottdoublecombolinetooloverrides) |

[Drawings](https://docs.lumencharts.com/charting-library/drawings/) · [Drawing handle API](https://docs.lumencharts.com/charting-library/api/ILineDataSourceApi)

---
Documentation page: https://docs.lumencharts.com/charting-library/drawings/catalog


---

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

Ask the runtime which indicators are available instead of assuming every name in the compatibility declarations works.

```js
const available = widget.getStudiesList();
const id = await widget.activeChart().createStudy(
  'Moving Average', false, false, { length: 20 },
);
```

## Inputs and placement

To see which inputs an indicator supports, call `getStudyInputs(name)`. Pass inputs by their IDs, with values of the right type. A label shown in the UI isn't always the same as the input ID. Each indicator decides whether it sits on the price chart or in its own pane. Supported scale options control how it shares a price scale.

## Updates and removal

Get the indicator's handle by its ID to change supported inputs or properties. Some work happens asynchronously, so watch the indicator's loading and error state. Remove an indicator through the chart API and clean up your subscriptions. Treat a missing ID or an unsupported indicator name as an error.

## Defaults versus saved templates

Indicator overrides change how indicators look. Indicator templates save a set of indicator settings. Neither one saves the whole chart layout. See [Templates](https://docs.lumencharts.com/charting-library/persistence/templates) for how they differ.

[Interactive chart example](https://docs.lumencharts.com/charting-library/studies/) — runs in a browser with synthetic data.

## Custom study boundaries

For the calculations in the catalog, use the built-in indicators. For script-based analysis, use optional Pine where it's supported. The compatibility declarations for custom studies don't guarantee every vendor-specific metainfo field or JavaScript hook.

### Before you add a custom study

Check the entry point and metainfo format you plan to use against the release you ship. Decide where the input bars come from, how missing values are represented, where the study appears and how it gets cleaned up. Test what happens with invalid inputs, and when the chart is removed while a calculation is still running.

### Try these first

If you just need an existing calculation with different settings, start with a [built-in indicator](https://docs.lumencharts.com/charting-library/studies). For script-based analysis, use [optional Pine](https://docs.lumencharts.com/charting-library/studies/pine) with its matching worker files. Don't import internal study classes into your app as a shortcut; they aren't a public API.

### Error handling

When a study fails, show an error the user can act on, and let them remove the study. Don't quietly swap an unsupported calculation for a different indicator. For any script you ship, document exactly which language features and calculations it supports.

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


---

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

This list comes straight from the runtime's built-in indicators. To see what your loaded runtime can actually run, call `widget.getStudiesList()`. To see an indicator's inputs, call `getStudyInputs(name)`. Each indicator has its own inputs and styles.

| Name | Canonical ID | Style |
| --- | --- | --- |
| Moving Average | `Moving Average@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaverageindicatoroverrides) |
| Moving Average Exponential | `Moving Average Exponential@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaverageexponentialindicatoroverrides) |
| Moving Average Weighted | `Moving Average Weighted@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaverageweightedindicatoroverrides) |
| Arnaud Legoux Moving Average | `Arnaud Legoux Moving Average@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#arnaudlegouxmovingaverageindicatoroverrides) |
| Average True Range | `Average True Range@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#averagetruerangeindicatoroverrides) |
| Relative Strength Index | `Relative Strength Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#relativestrengthindexindicatoroverrides) |
| MACD | `Moving Average Convergence/Divergence@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#macdindicatoroverrides) |
| Bollinger Bands | `Bollinger Bands@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#bollingerbandsindicatoroverrides) |
| Bollinger Bands %B | `Bollinger Bands %B@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#bollingerbandsbindicatoroverrides) |
| Bollinger Bands Width | `Bollinger Bands Width@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#bollingerbandswidthindicatoroverrides) |
| Momentum | `Momentum@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#momentumindicatoroverrides) |
| Rate Of Change | `rate_of_change@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#rateofchangeindicatoroverrides) |
| Standard Deviation | `Standard Deviation@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#standarddeviationindicatoroverrides) |
| Commodity Channel Index | `Commodity Channel Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#commoditychannelindexindicatoroverrides) |
| Stochastic | `Stochastic@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#stochasticindicatoroverrides) |
| SuperTrend | `SuperTrend@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#supertrendindicatoroverrides) |
| Williams %R | `Willams %R@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#williamsrindicatoroverrides) |
| On Balance Volume | `On Balance Volume@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#onbalancevolumeindicatoroverrides) |
| Accumulation/Distribution | `Accumulation/Distribution@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#accumulationdistributionindicatoroverrides) |
| Balance of Power | `Balance of Power@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#balanceofpowerindicatoroverrides) |
| Awesome Oscillator | `Awesome Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#awesomeoscillatorindicatoroverrides) |
| Accumulative Swing Index | `Accumulative Swing Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#accumulativeswingindexindicatoroverrides) |
| Advance/Decline | `Advance/Decline@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#advancedeclineindicatoroverrides) |
| Aroon | `Aroon@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#aroonindicatoroverrides) |
| Average Price | `AveragePrice@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#averagepriceindicatoroverrides) |
| Average Directional Index | `average_directional_Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#averagedirectionalindexindicatoroverrides) |
| Accelerator Oscillator | `Accelerator Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#acceleratoroscillatorindicatoroverrides) |
| Chaikin Money Flow | `Chaikin Money Flow@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#chaikinmoneyflowindicatoroverrides) |
| Chaikin Oscillator | `Chaikin Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#chaikinoscillatorindicatoroverrides) |
| Chaikin Volatility | `Chaikin Volatility@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#chaikinvolatilityindicatoroverrides) |
| Chande Kroll Stop | `Chande Kroll Stop@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#chandekrollstopindicatoroverrides) |
| Chande Momentum Oscillator | `Chande Momentum Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#chandemomentumoscillatorindicatoroverrides) |
| Chop Zone | `chop_zone@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#chopzoneindicatoroverrides) |
| Choppiness Index | `Choppiness Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#choppinessindexindicatoroverrides) |
| Connors RSI | `Connors RSI@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#connorsrsiindicatoroverrides) |
| Correlation Coefficient | `Correlation Coeff@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#correlationcoefficientindicatoroverrides) |
| Correlation - Log | `Correlation - Log@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#correlationlogindicatoroverrides) |
| Coppock Curve | `Coppock Curve@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#coppockcurveindicatoroverrides) |
| Detrended Price Oscillator | `detrended_price_oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#detrendedpriceoscillatorindicatoroverrides) |
| Directional Movement | `Directional Movement Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#directionalmovementindicatoroverrides) |
| Donchian Channels | `Donchian Channels@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#donchianchannelsindicatoroverrides) |
| Double EMA | `Double Exponential Moving Average@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#doubleemaindicatoroverrides) |
| Ease Of Movement | `Ease of Movement@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#easeofmovementindicatoroverrides) |
| Elder's Force Index | `Elders Force Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#eldersforceindexindicatoroverrides) |
| EMA Cross | `EMA Cross@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#emacrossindicatoroverrides) |
| Envelopes | `Envelope@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#envelopesindicatoroverrides) |
| Standard Error | `Standard Error@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#standarderrorindicatoroverrides) |
| Standard Error Bands | `Standard Error Bands@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#standarderrorbandsindicatoroverrides) |
| Fisher Transform | `fisher_transform@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#fishertransformindicatoroverrides) |
| Hull Moving Average | `Hull MA@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#hullmovingaverageindicatoroverrides) |
| Historical Volatility | `historical_volatility@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#historicalvolatilityindicatoroverrides) |
| Ichimoku Cloud | `Ichimoku Cloud@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#ichimokucloudindicatoroverrides) |
| Keltner Channels | `Keltner Channels@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#keltnerchannelsindicatoroverrides) |
| Klinger Oscillator | `Klinger Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#klingeroscillatorindicatoroverrides) |
| Know Sure Thing | `Know Sure Thing@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#knowsurethingindicatoroverrides) |
| Least Squares Moving Average | `Least Squares Moving Average@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#leastsquaresmovingaverageindicatoroverrides) |
| Linear Regression Curve | `Linear Regression Curve@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#linearregressioncurveindicatoroverrides) |
| Linear Regression Slope | `Linear Regression Slope@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#linearregressionslopeindicatoroverrides) |
| MA Cross | `MA Cross@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#macrossindicatoroverrides) |
| MA with EMA Cross | `MA with EMA Cross@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#mawithemacrossindicatoroverrides) |
| Mass Index | `Mass Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#massindexindicatoroverrides) |
| McGinley Dynamic | `mcginley_dynamic@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#mcginleydynamicindicatoroverrides) |
| Median Price | `Median Price@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#medianpriceindicatoroverrides) |
| Money Flow Index | `Money Flow@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#moneyflowindexindicatoroverrides) |
| Moving Average Channel | `Moving Average Channel@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaveragechannelindicatoroverrides) |
| Moving Average Double | `Moving Average Double@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaveragedoubleindicatoroverrides) |
| Moving Average Triple | `Moving Average Triple@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaveragetripleindicatoroverrides) |
| Moving Average Adaptive | `Moving Average Adaptive@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaverageadaptiveindicatoroverrides) |
| Moving Average Hamming | `Moving Average Hamming@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaveragehammingindicatoroverrides) |
| Moving Average Multiple | `Moving Average Multiple@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#movingaveragemultipleindicatoroverrides) |
| Majority Rule | `Majority Rule@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#majorityruleindicatoroverrides) |
| Net Volume | `Net Volume@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#netvolumeindicatoroverrides) |
| Parabolic SAR | `Parabolic SAR@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#parabolicsarindicatoroverrides) |
| Pivot Points Standard | `PivotPointsStandard@chart-studies-80` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#pivotpointsstandardindicatoroverrides) |
| Price Channel | `Price Channel@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#pricechannelindicatoroverrides) |
| Price Oscillator | `Price Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#priceoscillatorindicatoroverrides) |
| Price Volume Trend | `price_volume_trend@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#pricevolumetrendindicatoroverrides) |
| Ratio | `Ratio@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#ratioindicatoroverrides) |
| Relative Vigor Index | `Relative Vigor Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#relativevigorindexindicatoroverrides) |
| Relative Volatility Index | `Relative Volatility Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#relativevolatilityindexindicatoroverrides) |
| SMI Ergodic Indicator/Oscillator | `SMI Ergodic Indicator/Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#smiergodicindicatoroscillatorindicatoroverrides) |
| Spread | `Spread@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#spreadindicatoroverrides) |
| Smoothed Moving Average | `smoothed_moving_average@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#smoothedmovingaverageindicatoroverrides) |
| Stochastic RSI | `Stochastic RSI@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#stochasticrsiindicatoroverrides) |
| TRIX | `TRIX@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#trixindicatoroverrides) |
| Triple EMA | `Triple EMA@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#tripleemaindicatoroverrides) |
| True Strength Index | `True Strength Indicator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#truestrengthindexindicatoroverrides) |
| Trend Strength Index | `Trend Strength Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#trendstrengthindexindicatoroverrides) |
| Typical Price | `TypicalPrice@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#typicalpriceindicatoroverrides) |
| Ultimate Oscillator | `ultimate_oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#ultimateoscillatorindicatoroverrides) |
| Volatility Close-to-Close | `Volatility Close-to-Close@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#volatilityclosetocloseindicatoroverrides) |
| Volatility Zero Trend Close-to-Close | `Volatility Zero Trend Close-to-Close@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#volatilityzerotrendclosetocloseindicatoroverrides) |
| Volatility O-H-L-C | `Volatility O-H-L-C@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#volatilityohlcindicatoroverrides) |
| Volatility Index | `Volatility Index@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#volatilityindexindicatoroverrides) |
| VWMA | `VWMA@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#vwmaindicatoroverrides) |
| VWAP | `VWAP@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#vwapindicatoroverrides) |
| Volume | `Volume@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#volumeindicatoroverrides) |
| Volume Oscillator | `Volume Oscillator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#volumeoscillatorindicatoroverrides) |
| Volume Profile Visible Range | `VbPVisible@chart-studies-49` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#volumeprofilevisiblerangeindicatoroverrides) |
| Vortex Indicator | `vortex_indicator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#vortexindicatorindicatoroverrides) |
| Williams Alligator | `Williams Alligator@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#williamsalligatorindicatoroverrides) |
| Williams Fractal | `Williams Fractals@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#williamsfractalindicatoroverrides) |
| Guppy Multiple Moving Average | `Guppy Multiple Moving Average@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#guppymultiplemovingaverageindicatoroverrides) |
| 52 Week High/Low | `52 Week High/Low@chart-studies-1` |  |
| Zig Zag | `ZigZag@chart-studies-1` | [Overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#zigzagindicatoroverrides) |

[Indicators](https://docs.lumencharts.com/charting-library/studies/) · [Study API](https://docs.lumencharts.com/charting-library/api/IStudyApi)

---
Documentation page: https://docs.lumencharts.com/charting-library/studies/catalog


---

<!-- Public documentation export; not library implementation source. -->
# Optional Pine integration

Pine is optional. To use it, you need both the configuration and the matching worker and editor files. Shipping the files alone won't let scripts run.

Pine executes scripts over chart data. Separately, [AI integration](https://docs.lumencharts.com/charting-library/automation/) orchestrates chart operations and exposes data/capture ports. Pine does not require an AI provider or the automation runtime.

> Pine Script® is a trademark of TradingView, Inc. Lumen Charts is not affiliated with, sponsored by or endorsed by TradingView. References to Pine Script describe language compatibility only.

## Turn on Pine

```js
const widget = new LumenChartingLibrary.widget({
  container: 'chart', library_path: '/lumen_charting_library/',
  datafeed, symbol: 'AAPL', interval: '1D', locale: 'en',
  pine_script: { enabled: true },
});
widget.onChartReady(async () => {
  const id = await widget.activeChart().createPineStudy(
    '//@version=5\nindicator("Average", overlay=true)\nplot(ta.sma(close, 20))',
  );
  console.log(id);
});
```

## Matching files and errors

Your code, the worker and the optional editor must all come from the same manifest. Catch compile and run errors, and let users fix or remove the script. Having an editor doesn't mean every part of the Pine language is supported. Anything unsupported should fail with a clear error.

## Local versus hosted features

Running scripts locally doesn't set up cloud workspaces, publishing, external libraries or alert delivery. Those need their own providers and identity setup. An alert event on the chart doesn't prove that a notification actually reached anyone.

## Lifecycle

Remove scripts you no longer need, unsubscribe from progress and log listeners, and remove the chart before you throw away its host. If the inputs, source or data change, don't reuse the old results.

[Interactive chart example](https://docs.lumencharts.com/charting-library/studies/pine) — runs in a browser with synthetic data.

---
Documentation page: https://docs.lumencharts.com/charting-library/studies/pine


---

<!-- Public documentation export; not library implementation source. -->
# Saving and loading charts

What you save depends on what you want users to get back. Layouts, indicator templates, drawing templates and chart settings templates each cover a different part of the chart.

| What's saved | What it contains | Usually handled by |
| --- | --- | --- |
| Chart layout | How the chart is set up, plus saved analysis | A complete layout adapter |
| Study template | A set of indicator settings | A study template adapter |
| Drawing template | A reusable drawing style | A drawing template adapter |
| Chart settings template | Appearance and settings | A chart template adapter |
| Separate drawing state | Drawings and groups, stored on their own | A separate drawing adapter |

## Quick snapshots

```js
widget.save(state => {
  localStorage.setItem('my-chart:layout:v1', JSON.stringify(state));
});
const saved = localStorage.getItem('my-chart:layout:v1');
if (saved) widget.load(JSON.parse(saved));
```

Be ready for JSON parse errors, a full storage quota and saved data the runtime rejects. Putting a version in your own storage key doesn't change the runtime's own schema version.

## Built-in Save and Load controls

Provide a complete adapter and the chart shows its Save and Load controls. If the layout adapter is missing or incomplete, those controls stay off. The chart never guesses a storage URL. The sample stores layouts in the browser and supports list, load, save and delete.

## Save/load adapter

A layout adapter needs all four operations: list, save, load and delete. Handle sign-in in your backend requests. Don't put credentials in the chart options.

| Method | Returns |
| --- | --- |
| `getAllCharts()` | A list of layout details |
| `saveChart(chartData)` | The saved layout's ID |
| `getChartContent(id)` | The content string saved earlier |
| `removeChart(id)` | Completes once the layout is deleted |

### Example: saving in the browser

```ts
// Import these public types from the declarations in your authorized distribution.
export const storageKey = 'lumencharts-docs:layouts:v1'
type RecordEntry = ChartData & { id: string; timestamp: number }
type StoragePort = Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>
export function createDemoStorage(storage: StoragePort) {
  function read(): RecordEntry[] {
    const raw = storage.getItem(storageKey)
    if (!raw) return []
    let parsed: unknown
    try { parsed = JSON.parse(raw) } catch { throw new Error('Saved sample layouts are invalid. Reset saved layouts to start again.') }
    if (!Array.isArray(parsed) || parsed.length > 30 || !parsed.every(item => item && typeof item === 'object' && typeof item.id === 'string' && /^\d+$/.test(item.id) && typeof item.name === 'string' && typeof item.content === 'string' && typeof item.symbol === 'string' && typeof item.resolution === 'string' && Number.isFinite(item.timestamp))) throw new Error('Saved sample layouts are invalid. Reset saved layouts to start again.')
    return parsed as RecordEntry[]
  }
  function write(records: RecordEntry[]) {
    const value = JSON.stringify(records)
    if (value.length > 2_000_000) throw new Error('Sample storage is full. Delete a saved layout first.')
    storage.setItem(storageKey, value)
  }
  const adapter: Pick<IExternalSaveLoadAdapter, 'getAllCharts' | 'saveChart' | 'getChartContent' | 'removeChart'> = {
    async getAllCharts() { return read().map(({ id, name, symbol, resolution, timestamp }) => ({ id: Number(id), name, symbol, resolution: resolution as ResolutionString, timestamp })) },
    async saveChart(chart) {
      const records = read()
      const id = String(chart.id ?? Math.max(Date.now(), ...records.map(item => Number(item.id) + 1)))
      const next = records.filter(item => item.id !== id)
      if (next.length >= 30) throw new Error('Save up to 30 sample layouts. Delete one first.')
      next.push({ ...chart, id, timestamp: Math.floor(Date.now() / 1000) })
      write(next)
      return id
    },
    async getChartContent(id) { const item = read().find(item => item.id === String(id)); if (!item) throw new Error('Saved layout was not found'); return item.content },
    async removeChart(id) { write(read().filter(item => item.id !== String(id))) },
  }
  return { adapter, reset: () => storage.removeItem(storageKey) }
}
```

The legacy interface types list extra methods for other features. The runtime checks for the complete layout methods on their own. Optional template and separate drawing storage each need their own complete set of methods. Don't add empty methods that just report success to satisfy a broad type.

### On your server

Check that the signed-in user is allowed to perform every list, read, write and delete. The `client_id` and `user_id` strings narrow down whose data you're working with, but they don't prove who the user is. Limit list sizes in the database, and enforce a size limit on content before you store it.

Return saved content exactly as you received it; don't rewrite what's inside. Give a clear error for missing records, denied access, invalid content and temporary failures. If a response arrives after another operation has started, or after the chart was removed, ignore it.

[Interactive chart example](https://docs.lumencharts.com/charting-library/persistence/) — runs in a browser with synthetic data.

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


---

<!-- Public documentation export; not library implementation source. -->
# Templates, settings and drawing storage

Templates save part of a chart's state so it can be reused. Store them separately from full layouts.

## Chart settings templates

These save appearance and settings only. They don't include the symbol, interval, panes, drawings or indicators. Before applying one, the runtime checks it against the exact current template schema. Storing chart templates needs the complete list, load, save and remove methods.

## Drawing templates

Save templates by tool and name. Only allowed style properties belong in a template. Details about a specific drawing, such as its ID, a custom title or its lifecycle state, shouldn't end up in reusable defaults. The saved template format is stricter than the options you can pass when creating a drawing.

## Study templates

Use the public API to create and apply study templates, along with the matching adapter methods. Decide up front whether a template should include the symbol and interval. A study template isn't a complete user workspace.

## User settings

For preferences that should survive the chart being recreated, use the supported settings adapter. Keep server-saved settings tied to the signed-in user, so one user's preferences never show up in someone else's session. If you don't configure an adapter, document any browser-only behavior your app depends on.

## Separate drawing storage

Storing drawings separately is optional. To use it, turn on the matching feature and provide the complete save/load contract.

### Use the official format

`getLineToolsState()` returns drawings and groups in the supported format. `applyLineToolsState(state)` checks the whole input before changing anything. Keep source IDs, groups, symbol ownership and version fields intact. Don't flatten the state into a plain list of points without a version.

The drawing format uses exact property names and a strict, current schema. Saved state is rejected if it contains nested creation `overrides`, unknown keys or alternative names. If even one item is invalid, the whole drawing payload is rejected. The chart won't quietly apply only the valid items.

### Keeping layouts in sync

Whether drawings can be shared depends on symbol ownership and layout sharing details. Group IDs stay local to one chart. Restoring can sync copies of a drawing, but don't build global IDs from list positions.

### Recovering from failures

Keep the last good saved copy until a new save succeeds. If saved data fails validation, leave the user's current chart as it is and offer a clear way to recover. Don't drop the broken items quietly and report the restore as a success.

[Drawing API](https://docs.lumencharts.com/charting-library/drawings) · [Migration policy](https://docs.lumencharts.com/charting-library/persistence/migration)

---
Documentation page: https://docs.lumencharts.com/charting-library/persistence/templates


---

<!-- Public documentation export; not library implementation source. -->
# Schemas and migration

Saved state has a version, and the version is what decides compatibility. A similar-looking UI or similar method names don't mean two formats are compatible.

## Checked before anything changes

The layout and drawing decoders read and check the whole saved payload before applying any of it. Layout migration happens in its own named decoder. For now, while drawing and template formats are pre-release, only their current versions are accepted. Older payloads aren't migrated automatically.

## Keep providers separate

Don't assume a layout saved by another chart provider will work with this runtime. Store each provider's data separately, and don't load another provider's saved payload into this chart.

## Upgrade checklist

1. Back up a sample of real saved layouts and templates.
2. Load both valid and deliberately broken samples with the new release.
3. Make sure a rejected load leaves the current chart unchanged.
4. Check that new saves reload correctly on the same release.
5. Deploy the docs, wrapper, iframe and optional worker together as one package.

Don't hand-edit schema fields based on screenshots. If you need a migration, write it down and test it as a versioned transformation.

[Upgrade guide](https://docs.lumencharts.com/charting-library/reference/releases#upgrade-safely)

---
Documentation page: https://docs.lumencharts.com/charting-library/persistence/migration


---

<!-- Public documentation export; not library implementation source. -->
# AI integration overview

AI integration is built on the Lumen Charts automation API, which can serve ordinary JavaScript, custom workflows or an AI assistant. Your application chooses the model provider, transport, storage and commercial access policy.

The SDK is open source under the Apache License 2.0 ([source on GitHub](https://github.com/lumenchartshq/chart-automation)), and every Lumen Charts build includes the chart-side runtime it drives. There is no separate add-on to buy.

## Quickstart

Open a session for a chart, add your own command and hand the tools to your model:

```ts
import { createAutomationTools, defineCommand, field } from '@lumencharts/chart-automation/sdk';

// Inside the widget's ready callback.
const sdk = await widget.activeChart().openAutomation({
  policy: { effects: ['read', 'mutation'] },
});

await sdk.drawings.apply({
  operations: [{ action: 'create', type: 'horizontal_line', points: [{ price: 182.5 }] }],
});

sdk.extensions.register(defineCommand({
  name: 'acme.lastClose',
  effect: 'read',
  description: 'Return the latest loaded close.',
  input: {},
  output: { close: field.nullable(field.number()) },
  async execute(_input, context) {
    const { rows } = await context.execute('data.read', { seriesId: 'main', from: 0, to: Date.now(), limit: 10_000 });
    return { close: (rows.at(-1) as { close?: number } | undefined)?.close ?? null };
  },
}));

const tools = createAutomationTools(sdk);   // name, description, parameters, execute(toolCallId, input)
const system = sdk.instructions();          // guidance from registered commands

// When the view is removed (removing the chart also closes the session):
sdk.close();
```

`openAutomation` loads the optional automation asset, installs the native drawing, study and settings commands and wires an exact-chart PNG capture. Every `request` argument is optional; pass one when work must stay fenced to the chart state a caller saw earlier, as model tools do.

## Product boundaries

| Part | Responsibility | Loading |
| --- | --- | --- |
| Core chart runtime | Charts, datafeed integration, native editing, persistence and Undo | Widget startup |
| Automation runtime | Native command adapters and the session behind `openAutomation`, included in every build | First `openAutomation()` or `widget.loadAutomation()` |
| Automation SDK (open source) | Sessions, typed command facade, data/capture ports, policies, extensions, model tools and remote sessions | Opt-in application import from npm |
| Optional Pine | Compile and execute scripts and display their outputs | Separate Pine configuration and assets |
| Host application | Model calls, prompts, uploads, accounts, remote storage and entitlements | Supplied by the integrator |

The core does not bundle the automation implementation. Loaded-bar reads and local screenshots are native capabilities; `createNativeChartAutomation` uses them without loading the automation runtime. Native persistence and ordinary Undo also work without it.

Pine executes a script over market data and produces calculated outputs. Automation orchestrates chart operations and accesses data or images through explicit ports. It does not implicitly compile Pine, generate scripts or connect to an AI service. Hosts can compose these capabilities.

## Access and prerequisites

Install the SDK from npm. It ships as one package built to ESM with type declarations: `@lumencharts/chart-automation`, with the entry points `/sdk`, `/sdk/testing`, `/contracts` and `.`.

```bash
npm install @lumencharts/chart-automation
```

`lumen_charting_library.d.ts` names SDK types only through this package, so install it before type-checking against the chart. Update the SDK and the chart runtime together. `openAutomation` itself needs no SDK import; the SDK supplies `defineCommand`, `field`, model tools and remote sessions.

The surface has two supported tiers:

| Tier | What it covers | Stability |
| --- | --- | --- |
| Stable | `chart.openAutomation()` and `@lumencharts/chart-automation/sdk`: sessions, `defineCommand`, `field`, `createAutomationTools`, remote sessions and the domain types they name. `@lumencharts/chart-automation/sdk/testing` for unit tests. | Supported for integrators. |
| Advanced | `createChartAutomation`, `createNativeChartAutomation`, `installNativeAutomationCommands` and the native owner factories (`createDrawingDocument`, `createStudyDocument`, `widget.createWorkspaceCommands`). The package root exports the drawing, study, settings and workspace contracts and validators these owners use. | Supported, but you own each owner's lifetime, persistence and Undo. |

Product-specific adapters, prompts and model tools belong in your application; none ship in this package.

The automation runtime is a separate file so charts that never use automation never download it. It needs no extra licence: every edition includes it. See [installation and hosting](https://docs.lumencharts.com/charting-library/getting-started/installation).

## Integration path

1. Read and capture the chart: [local data and capture](https://docs.lumencharts.com/charting-library/automation/data-and-capture).
2. Change the chart and connect a model: [native commands and model tools](https://docs.lumencharts.com/charting-library/automation/commands-and-tools).
3. Add your own commands, data and persistence: [host adapters and extensions](https://docs.lumencharts.com/charting-library/automation/extensions).
4. Run the model on a server: [server-side models](https://docs.lumencharts.com/charting-library/automation/remote).

Use `sdk.capabilities()` to discover installed, permitted operations. Unavailable command families reject with `unsupported`; a method existing in the TypeScript facade does not mean its native owner is installed.

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


---

<!-- Public documentation export; not library implementation source. -->
# Local data and capture

Open a session after widget readiness. Reads and capture need only the `read` effect:

```ts
// Run inside the widget's ready callback.
const chart = widget.activeChart();
const sdk = await chart.openAutomation({ commands: [], policy: { effects: ['read'] } });

const series = sdk.data.series();
const range = chart.getVisibleRange();
if (range && series.find(item => item.id === 'main')?.readiness === 'ready') {
  const result = await sdk.data.read({
    seriesId: 'main',
    from: Math.round(range.from * 1000),
    to: Math.round(range.to * 1000),
    limit: 2000,
  });
  console.log(result.rows, result.coverage);
}
const image = await sdk.capture.image();
console.log(image.blob, image.width, image.height);

// On component teardown (chart removal also closes the session):
sdk.close();
```

`commands: []` installs no native command families. Each call above uses a fresh request for the current chart; pass `sdk.request()` captured earlier to reject results from a chart that has since changed.

To avoid downloading the automation runtime for read-only use, bundle the SDK and create the session yourself. Keep the chart and screenshot index paired:

```ts
import { createNativeChartAutomation } from '@lumencharts/chart-automation/sdk';

const sdk = createNativeChartAutomation({
  chartId: 'primary',
  chart: widget.workspaceChart(0),
  capturePng: () => widget.takeClientScreenshot({ chartIndex: 0, strictCapture: true }),
  policy: { effects: ['read'] },
});
```

`capturePng` may return either a PNG data URL or a PNG `Blob`. A Blob is validated from its header only, so it avoids base64 decoding for large charts.

## Time, fields and coverage

SDK timestamps use integer UTC milliseconds. The native visible-range API uses seconds, hence the conversion above. Inside a command, read through `context.execute('data.read', input)` so the read shares the command's request, deadline and target fence. Main-series data is raw OHLCV, not transformed display candles. Open, high, low and close are required finite numbers; volume may be omitted.

Every discovered series declares its numeric fields, units and readiness. Fields are required and non-null by default. `optional: true` permits omission; `nullable: true` permits explicit `null`. Rows must contain an integer `time` and only declared fields. Timestamps must be unique, increasing and inside the requested range. Descriptors are snapshotted before asynchronous work so later provider changes cannot alter validation for a pending read.

The native adapter exposes main candles. Comparison, study and Pine output series require a host data adapter; they are not automatically extracted from arbitrary indicator buffers. Pending series reject local reads with `busy`; failed series reject with `unavailable`.

Reads never fetch missing history. An oversized matching window rejects instead of silently returning a partial slice. `coverage.complete` means the requested window is inside the reported loaded bounds; it does not promise a candle for every clock interval or exhaustive market history. `requestHistory` is a separate, optional host operation that requires the `external` effect.

## Capture and image transport

Capture returns a PNG Blob with dimensions, target, capture time, visible range and revision. The revision is a session change counter, not a persisted document version. Capture rejects stale work if the chart selection, data or visible range changes while it is pending.

The current capture scope is the exact chart at native dimensions. Cropping, custom dimensions, layer filtering and image editing are not SDK options. Your application can process the returned image separately. Uploads, attachment identities, retention and provider-specific image formats belong to that application.

## Events and cleanup

```ts
const unsubscribe = sdk.events.subscribe(event => {
  console.log(event.type, event.target, event.revision);
});
// Release when the observer is no longer needed.
unsubscribe();
```

Events include `selection`, `data`, `study-ready` and `disposed`. Data notifications are coalesced within a microtask; selection and disposal are immediate. A `study-ready` event first delivers any queued data notification, so events arrive in commit order. Payloads are immutable. The native session destroys itself when its chart is removed; explicit `destroy()` is also safe to call repeatedly.

[Add native commands and model tools →](https://docs.lumencharts.com/charting-library/automation/commands-and-tools)

---
Documentation page: https://docs.lumencharts.com/charting-library/automation/data-and-capture


---

<!-- Public documentation export; not library implementation source. -->
# Native commands and model tools

## Open a session with native commands

```ts
const sdk = await widget.activeChart().openAutomation({
  commands: ['drawings', 'studies', 'settings'], // the default
  policy: { effects: ['read', 'mutation'] },
});
console.log(sdk.capabilities().commands.map(command => command.name));
```

`openAutomation` requests `assets/chart-automation.js` relative to the configured library base on first use. Creating a widget alone never requests it. Concurrent loads are deduplicated; failed loads can be retried, and a loading failure leaves the ordinary chart usable. The `ai_commands` widget option does not load assets or grant a commercial entitlement, but it still limits what a session can install. A family is installed only when `commands` requests it **and** the widget allows it: with `ai_commands.chartSettings` off, `settings.*` stays `unsupported`; with study commands off, `studies.apply` is absent; with inspection off, the `inspect` reads are absent. Check `sdk.capabilities().commands` rather than assuming a requested family is present. Owners you pass in through `owners` are used as built, so the widget option does not apply to them.

| Family | Commands | Behavior |
| --- | --- | --- |
| Drawings | `drawings.context`, `list`, `apply`, `groups`, `inspect` | Drawing batches with native receipts and Undo; group pages; exact-ID settings |
| Studies | `studies.context`, `list`, `apply`, `inspect` | Built-in study changes with expected revisions; exact-ID inputs and styles |
| Settings | `settings.inspect`, `apply` | Validated chart and scale settings |
| Workspace | `workspace.context`, `apply` | Pass `workspace: widget.createWorkspaceCommands(options)`; you keep ownership |

`capabilities.query` is installed whenever at least one of the drawing, study or settings families is; a session with `commands: []` has none. Group and inspection reads appear only when the running chart supports them. Closing the session destroys the drawing, study and settings owners it created, never owners you passed in (see below); chart removal closes the session.

Built-in facade inputs and results have concrete types. Drawing and group pages allow up to 100 entries and study pages up to 20. Native parsers enforce operation limits and required fields. Capability discovery exposes supported fields and choices; do not assume every drawing setting is writable.

Mutations preserve native Undo and receipts. They do not save remotely unless you supply a `persist` hook (see [extensions](https://docs.lumencharts.com/charting-library/automation/extensions#durable-saves)). There are no transactions across commands or services.

### Keep one owner per chart

Each native family keeps its own lease, Undo history and persistence revision in one owner. Use one mutating owner per chart per family: two drawing owners on the same chart would hold separate leases and Undo stacks, so their edits could interleave unsafely. If you already hold an owner, for example one from `createDrawingCommands` or `createDrawingDocument` that saves your documents, pass it in:

```ts
await widget.loadAutomation();
const chart = widget.activeChart();
const drawings = chart.createDrawingCommands(binding); // your existing owner

const sdk = await chart.openAutomation({ owners: { drawings } });
const receipt = await sdk.drawings.apply({ operations: [{ action: 'create', type: 'horizontal_line', points: [{ price: 182.5 }] }] });
drawings.undo(receipt.operationId); // SDK changes share the owner's Undo history
sdk.close(); // `drawings` stays alive; you destroy it
```

`owners` accepts `drawings`, `studies` and `settings`. An adopted owner is used as-is and the session never destroys it. Families without an adopted owner are built and destroyed by the session as usual. When you also pass `commands`, every adopted family must be listed in it, or opening rejects with `invalid_input`. An adopted drawing owner also supplies the session's binding.

A second mutating session on the same chart must reuse the same owners rather than opening with fresh ones. Sessions that share an owner can run side by side and close independently.

Hosts that construct owners themselves can still call the lower-level factories (`createDrawingCommands`, `createStudyCommands`, `createChartSettingsCommands`) after `widget.loadAutomation()` and connect them with `installNativeAutomationCommands(sdk, owners)`.

## Model tools

```ts
import { createAutomationTools } from '@lumencharts/chart-automation/sdk';

const tools = createAutomationTools(sdk, {
  request: toolCallId => sdk.request({ requestId: toolCallId }), // the default
  imageResult: capture => uploadForMyProvider(capture.blob),     // enables capture_image
  use: [logCalls, confirmMutations],                             // middleware, outermost first
});
// Each tool: name, commandName, description, parameters, effect, concurrency, execute(toolCallId, input).
```

Translate each tool into your provider's format; the adapter has no model client, prompts, budgets or conversation store.

| Option | Purpose |
| --- | --- |
| `request` | Request envelope per call. Defaults to the call ID and the current chart. |
| `describe` | Replaces a tool's `description` or `parameters`, e.g. to keep wording you have evaluated. Runs before `include`; return `undefined` to keep the derived tool. Input is still parsed by the command's own schema. |
| `include` | Keep only tools for which it returns `true`, e.g. `tool => tool.effect === 'read'`. |
| `toolPrefix` | Prepended to derived names, e.g. `chart_` for `chart_drawings_apply`. |
| `toolNames` | Exact names by command, e.g. `{ 'drawings.apply': 'apply_chart_drawing_batch' }`. |
| `use` | Middleware `(call, next) => result` for logging, confirmation, budgets or result shaping. Throw a `ChartCommandError` to refuse. |
| `imageResult` | Converts a capture for your provider. Capture is advertised only when supplied. |
| `errorResult` | Shape of a failed call. Defaults to `{ error: code, details? }`, where `details` names the rejected field path and a fixed reason; never the error message. `null` rethrows. |

Tool names are snake_case: `drawings.apply` becomes `drawings_apply` and `navigation.searchSymbols` becomes `navigation_search_symbols`. The SDK ports are `data_series`, `data_read`, `data_request_history` and `capture_image`. Names must match `[a-z][a-z0-9_-]{0,63}`; a duplicate name rejects with `operation_conflict`.

Each tool reports its `effect` and `concurrency`. When a model asks for several calls in one step, run `shared` calls together and each `exclusive` call alone in call order. Reads default to `shared`; mutations and external calls default to `exclusive`.

Command `examples` are appended to that command's tool description as compact JSON lines (up to 2,000 characters), the same for local and remote sessions; commands without examples keep their description unchanged. `sdk.instructions()` joins the `instructions` of permitted commands for your system prompt. Tool lists are snapshots: rebuild them when `sdk.capabilities().revision` changes.

```ts
import { ChartCommandError, type AutomationToolMiddleware } from '@lumencharts/chart-automation/sdk';

const confirmMutations: AutomationToolMiddleware = async (call, next) => {
  if (call.tool.effect === 'mutation' && !(await askUser(`Allow ${call.tool.name}?`))) throw new ChartCommandError('cancelled');
  return next();
};
```

## Policy and request lifetimes

Configure allowed effects (`read`, `mutation`, `external`) and optionally an exact command-name allowlist when opening a session. `data_series` follows the `data.read` permission. Defaults are eight concurrent requests, a 30-second deadline and 256 KiB JSON payloads. Finite ceilings also bound rows, series, fields and images; inspect `capabilities().limits` for effective values.

Omitted requests get a fresh ID and the current target. Explicit requests must use a unique ID for each in-flight operation; duplicates reject with `operation_conflict`. Requests accept an AbortSignal and an absolute deadline. Cancelled or timed-out handlers keep their concurrency slot until they settle, so repeated timeouts cannot start unlimited background work. Session methods always report failures by rejecting.

Policy is local capability filtering, not server authorization. Enforce asset access and hosted-service entitlements at your own server boundary. Model credentials belong outside the browser.

[Add host adapters and extensions →](https://docs.lumencharts.com/charting-library/automation/extensions)

---
Documentation page: https://docs.lumencharts.com/charting-library/automation/commands-and-tools


---

<!-- Public documentation export; not library implementation source. -->
# Host adapters and extensions

## Custom commands

Declare a command with `defineCommand`. The `field` declarations produce both the JSON Schema your model sees and the parser the SDK runs, so the two cannot drift, and the handler's types are inferred from them.

```ts
import { defineCommand, field } from '@lumencharts/chart-automation/sdk';

const markEarnings = defineCommand({
  name: 'acme.markEarnings',
  effect: 'mutation',
  description: 'Mark the next earnings date with a vertical line.',
  instructions: 'Use only when the user asks about earnings.',
  examples: [{ description: 'Apple', input: { symbol: 'AAPL' } }],
  input: { symbol: field.string(16).describe('Ticker symbol, for example AAPL.') },
  output: { drawingId: field.string(64).describe('ID of the created line.') },
  async execute({ symbol }, context) {
    const time = await fetchNextEarnings(symbol, context.signal);
    const receipt = await context.execute('drawings.apply', {
      operations: [{ action: 'create', type: 'vertical_line', points: [{ time }] }],
    });
    return { drawingId: receipt.ids[0]! };
  },
});

const unregister = sdk.extensions.register(markEarnings);
await unregister.execute({ symbol: 'AAPL' });
```

| Field | Accepts |
| --- | --- |
| `field.string(max, { pattern })` / `field.text(max, { minLength, pattern })` | Non-blank / any string up to `max` Unicode code points. Supply an anchored (`^…$`) regular expression without flags. The parser evaluates its source in Unicode mode. |
| `field.integer({ minimum, maximum })` / `field.number(...)` | Safe integers / finite numbers; above `maximum` rejects with `limit_exceeded` |
| `field.boolean()`, `field.literal(value)`, `field.oneOf([...])` | Booleans, one exact value, one of a set |
| `field.array(item, { maxItems, minItems, uniqueItems })` | Bounded arrays with a required `maxItems`. `uniqueItems` rejects repeated JSON values regardless of object property order. |
| `field.object({...}, { minProperties })` | Nested closed objects; `minProperties` requires that many fields to be present |
| `field.union(discriminator, variants, { minProperties })` | Closed objects told apart by a string discriminator, advertised as `oneOf` with a `const` per variant; `minProperties` per variant counts the discriminator |
| `field.record(value, { maxKeys, maxKeyLength })` | Objects with your keys and one value shape; `maxKeys` is required, keys are 1 to `maxKeyLength` (default 64) characters |
| `field.scalar()` | A string, finite number or boolean |
| `field.unknown()` | Any JSON value, advertised without constraints; use only where your handler validates the value itself |
| `field.optional(inner)`, `field.nullable(inner)` | May be omitted / may be `null` |

Every field takes `.describe(text)` (1 to 1,000 characters), which becomes the field's `description` in the JSON Schema. Describe every field: the model sees nothing else about it. Descriptions pass through nested objects, arrays, unions and records, and `.describe()` keeps the field's inferred type.

Unions are keyed by discriminator value; each variant lists its other fields, and the handler receives a discriminated TypeScript union:

```ts
const annotate = defineCommand({
  name: 'acme.annotate',
  effect: 'mutation',
  description: 'Add price annotations.',
  input: {
    marks: field.array(field.union('kind', {
      level: { price: field.number().describe('Price of the level.') },
      zone: {
        from: field.number().describe('Lower price.'),
        to: field.number().describe('Upper price.'),
        label: field.optional(field.string(32)).describe('Short label.'),
      },
    }).describe('One annotation.'), { maxItems: 10 }).describe('Annotations to add.'),
  },
  output: { added: field.integer().describe('Annotations added.') },
  execute({ marks }) {
    for (const mark of marks) if (mark.kind === 'zone') console.log(mark.from, mark.to);
    return { added: marks.length };
  },
});
```

Unknown fields always reject. A rejected input carries `details` with the field path and a short fixed reason, for example `{ path: 'marks[2].to', reason: 'expected number' }`, and model tools return them as `{ error: 'invalid_input', details }` so the model can correct the call. Details never contain input values: paths name declared fields and array indexes only. Lower-level `AutomationCommand` definitions with a hand-written `{ jsonSchema, parse }` remain supported for shapes the builder cannot express; throw `new ChartCommandError(code, code, { path, reason })` to report details from your own parser.

| Command field | Contract |
| --- | --- |
| `name`, `version`, `description` | Namespaced stable identity (`acme.markEarnings`), positive version (default 1) and purpose |
| `effect` | `read`, `mutation` or `external`, checked against session policy |
| `input`, `output` | Field maps (or schemas); both boundaries are validated |
| `execute(input, context)` | Typed handler that obeys cancellation, deadline and target ownership |
| `instructions`, `examples` | Model guidance (up to 4,000 characters, joined by `sdk.instructions()`) and up to 8 examples, each checked against `input` at registration; `createAutomationTools` appends examples to the tool description as compact JSON lines, up to 2,000 characters |
| `concurrency` | `shared` or `exclusive`; defaults to `shared` for reads, `exclusive` otherwise |
| `toolName` | snake_case model name; defaults to the derived name |
| `targetChange` | `'synchronous'` only for a synchronous mutation that intentionally changes the chart target |
| `dispose()` | Optional cleanup, called once on unregister or session destruction |

The namespaces `data`, `capture`, `sdk`, `drawings`, `studies`, `settings`, `workspace` and `capabilities` are reserved. Native commands use a protected registrar, so an extension cannot replace a typed built-in operation.

### Composing commands

`context.execute(name, input)` runs another command, or an SDK port (`data.series`, `data.read`, `data.requestHistory`, `capture.image`), as part of the same request. Children share the signal, deadline and target fence, get a derived request ID and do not take another concurrency slot. A child's effect must be `read` or match the parent's, so a `read` command can never mutate or reach an external service. Target-changing commands cannot run as children, and nesting is limited to four levels. Calls to ports and built-in commands are typed: the result has the command's output type, and the input must match its input type or be typed `unknown` (the child validates it either way).

## Host ports

Use `createChartAutomation(host, policy)` when your application supplies its own data, capture and lifecycle integration. `openAutomation` and `createNativeChartAutomation` accept `additionalData`, `requestHistory` and `subscribeAdditionalData` for the standard chart.

| Port | Host responsibility |
| --- | --- |
| `currentTarget()` | Stable chart ID and generation that changes on selection or replacement, including A → B → A |
| `data.series()` | Stable unique series IDs, numeric field declarations, units and readiness |
| `data.read(input, context)` | Bounded local rows, revision and explicit loaded coverage |
| `data.requestHistory(input, context)` | Optional bounded provider ingestion, cancellation and coverage without navigating the chart |
| `capture.image(context)` | Local PNG and metadata belonging to the requested target |
| `subscribe(listener)` | Publish committed lifecycle/data changes; return a cleanup function |

The SDK validates declared fields and response shapes. Discovery permits up to 256 series with 128 fields per series; reads permit at most 10,000 rows and remain subject to the JSON byte budget. A descriptor uses this shape:

```ts
const series = {
  id: 'analytics.rsi',
  kind: 'study',
  timeUnit: 'milliseconds',
  readiness: 'ready',
  fields: [{ name: 'value', type: 'number', nullable: true }],
} as const;
// A warm-up row can be { time: 1735689600000, value: null }.
// A calculated row can be { time: 1735776000000, value: 52.4 }.
```

`time` is implicit and cannot be declared as a field. Undeclared fields, missing required values, non-finite numbers and unordered timestamps reject. History responses follow the same validation. Keep the provider's own work bounded before constructing results; a response-size check cannot make an unbounded database query safe.

## Durable saves

Native drawing and study changes apply locally with Undo. To save them before they appear, pass `persist`:

```ts
const sdk = await chart.openAutomation({
  async persist(change, context) {
    // change.family is 'drawings' or 'studies'; change.prepared.document is the candidate.
    await saveDocument(change.family, change.prepared.document, { operationId: context.requestId, signal: context.signal });
  },
});
```

`persist` runs after native preparation and before commit, while a mutation lease blocks manual edits. Reject to abort: the candidate is discarded and nothing is applied. If the request is cancelled after `persist` resolves, the change is saved but not applied; reconcile it as you would a lost response. Chart settings are never persisted.

## Side effects and lifecycle

The SDK rejects stale asynchronous results, but it cannot undo an external side effect or forcibly stop JavaScript. Check the AbortSignal and target before committing asynchronous work.

Completed-request idempotency belongs to your custom handler; the SDK only rejects duplicate in-flight request IDs. Native commands retain their native replay protection. This is an API for trusted extensions, not an untrusted-code sandbox.

Close sessions and release host subscriptions when the owning view is removed. Session cleanup attempts remaining command disposers even when one fails. Keep uploads, AI prompts and budgets, conversation storage and entitlement checks in host adapters so the same chart product works across applications.

## Testing commands

`createTestAutomation` gives you an in-memory chart for unit tests:

```ts
import { createTestAutomation } from '@lumencharts/chart-automation/sdk/testing';

const { sdk, select, setRows, remove } = createTestAutomation({
  rows: { main: [{ time: 1, open: 1, high: 2, low: 1, close: 2 }] },
});
sdk.extensions.register(myCommand);
expect(await sdk.execute('acme.lastClose', {})).toEqual({ close: 2 });

const earlier = sdk.request();
select();                                        // a symbol or interval change
await expect(sdk.execute('acme.lastClose', {}, earlier)).rejects.toMatchObject({ code: 'stale_binding' });
```

`setRows` replaces loaded rows and publishes `data`; `remove` simulates chart removal. Capture returns a 1×1 PNG unless `capture: false`.

### Native commands without a widget

Pass `owners` to install the native `drawings.*`, `studies.*`, `settings.*` and `workspace.*` commands, plus an optional `persist` hook, exactly as `installNativeAutomationCommands` does on a chart. `createFakeDrawingOwner()` is an in-memory drawing owner with native receipts, revisions, mutation leases and Undo, so a command that calls `context.execute('drawings.apply', …)` can be tested end to end:

```ts
import { createFakeDrawingOwner, createTestAutomation } from '@lumencharts/chart-automation/sdk/testing';

const drawings = createFakeDrawingOwner({ binding: { symbol: { ticker: 'AAPL' } } });
const saved: string[] = [];
const { sdk, select } = createTestAutomation({
  policy: { effects: ['read', 'mutation'] },
  owners: {
    drawings,
    async persist(change, context) {
      saved.push(context.requestId);            // runs before commit, under a lease
    },
  },
});
const command = sdk.extensions.register(markEarnings);

const { drawingId } = await command.execute({ symbol: 'AAPL' });
expect((await sdk.drawings.list({ offset: 0, limit: 10 })).drawings[0]?.id).toBe(drawingId);
expect(drawings.undo(saved[0]!)).toBe(true);   // native Undo by operation ID

const earlier = sdk.request();
select();
await expect(command.execute({ symbol: 'AAPL' }, earlier)).rejects.toMatchObject({ code: 'stale_binding' });
```

The fake supports `create`, `update` and `delete` operations on plain drawing summaries; group operations reject with `unsupported`. `leased()` reports whether a mutation lease is held, and `manualEdit(operationId, change)` simulates a hand-made edit that joins the same Undo history. Pass real owners from a chart instead to test against native behavior. `binding` defaults to the drawing owner's binding.

[Run the model on a server →](https://docs.lumencharts.com/charting-library/automation/remote)

---
Documentation page: https://docs.lumencharts.com/charting-library/automation/extensions


---

<!-- Public documentation export; not library implementation source. -->
# Server-side models

Most AI integrations call the model from a server while the chart runs in the browser. A remote session keeps the chart, its fences and its native owners in the browser and gives the server the same command facade and model tools.

```ts
// Browser
import { serveAutomation } from '@lumencharts/chart-automation/sdk';

const sdk = await chart.openAutomation({ policy: { effects: ['read', 'mutation'] } });
const server = serveAutomation(sdk, {
  captureResult: async capture => ({ attachmentId: await upload(capture.blob) }),
});
myChannel.onCall(async (call, signal) => myChannel.reply(await server.handle(call, signal)));
startTurn({ chart: server.snapshot() });
```

```ts
// Server
import { createAutomationTools, connectAutomation } from '@lumencharts/chart-automation/sdk';

const chart = connectAutomation(turn.chart, {
  send: (call, signal) => myChannel.call(call, signal),
});
const tools = createAutomationTools(chart, { use: [budgets, auditLog], imageResult: toProviderImage });
const system = chart.instructions();
```

## Protocol

| Message | Shape |
| --- | --- |
| Snapshot | `{ version: 1, target, capabilities, instructions }`, sent by the browser at the start of a turn and again when `capabilities().revision` changes (`chart.update(snapshot)`) |
| Call | `{ version: 1, requestId, target, name, commandVersion?, input, timeoutMs? }` |
| Result | `{ version: 1, ok: true, value, target }` or `{ version: 1, ok: false, code, target }` |

`name` is a command name or one of `data.series`, `data.read`, `data.requestHistory` and `capture.image`. Timeouts are relative, so server and browser clocks need not agree; the remote session also enforces the snapshot's deadline ceiling locally. Results carry the chart's current target, so the server learns about a navigation and later calls are fenced to the new chart. A call built against a different `commandVersion` rejects with `unsupported`. Errors carry a chart error code and, for rejected input, optional `details` (`{ path, reason }`), never a message. `parseAutomationRemoteResult` validates and bounds `details` and drops anything else.

Capture is advertised only when the browser supplies `captureResult`, which turns the PNG into something your channel can carry; on the server, `capture.image()` and the `capture_image` tool resolve to that value.

## Transport responsibilities

The SDK is transport-neutral. Your channel owns:

- delivery and reconnection;
- durable replay by `requestId`: a repeated call returns the stored result instead of running twice;
- rejecting a known `requestId` sent with different input;
- forwarding cancellation through the `signal` on both sides.

`server.handle` never rejects; it always resolves to a result. `chart.destroy()` aborts in-flight calls on the server side, and later calls reject with `unavailable`.

---
Documentation page: https://docs.lumencharts.com/charting-library/automation/remote


---

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

Trading adds an order ticket, an account manager (orders, positions and account summary), an optional depth-of-market panel, and orders and positions drawn on the chart, where they can be dragged to modify them. It is built on the Lumen Charts trading platform, which is open source under the Apache License 2.0 ([source on GitHub](https://github.com/lumenchartshq/trading-platform)). Every Lumen Charts build includes it. There is no separate add-on to buy.

The chart never talks to a broker on its own. You write a broker adapter that connects to your broker or backend, and the chart calls it to read accounts, orders and positions and to place, modify and cancel orders. The adapter follows the widely used broker API shape, so an existing adapter written for that shape connects without changes.

## What ships where

| Part | What it is | How you get it |
| --- | --- | --- |
| Trading runtime | The order ticket, account manager, depth panel and on-chart trading, as `assets/chart-trading.js` and `assets/chart-trading.css` | Included in every release. The chart downloads it only when you call `loadTrading()` |
| Trading platform package (open source) | Broker and datafeed types, a simulated broker and a conformance kit for testing your adapter | `npm install @lumencharts/trading-platform` |
| Broker adapter | Your connection to the broker: accounts, orders, positions, executions and quotes | Your application |

You don't need the npm package to use trading in the chart. The broker types are also in the chart's `lumen_charting_library.d.ts`. The package is useful for testing your adapter, and for building trading screens outside the chart.

## Connect a broker

Pass a broker factory and its configuration when you create the widget, then load trading once the chart is ready:

```ts
const widget = new LumenChartingLibrary.widget({
  container: 'chart',
  library_path: '/lumen_charting_library/',
  symbol: 'NASDAQ:AAPL',
  interval: '1D',
  datafeed,
  broker_factory: host => createBrokerAdapter(host),
  broker_config: {
    configFlags: { supportPositions: true, supportClosePosition: true, supportOrderBrackets: true },
  },
});

widget.onChartReady(() => {
  widget.loadTrading().catch(showTradingError);
});

// When the page or component goes away:
widget.remove();
```

`broker_factory` receives the host services (push updates for orders, positions and executions, connection status, notifications and formatters) and returns your adapter. `broker_config` declares what your broker supports: order types, brackets, durations, custom ticket fields and account manager layout. Features you don't declare stay off.

`loadTrading()` downloads the trading runtime, checks it matches the core build and connects your adapter. It rejects if the widget has no `broker_factory`. A failed load can be retried. Removing the widget disconnects the broker session and releases the runtime.

### Prices and depth

Quotes for the order ticket and the depth panel come from your datafeed's quote and depth methods. The depth panel also needs the `dom_widget` feature, Level 2 support from your broker, and bulk cancellation.

### Session options

`trading_session` is a Lumen Charts extension for hosts that need more control: a stable `settingsKey` so account table choices survive a reload, your own clock, market-data or formatter ports, and broker extensions such as a close-position preview.

```ts
trading_session: {
  settingsKey: 'my-broker',
  extensions: {
    previewClosePosition: request => adapter.previewClose(request),
  },
},
```

Credentials, pending commands and order or position snapshots are never saved.

## How orders are confirmed

A resolved broker promise only means the request was sent. The chart waits for your adapter to push the updated order or position before it treats a command as done, and it never resends a command on its own. If no confirmation arrives within ten seconds, the ticket says it is still checking with the broker and keeps asking your adapter to reconcile for up to a minute. Push every change through the host's update methods, including changes made outside the chart.

## Test your adapter

The open-source package has a simulated broker for demos and tests, and a conformance kit that runs acceptance scenarios against your adapter:

```bash
npm install --save-dev @lumencharts/trading-platform
```

```ts
import { createDeterministicBroker } from '@lumencharts/trading-platform/mock';
import { runConformance } from '@lumencharts/trading-platform/conformance';

// A simulated broker with its own clock and prices, for demos and tests.
const simulated = createDeterministicBroker({ profile: 'equity-net' });
// Pass simulated.brokerFactory and simulated.brokerConfig to the widget.

// Run the acceptance scenarios against your adapter. setup() returns your
// broker factory and config, a market-data port, and a tradable symbol with
// a price and quantity to trade.
const report = await runConformance({ name: 'my-broker', setup: () => createMyConformanceSetup() });
console.log(`${report.passed} passed, ${report.failed} failed, ${report.skipped} skipped`);
```

Each result names the scenario, its outcome, and the broker calls it observed, so a failure points at the call to fix.

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


---

<!-- Public documentation export; not library implementation source. -->
# Events, history and advanced APIs

Subscribe to events to follow what the chart is doing, and use commands to change it. Keep the chart's internal objects out of your code.

## Subscriptions

For every `widget.subscribe(event, callback)`, call `unsubscribe` later with the same callback. Chart subscription handles take the documented owner and callback arguments. Keep a list of what to clean up, and unsubscribe when the chart or component goes away.

## Screenshots

Use the public screenshot API, and check what it actually returns. Uploading screenshots to a server needs a service you set up. Capturing the canvas doesn't give you a shareable URL by itself. Images from other origins can also stop the canvas from being exported.

## History checkpoints

The optional history command API lets you export and restore a versioned checkpoint of the chart's undo history. This is separate from saving the chart itself. Checkpoints have limits on the number of actions and their size, and they may stop at an action that isn't supported. Restore the saved chart first, then check that the chart's identity and current state match before you restore its history.

## Automation SDK

Use the optional [automation SDK](https://docs.lumencharts.com/charting-library/automation/) for typed command sessions, bounded local data, PNG capture and custom extensions. Native command owners require explicit add-on loading. Model providers, uploads and remote persistence remain host integrations.

## External command interfaces

The workspace, drawing, study and history command factories tell your app which commands are available. They need a stable link to a specific chart and versioned inputs. The internal worker protocol and the Nuxt app's own services aren't general browser APIs, so don't build on them.

## Performance

Measure startup, interaction and cleanup in your real app. Keep history requests to a reasonable size, don't rebuild charts when unrelated UI state changes, and release subscriptions. Good performance with sample data doesn't guarantee the same with every real market dataset.

[Public API index](https://docs.lumencharts.com/charting-library/api/)

---
Documentation page: https://docs.lumencharts.com/charting-library/reference/events


---

<!-- Public documentation export; not library implementation source. -->
# Compatibility and supported scope

The runtime covers real, everyday charting workflows, and its browser namespace is `LumenChartingLibrary`. This page explains how to tell what's supported.

## Reading the API reference

The API reference sorts types into three kinds:

- Facades the runtime actually implements.
- Interfaces that your app implements.
- Types that exist only in the declarations for compatibility.

A signature in a declaration file doesn't mean there's a broker connection, an external cloud service or a full indicator catalog behind it.

To see what your loaded runtime supports, call `widget.getAllFeatures()`, `widget.supportedChartTypes()` and `widget.getStudiesList()`. The catalogs in these docs list the tools and indicators the runtime includes. If someone passes an unsupported input, treat it as an error. Don't quietly swap in a different feature.

## Who handles what

| Capability | Handled by |
| --- | --- |
| Historical and realtime bars | Your datafeed |
| Chart rendering and supported tools | The chart runtime |
| Layout storage and access control | Your adapter and backend |
| Order ticket, account manager and on-chart orders | The trading runtime, after `loadTrading()` |
| Placing broker orders | Your broker adapter (drawings and annotations don't place orders) |
| Pine worker and editor | Optional assets that you turn on |
| Pine cloud publishing and alerts | Providers you configure (drawing Pine locally is not cloud delivery) |
| Layouts saved by other chart libraries | Not guaranteed to work with this runtime's formats |

## Release identity

The legacy `version()` string tells you which version line the runtime is compatible with. To identify the exact files you shipped, use the manifest digest shown on the [releases](https://docs.lumencharts.com/charting-library/reference/releases) page. Always ship the wrapper, iframe, styles and worker together.

The demo uses sample data and stores things in your browser only. It makes no promises about market data uptime, financial accuracy or saving to a server.

---
Documentation page: https://docs.lumencharts.com/charting-library/reference/compatibility


---

<!-- Public documentation export; not library implementation source. -->
# Releases and upgrading

These docs are built against one verified chart release. Its build ID appears above each article and matches the compiled runtime the demo uses.

## Compatibility version versus build ID

The public `version()` string tells you which version line the runtime is compatible with. The SHA-256 runtime manifest identifies the exact wrapper, iframe, styles and optional Pine files served here. When you report a problem or compare deployments, use the manifest.

## About this documentation release

This first release adds the integration guides, the public API reference, a demo that behaves the same every time, and replaceable local images. It doesn't change how the chart language works, and it doesn't introduce a new universal compatibility version.

There's only one runtime release for now, so there's no versions menu. As more supported runtime releases come out, their docs should keep stable URLs and include clear upgrade notes.

## Upgrade safely

Upgrade the runtime, declarations, docs and optional files together as one release.

1. Read the new release's compatibility and schema changes.
2. Test your symbol metadata and your historical and realtime sample data.
3. Test drawings, indicators and a sample of real saved layouts and templates.
4. Try mounting, unmounting, reconnecting and failed save/load operations.
5. Check every deployed file against the new release's manifest.
6. Ship the whole release, and keep the previous one ready for rollback.

### Don't mix versions

A new wrapper with an old inner runtime or Pine worker can fail during startup or when the two talk to each other. Versioned paths that never change prevent old and new files from mixing in caches. To roll back, restore the whole release, not just one JavaScript file.

### Saved state

Keep provider and schema namespaces clearly separate. Reject saved data that isn't compatible, and never quietly drop parts of it. An older release may not be able to read data saved in a newer schema, so keep backups before any migration.

[Schema policy](https://docs.lumencharts.com/charting-library/persistence/migration)

---
Documentation page: https://docs.lumencharts.com/charting-library/reference/releases


---

<!-- Public documentation export; not library implementation source. -->
# Troubleshooting and support

Start with your browser's console and Network panel. First work out where things went wrong: the host container, loading the runtime files, the datafeed, an indicator, or saving and loading.

| What you see | What to check | How to fix it |
| --- | --- | --- |
| Blank chart | Container height and runtime script requests | Give the parent a height, and fix `library_path` |
| HTML comes back instead of JS | Your static host's fallback page | Serve the right file and MIME type, or a real 404 |
| Chart never becomes ready | Script errors, CSP, missing iframe files | Fix the resource that's failing, then retry from a clean start |
| Chart is ready but has no candles | `resolveSymbol` and `getBars` callbacks | Make sure every request ends in success or error, and check time units |
| Bars show up in 1970 or far in the future | Seconds mixed up with milliseconds | Convert at the documented point in your datafeed |
| Duplicate bars | Timestamp order and realtime update rules | Return unique, ascending history, and only update the latest bar in realtime |
| Too few bars | `countBack`, sessions and provider paging | Fetch earlier history, or report that there's genuinely no more |
| Old symbol shows up after switching | Late responses from earlier requests | Ignore responses from older requests, and unsubscribe |
| No Save/Load controls | Incomplete adapter | Implement all four layout methods |
| Saved layout is rejected | Schema or provider mismatch | Load a supported schema that matches, and keep the current chart as it is |
| Pine isn't available | Feature flag and worker/editor files | Ship the matching optional files and turn on the configuration |
| Chart keeps running after navigation | Your timers and subscriptions | Remove the widget and everything your code started |

## Try it with sample data

Open the [demo](https://docs.lumencharts.com/demo/). If the sample works but your provider doesn't, compare your symbol metadata, timestamps and callback order with the sample. If both fail, look at the runtime file requests and the browser environment.

## Glossary

| Term | Meaning |
| --- | --- |
| Widget | The chart container your app creates, and its public API |
| Chart | One chart inside a widget or layout |
| Datafeed | The callbacks your app provides for symbols and market data |
| Bar | One OHLCV data point, with a timestamp in epoch milliseconds |
| Resolution | How much time one bar covers, such as `15` or `1D` |
| Pane | One of the stacked plot areas in a chart, holding series or indicators |
| Study | An indicator or calculation added to a chart |
| Drawing | An interactive analysis shape with its own source ID |
| Layout | A saved chart or workspace setup |
| Template | A reusable set of style or indicator settings |
| Manifest | The list of runtime files and their cryptographic hashes |
| Runtime build ID | The start of this release manifest's hash |
| Capability | A feature that's fully set up and supported end to end |
| Provider | Code in your app that supplies data or external services |

## Integration support

Use the support channel that came with your chart distribution. These docs don't assume you can see the source repository or any internal issue tracker.

### Make the problem easy to reproduce

Note the runtime manifest ID from [releases](https://docs.lumencharts.com/charting-library/reference/releases), your browser and its version, your app's base path, and the smallest set of steps that shows the problem. Where you can, swap real market or account data for a small set of sample data.

Describe what you expected and what actually happened. Include console and network errors with sensitive details removed. Let us know whether the [interactive demo](https://docs.lumencharts.com/demo/) shows the same issue.

### Before you share

Remove API keys, session tokens, account IDs and private scripts. Keep the relevant symbol metadata and timestamps so the datafeed calls can be checked. Screenshots help, but they can't replace a sequence of callbacks that reproduces the problem.

---
Documentation page: https://docs.lumencharts.com/charting-library/reference/troubleshooting


---

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

Every example runs on the real chart runtime with sample data. You don't need to sign in or connect a data feed. Pick an example to run it in the chart; its code is further down this page. The [full demo](https://docs.lumencharts.com/demo/) puts everything together and saves layouts to your browser.

[Interactive chart example](https://docs.lumencharts.com/examples/) — runs in a browser with synthetic data.

## Minimal chart

The smallest working setup: the runtime files, one container and a datafeed. The sample datafeed returns historical bars in order, within the requested time range. [Your first chart](https://docs.lumencharts.com/charting-library/getting-started/quickstart) · [Historical bars](https://docs.lumencharts.com/charting-library/datafeed/history)

```ts
export const symbols = ['AAPL', 'MSFT', 'BTCUSD'] as const
export const resolutions = ['15', '60', '1D'] as ResolutionString[]
const day = 86_400_000
export const sampleEnd = Date.UTC(2026, 9, 15)
const sampleStart = sampleEnd - 730 * day

export function resolutionMs(resolution: string): number {
  if (resolution === '1D' || resolution === 'D') return day
  const minutes = Number(resolution)
  if (!Number.isFinite(minutes) || minutes <= 0) throw new Error('Unsupported sample interval')
  return minutes * 60_000
}
export function sampleBar(symbol: string, time: number, step: number): Bar {
  const index = (time - sampleStart) / step
  const base = symbol === 'BTCUSD' ? 62000 : symbol === 'MSFT' ? 400 : 180
  const wave = Math.sin(index * .17) * base * .025 + Math.cos(index * .043) * base * .04
  const open = base + wave + index * base * .00002
  const close = open + Math.sin(index * 1.71) * base * .008
  return { time, open, close, high: Math.max(open, close) + base * .003, low: Math.min(open, close) - base * .003, volume: Math.round(100000 + Math.abs(Math.sin(index)) * 400000) }
}
export function historicalBars(symbol: string, resolution: string, from: number, to: number, countBack: number): Bar[] {
  const step = resolutionMs(resolution)
  const end = Math.min(Math.ceil(to * 1000 / step) * step, sampleEnd)
  const requestedStart = Math.min(from * 1000, end - Math.min(Math.max(0, countBack), 5000) * step)
  const start = Math.max(sampleStart, Math.ceil(requestedStart / step) * step, end - 5000 * step)
  const bars: Bar[] = []
  for (let time = start; time < end; time += step) bars.push(sampleBar(symbol, time, step))
  return bars
}
export function createDemoDatafeed(options: { realtime?: boolean; empty?: boolean } = {}) {
  const timers = new Map<string, ReturnType<typeof setInterval>>()
  let disposed = false
  const later = (callback: () => void) => setTimeout(() => { if (!disposed) callback() }, 0)
  const datafeed: IBasicDataFeed = {
    onReady(callback) { later(() => callback({ supported_resolutions: resolutions, supports_marks: false, supports_timescale_marks: false, supports_time: true })) },
    getServerTime(callback) { later(() => callback(sampleEnd / 1000)) },
    searchSymbols(input, _exchange, _type, callback) {
      later(() => callback(symbols.filter(symbol => symbol.includes(input.toUpperCase())).map(symbol => ({ symbol, full_name: symbol, ticker: symbol, description: `${symbol} · synthetic sample`, exchange: 'DEMO', type: 'stock' }))))
    },
    resolveSymbol(name, success, failure) {
      if (!symbols.includes(name as typeof symbols[number])) { later(() => failure('unknown_symbol')); return }
      const info: LibrarySymbolInfo = { name, ticker: name, description: `${name} · sample data`, type: 'stock', exchange: 'DEMO', listed_exchange: 'DEMO', session: '24x7', timezone: 'Etc/UTC', minmov: 1, pricescale: 100, has_intraday: true, has_daily: true, supported_resolutions: resolutions, volume_precision: 0, format: 'price', data_status: 'streaming' }
      later(() => success(info))
    },
    getBars(info, resolution, period, success, failure) {
      try {
        const bars = options.empty ? [] : historicalBars(info.ticker ?? info.name, resolution, period.from, period.to, period.countBack)
        later(() => success(bars, { noData: bars.length === 0 }))
      } catch (error) { later(() => failure(error instanceof Error ? error.message : 'Sample data unavailable')) }
    },

    subscribeBars(info, resolution, callback, id) {
      datafeed.unsubscribeBars(id)
      if (!options.realtime || options.empty || disposed) return
      const step = resolutionMs(resolution)
      let sequence = 0
      const bar = sampleBar(info.ticker ?? info.name, sampleEnd - step, step)
      timers.set(id, setInterval(() => {
        sequence += 1
        const close = bar.close + Math.sin(sequence * .4) * bar.close * .0005
        callback({ ...bar, close, high: Math.max(bar.high, close), low: Math.min(bar.low, close), volume: (bar.volume ?? 0) + sequence * 100 })
      }, 1000))
    },
    unsubscribeBars(id) { const timer = timers.get(id); if (timer) clearInterval(timer); timers.delete(id) },

  }
  return { datafeed, activeSubscriptions: () => timers.size, dispose() { disposed = true; for (const id of timers.keys()) datafeed.unsubscribeBars(id) } }
}
```

## Simulated realtime

The latest bar updates once per second. Each subscription owns one timer, and unsubscribing clears it. [Realtime updates](https://docs.lumencharts.com/charting-library/datafeed/realtime)

```ts
subscribeBars(info, resolution, callback, id) {
  datafeed.unsubscribeBars(id)
  if (!options.realtime || options.empty || disposed) return
  const step = resolutionMs(resolution)
  let sequence = 0
  const bar = sampleBar(info.ticker ?? info.name, sampleEnd - step, step)
  timers.set(id, setInterval(() => {
    sequence += 1
    const close = bar.close + Math.sin(sequence * .4) * bar.close * .0005
    callback({ ...bar, close, high: Math.max(bar.high, close), low: Math.min(bar.low, close), volume: (bar.volume ?? 0) + sequence * 100 })
  }, 1000))
},
unsubscribeBars(id) { const timer = timers.get(id); if (timer) clearInterval(timer); timers.delete(id) },
```

## Themes

Switch between light and dark without recreating the chart. Use this site's theme toggle; the chart follows it with the call below. [Themes and overrides](https://docs.lumencharts.com/charting-library/configuration/themes)

```ts
export function applyTheme(widget: ILumenChartingLibraryWidget, theme: 'light' | 'dark') {
  // Restyles the existing chart; drawings, indicators and the visible range stay as they are.
  return widget.changeTheme(theme)
}
```

## Create a drawing

Add a trend line with the drawing API. [Drawings](https://docs.lumencharts.com/charting-library/drawings)

```ts
export function addTrendLine(widget: ILumenChartingLibraryWidget) {
  const chart = widget.activeChart()
  const range = chart.getVisibleRange()
  const to = range.to || sampleEnd / 1000
  const from = range.from || to - 40 * 86400
  const id = chart.createMultipointShape([
    { time: from + (to - from) * .25, price: 180 },
    { time: from + (to - from) * .75, price: 195 },
  ], { shape: 'trend_line' })
  if (!id) throw new Error('The drawing could not be created')
  return id
}
```

## Add an indicator

Add a 20-period Moving Average with the built-in indicator API. [Built-in indicators](https://docs.lumencharts.com/charting-library/studies)

```ts
export async function addMovingAverage(widget: ILumenChartingLibraryWidget) {
  const id = await widget.activeChart().createStudy('Moving Average', false, false, { length: 20 })
  if (!id) throw new Error('The study could not be created')
  return id
}
```

## Save a layout

Save, list, load and delete layouts with the controls under the chart. This adapter keeps them in your browser; yours would call your own service. [Save/load adapter](https://docs.lumencharts.com/charting-library/persistence#saveload-adapter)

```ts
// Import these public types from the declarations in your authorized distribution.
export const storageKey = 'lumencharts-docs:layouts:v1'
type RecordEntry = ChartData & { id: string; timestamp: number }
type StoragePort = Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>
export function createDemoStorage(storage: StoragePort) {
  function read(): RecordEntry[] {
    const raw = storage.getItem(storageKey)
    if (!raw) return []
    let parsed: unknown
    try { parsed = JSON.parse(raw) } catch { throw new Error('Saved sample layouts are invalid. Reset saved layouts to start again.') }
    if (!Array.isArray(parsed) || parsed.length > 30 || !parsed.every(item => item && typeof item === 'object' && typeof item.id === 'string' && /^\d+$/.test(item.id) && typeof item.name === 'string' && typeof item.content === 'string' && typeof item.symbol === 'string' && typeof item.resolution === 'string' && Number.isFinite(item.timestamp))) throw new Error('Saved sample layouts are invalid. Reset saved layouts to start again.')
    return parsed as RecordEntry[]
  }
  function write(records: RecordEntry[]) {
    const value = JSON.stringify(records)
    if (value.length > 2_000_000) throw new Error('Sample storage is full. Delete a saved layout first.')
    storage.setItem(storageKey, value)
  }
  const adapter: Pick<IExternalSaveLoadAdapter, 'getAllCharts' | 'saveChart' | 'getChartContent' | 'removeChart'> = {
    async getAllCharts() { return read().map(({ id, name, symbol, resolution, timestamp }) => ({ id: Number(id), name, symbol, resolution: resolution as ResolutionString, timestamp })) },
    async saveChart(chart) {
      const records = read()
      const id = String(chart.id ?? Math.max(Date.now(), ...records.map(item => Number(item.id) + 1)))
      const next = records.filter(item => item.id !== id)
      if (next.length >= 30) throw new Error('Save up to 30 sample layouts. Delete one first.')
      next.push({ ...chart, id, timestamp: Math.floor(Date.now() / 1000) })
      write(next)
      return id
    },
    async getChartContent(id) { const item = read().find(item => item.id === String(id)); if (!item) throw new Error('Saved layout was not found'); return item.content },
    async removeChart(id) { write(read().filter(item => item.id !== String(id))) },
  }
  return { adapter, reset: () => storage.removeItem(storageKey) }
}
```

## Mount and cleanup

Every switch between examples removes the chart and stops its datafeed before the next one starts. Do the same when the view that hosts your chart closes. [Lifecycle and cleanup](https://docs.lumencharts.com/charting-library/getting-started/lifecycle)

```ts
export function removeChart(widget: ILumenChartingLibraryWidget | undefined, feed: { dispose(): void } | undefined) {
  // Remove the widget before the view goes away, then stop the datafeed's timers and sockets.
  widget?.remove()
  feed?.dispose()
}
```

## Multiple charts

Two charts in one widget, each working on its own. [Workspaces and comparisons](https://docs.lumencharts.com/charting-library/configuration/workspaces)

```ts
export function splitWorkspace(widget: ILumenChartingLibraryWidget) {
  widget.setLayout('2h')
}
```

## Pine moving average

Load the optional Pine worker and run a short script. [Optional Pine](https://docs.lumencharts.com/charting-library/studies/pine)

```ts
export async function addPineAverage(widget: ILumenChartingLibraryWidget) {
  return widget.activeChart().createPineStudy(
    '//@version=5\nindicator("Sample average", overlay=true)\nplot(ta.sma(close, 20))',
  )
}
```

## About these previews

The chart loads the compiled runtime so it can run here, but this site doesn't distribute the library for reuse. See [runtime access and hosting](https://docs.lumencharts.com/charting-library/getting-started/installation). If a chart fails to load, you'll see a retry button. Anything you save stays in your browser and is only used by these docs. The code uses public integration types that come with your authorized distribution.

---
Documentation page: https://docs.lumencharts.com/examples/


---

<!-- Public documentation export; not library implementation source. -->
# Explore the chart

Real charting tools with sample data that's the same every time. Use the chart's own toolbar to switch symbols, draw or add indicators. The buttons around it call the same features through the API, and save layouts in your browser. You don't need an account or a market data connection.

[Interactive chart example](https://docs.lumencharts.com/demo/) — runs in a browser with synthetic data.

The sample market trades around the clock in UTC and uses fixed historical data. It's for illustration only, not a live price feed. Saved layouts stay in your browser, and **Clear saved layouts** only removes this demo's layouts.

[Build your first chart](https://docs.lumencharts.com/charting-library/getting-started/quickstart) · [Explore the examples](https://docs.lumencharts.com/examples/)

---
Documentation page: https://docs.lumencharts.com/demo/


---

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

[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.

## type {#type}

```ts
type: "black" | "white";
```

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

## tools {#tools}

```ts
tools: AccessListItem[];
```

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

## Related types

- [AccessListItem](https://docs.lumencharts.com/charting-library/api/AccessListItem)

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


---

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

[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.

## name {#name}

```ts
name: string;
```

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

## grayed {#grayed}

```ts
grayed?: boolean;
```

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

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


---

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

[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.

```ts
export declare const enum ActionId {
  ChartAddIndicatorToAllCharts = "Chart.AddIndicatorToAllCharts",
  ChartAddSymbolToWatchList = "Chart.AddSymbolToWatchList",
  ChartApplyIndicatorsToAllCharts = "Chart.ApplyIndicatorsToAllCharts",
  ChartChangeTimeZone = "Chart.ChangeTimeZone",
  ChartClipboardCopyPrice = "Chart.Clipboard.CopyPrice",
  ChartClipboardCopyLineTools = "Chart.Clipboard.CopyLineTools",
  ChartClipboardCopySource = "Chart.Clipboard.CopySource",
  ChartClipboardPasteSource = "Chart.Clipboard.PasteSource",
  ChartCrosshairLockVerticalCursor = "Chart.Crosshair.LockVerticalCursor",
  ChartCrosshairPlusButtonDrawHorizontalLine = "Chart.Crosshair.PlusButton.DrawHorizontalLine",
  ChartCustomActionId = "Chart.CustomActionId",
  ChartDialogsShowChangeInterval = "Chart.Dialogs.ShowChangeInterval",
  ChartDialogsShowChangeSymbol = "Chart.Dialogs.ShowChangeSymbol",
  ChartDialogsShowCompareOrAddSymbol = "Chart.Dialogs.ShowCompareOrAddSymbol",
  ChartDialogsShowGeneralSettings = "Chart.Dialogs.ShowGeneralSettings",
  ChartDialogsShowGeneralSettingsLegendTab = "Chart.Dialogs.ShowGeneralSettings.LegendTab",
  ChartDialogsShowGeneralSettingsSymbolTab = "Chart.Dialogs.ShowGeneralSettings.SymbolTab",
  ChartDialogsShowGeneralScalesTab = "Chart.Dialogs.ShowGeneralSettings.ScalesTab",
  ChartDialogsShowGoToDate = "Chart.Dialogs.ShowGoToDate",
  ChartDialogsShowInsertIndicators = "Chart.Dialogs.ShowInsertIndicators",
  ChartDialogsShowSymbolInfo = "Chart.Dialogs.ShowSymbolInfo",
  ChartDrawingToolbarToggleVisibility = "Chart.DrawingToolbar.ToggleVisibility",
  ChartExternalActionId = "Chart.ExternalActionId",
  ChartFavoriteDrawingToolsToolbarHide = "Chart.FavoriteDrawingToolsToolbar.Hide",
  ChartIndicatorShowSettingsDialog = "Chart.Indicator.ShowSettingsDialog",
  ChartLegendToggleLastDayChangeValuesVisibility = "Chart.Legend.ToggleLastDayChangeValuesVisibility",
  ChartLegendToggleBarChangeValuesVisibility = "Chart.Legend.ToggleBarChangeValuesVisibility",
  ChartLegendTogglePriceSourceVisibility = "Chart.Legend.TogglePriceSourceVisibility",
  ChartLegendToggleIndicatorArgumentsVisibility = "Chart.Legend.ToggleIndicatorArgumentsVisibility",
  ChartLegendToggleIndicatorTitlesVisibility = "Chart.Legend.ToggleIndicatorTitlesVisibility",
  ChartLegendToggleIndicatorValuesVisibility = "Chart.Legend.ToggleIndicatorValuesVisibility",
  ChartLegendToggleOhlcValuesVisibility = "Chart.Legend.ToggleOhlcValuesVisibility",
  ChartLegendToggleOpenMarketStatusVisibility = "Chart.Legend.ToggleOpenMarketStatusVisibility",
  ChartLegendToggleSymbolVisibility = "Chart.Legend.ToggleSymbolVisibility",
  ChartLegendToggleVolumeVisibility = "Chart.Legend.ToggleVolumeVisibility",
  ChartLines = "Chart.Lines",
  ChartLinesToggleBidAskLinesVisibility = "Chart.Lines.ToggleBidAskLinesVisibility",
  ChartLinesToggleHighLowLinesVisibility = "Chart.Lines.ToggleHighLowLinesVisibility",
  ChartLinesToggleAverageLineVisibility = "Chart.Lines.ToggleAverageLineVisibility",
  ChartLinesToggleSeriesPrevCloseLineVisibility = "Chart.Lines.ToggleSeriesPrevCloseLineVisibility",
  ChartLinesToggleSeriesPriceLineVisibility = "Chart.Lines.ToggleSeriesPriceLineVisibility",
  ChartLineToolBarsPatternToggleFlipped = "Chart.LineTool.BarsPattern.ToggleFlipped",
  ChartLineToolBarsPatternToggleMirrored = "Chart.LineTool.BarsPattern.ToggleMirrored",
  ChartLineToolClone = "Chart.LineTool.Clone",
  ChartLineToolCreateLimitOrderFromState = "Chart.LineTool.CreateLimitOrderFromState",
  ChartLineToolElliotChangeDegreeProperty = "Chart.LineTool.Elliot.ChangeDegreeProperty",
  ChartLineToolNoSync = "Chart.LineTool.NoSync",
  ChartLineToolPitchforkChangeTypeToInside = "Chart.LineTool.Pitchfork.ChangeTypeToInside",
  ChartLineToolPitchforkChangeTypeToModifiedSchiff = "Chart.LineTool.Pitchfork.ChangeTypeToModifiedSchiff",
  ChartLineToolPitchforkChangeTypeToOriginal = "Chart.LineTool.Pitchfork.ChangeTypeToOriginal",
  ChartLineToolPitchforkChangeTypeToSchiff = "Chart.LineTool.Pitchfork.ChangeTypeToSchiff",
  ChartLineToolSyncInLayout = "Chart.LineTool.SyncInLayout",
  ChartLineToolTemplates = "Chart.LineTool.Templates",
  ChartLineToolTemplatesApply = "Chart.LineTool.Templates.Apply",
  ChartLineToolTemplatesApplyDefaults = "Chart.LineTool.Templates.ApplyDefaults",
  ChartLineToolTemplatesSaveAs = "Chart.LineTool.Templates.SaveAs",
  ChartLineToolToolbarChangeFontSizeProperty = "Chart.LineTool.Toolbar.ChangeFontSizeProperty",
  ChartLineToolToolbarChangeLineStyleToDashed = "Chart.LineTool.Toolbar.ChangeLineStyleToDashed",
  ChartLineToolToolbarChangeLineStyleToDotted = "Chart.LineTool.Toolbar.ChangeLineStyleToDotted",
  ChartLineToolToolbarChangeLineStyleToSolid = "Chart.LineTool.Toolbar.ChangeLineStyleToSolid",
  ChartMarksToggleVisibility = "Chart.Marks.ToggleVisibility",
  ChartMoveChartInLayout = "Chart.MoveChartInLayout",
  ChartMoveChartInLayoutBack = "Chart.MoveChartInLayout.Back",
  ChartMoveChartInLayoutForward = "Chart.MoveChartInLayout.Forward",
  ChartObjectTreeShow = "Chart.ObjectTree.Show",
  ChartDataWindowShow = "Chart.DataWindow.Show",
  ChartPaneControlsDeletePane = "Chart.PaneControls.DeletePane",
  ChartPaneControlsMaximizePane = "Chart.PaneControls.MaximizePane",
  ChartPaneControlsMinimizePane = "Chart.PaneControls.MinimizePane",
  ChartPaneControlsMovePaneDown = "Chart.PaneControls.MovePaneDown",
  ChartPaneControlsMovePaneUp = "Chart.PaneControls.MovePaneUp",
  ChartPaneControlsCollapsePane = "Chart.PaneControls.CollapsePane",
  ChartPaneControlsRestorePane = "Chart.PaneControls.RestorePane",
  ChartPriceScaleLabels = "Chart.PriceScale.Labels",
  ChartPriceScaleLabelsToggleBidAskLabelsVisibility = "Chart.PriceScale.Labels.ToggleBidAskLabelsVisibility",
  ChartPriceScaleLabelsToggleHighLowPriceLabelsVisibility = "Chart.PriceScale.Labels.ToggleHighLowPriceLabelsVisibility",
  ChartPriceScaleLabelsToggleAveragePriceLabelVisibility = "Chart.PriceScale.Labels.ToggleAveragePriceLabelVisibility",
  ChartPriceScaleLabelsToggleIndicatorsNameLabelsVisibility = "Chart.PriceScale.Labels.ToggleIndicatorsNameLabelsVisibility",
  ChartPriceScaleLabelsToggleIndicatorsValueLabelsVisibility = "Chart.PriceScale.Labels.ToggleIndicatorsValueLabelsVisibility",
  ChartPriceScaleLabelsToggleNoOverlappingLabelsVisibility = "Chart.PriceScale.Labels.ToggleNoOverlappingLabelsVisibility",
  ChartPriceScaleLabelsToggleSeriesLastValueVisibility = "Chart.PriceScale.Labels.ToggleSeriesLastValueVisibility",
  ChartPriceScaleLabelsToggleSymbolNameLabelsVisibility = "Chart.PriceScale.Labels.ToggleSymbolNameLabelsVisibility",
  ChartPriceScaleLabelsToggleSymbolPrevCloseValueVisibility = "Chart.PriceScale.Labels.ToggleSymbolPrevCloseValueVisibility",
  ChartPriceScaleMergeAllScales = "Chart.PriceScale.MergeAllScales",
  ChartPriceScaleMergeAllScalesToLeft = "Chart.PriceScale.MergeAllScalesToLeft",
  ChartPriceScaleMergeAllScalesToRight = "Chart.PriceScale.MergeAllScalesToRight",
  ChartPriceScaleMoveToLeft = "Chart.PriceScale.MoveToLeft",
  ChartPriceScaleMoveToRight = "Chart.PriceScale.MoveToRight",
  ChartPriceScaleReset = "Chart.PriceScale.Reset",
  ChartPriceScaleToggleAddOrderPlusButtonVisibility = "Chart.PriceScale.ToggleAddOrderPlusButtonVisibility",
  ChartPriceScaleToggleAutoScale = "Chart.PriceScale.ToggleAutoScale",
  ChartPriceScaleToggleAutoScaleSeriesOnly = "Chart.PriceScale.ToggleAutoScaleSeriesOnly",
  ChartPriceScaleToggleCountdownToBarCloseVisibility = "Chart.PriceScale.ToggleCountdownToBarCloseVisibility",
  ChartPriceScaleToggleIndexedTo100 = "Chart.PriceScale.ToggleIndexedTo100",
  ChartPriceScaleToggleInvertScale = "Chart.PriceScale.ToggleInvertScale",
  ChartPriceScaleToggleLogarithmic = "Chart.PriceScale.ToggleLogarithmic",
  ChartPriceScaleTogglePercentage = "Chart.PriceScale.TogglePercentage",
  ChartPriceScaleToggleRegular = "Chart.PriceScale.ToggleRegular",
  ChartRedo = "Chart.Redo",
  ChartRemoveAllIndicators = "Chart.RemoveAllIndicators",
  ChartRemoveAllIndicatorsAndLineTools = "Chart.RemoveAllIndicatorsAndLineTools",
  ChartRemoveAllLineTools = "Chart.RemoveAllLineTools",
  ChartScalesReset = "Chart.Scales.Reset",
  ChartScalesToggleLockPriceToBarRatio = "Chart.Scales.ToggleLockPriceToBarRatio",
  ChartScrollToLineTool = "Chart.ScrollToLineTool",
  ChartSelectedObjectHide = "Chart.SelectedObject.Hide",
  ChartSelectedObjectRemove = "Chart.SelectedObject.Remove",
  ChartSelectedObjectShow = "Chart.SelectedObject.Show",
  ChartSelectedObjectShowSettingsDialog = "Chart.SelectedObject.ShowSettingsDialog",
  ChartSelectedObjectToggleLocked = "Chart.SelectedObject.ToggleLocked",
  ChartSeriesPriceScaleToggleAutoScale = "Chart.Series.PriceScale.ToggleAutoScale",
  ChartSeriesPriceScaleToggleIndexedTo100 = "Chart.Series.PriceScale.ToggleIndexedTo100",
  ChartSeriesPriceScaleToggleInvertPriceScale = "Chart.Series.PriceScale.ToggleInvertPriceScale",
  ChartSeriesPriceScaleToggleLogarithmic = "Chart.Series.PriceScale.ToggleLogarithmic",
  ChartSeriesPriceScaleTogglePercentage = "Chart.Series.PriceScale.TogglePercentage",
  ChartSeriesPriceScaleToggleRegular = "Chart.Series.PriceScale.ToggleRegular",
  ChartSessionBreaksToggleVisibility = "Chart.SessionBreaks.ToggleVisibility",
  ChartSetSession = "Chart.SetSession",
  ChartSourceChangePriceScale = "Chart.Source.ChangePriceScale",
  ChartSourceMergeDown = "Chart.Source.MergeDown",
  ChartSourceMergeUp = "Chart.Source.MergeUp",
  ChartSourceMoveToNoScale = "Chart.Source.MoveToNoScale",
  ChartSourceMoveToOtherScale = "Chart.Source.MoveToOtherScale",
  ChartSourceMoveToPane = "Chart.Source.MoveToPane",
  ChartSourceUnmergeDown = "Chart.Source.UnmergeDown",
  ChartSourceUnmergeUp = "Chart.Source.UnmergeUp",
  ChartSourceVisualOrder = "Chart.Source.VisualOrder",
  ChartSourceVisualOrderBringForward = "Chart.Source.VisualOrder.BringForward",
  ChartSourceVisualOrderBringToFront = "Chart.Source.VisualOrder.BringToFront",
  ChartSourceVisualOrderSendBackward = "Chart.Source.VisualOrder.SendBackward",
  ChartSourceVisualOrderSendToBack = "Chart.Source.VisualOrder.SendToBack",
  ChartSourceResetInputPoints = "Chart.Source.ResetInputPoints",
  ChartTimeScaleReset = "Chart.TimeScale.Reset",
  ChartUndo = "Chart.Undo",
  ChartSourceIntervalsVisibility = "Chart.Source.IntervalsVisibility",
  ChartSourceIntervalsVisibilityCurrentAndAbove = "Chart.Source.IntervalsVisibility.CurrentAndAbove",
  ChartSourceIntervalsVisibilityCurrentAndBelow = "Chart.Source.IntervalsVisibility.CurrentAndBelow",
  ChartSourceIntervalsVisibilityOnlyCurrent = "Chart.Source.IntervalsVisibility.Current",
  ChartSourceIntervalsVisibilityAll = "Chart.Source.IntervalsVisibility.All",
  ObjectsTreeCreateGroup = "ObjectsTree.CreateGroup",
  ObjectsTreeRemoveItem = "ObjectsTree.RemoveItem",
  ObjectsTreeRenameItem = "ObjectsTree.RenameItem",
  ObjectsTreeToggleItemLocked = "ObjectsTree.ToggleItemLocked",
  ObjectsTreeToggleItemVisibility = "ObjectsTree.ToggleItemVisibility",
  TradingCancelOrder = "Trading.CancelOrder",
  TradingClosePosition = "Trading.ClosePosition",
  TradingCustomActionId = "Trading.CustomActionId",
  TradingDOMPlaceLimitOrder = "Trading.DOMPlaceLimitOrder",
  TradingDOMPlaceMarketOrder = "Trading.DOMPlaceMarketOrder",
  TradingDOMPlaceStopLimitOrder = "Trading.DOMPlaceStopLimitOrder",
  TradingDOMPlaceStopOrder = "Trading.DOMPlaceStopOrder",
  TradingEditOrder = "Trading.EditOrder",
  TradingModifyPosition = "Trading.ModifyPosition",
  TradingReversePosition = "Trading.ReversePosition",
  TradingSellBuyButtonsToggleVisibility = "Trading.SellBuyButtonsToggleVisibility",
  TradingTradeFromChart = "Trading.TradeFromChart",
  TradingNoOverlapMode = "Trading.NoOverlapMode",
  WatchlistAddSelectedSymbolsToCompare = "Watchlist.AddSelectedSymbolsToCompare ",
  WatchlistAddSymbolToCompare = "Watchlist.AddSymbolToCompare",
  WatchlistAddSymbolToSection = "Watchlist.AddSymbolToSection",
  WatchlistAddSymbol = "Watchlist.AddSymbol",
  WatchlistRemoveSection = "Watchlist.RemoveSection",
  WatchlistRenameSection = "Watchlist.RenameSection",
}
```

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


---

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

[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.

## Extends

`Partial`, `Pick`

## onExecute {#onexecute}

```ts
onExecute?: OnActionExecuteHandler;
```

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

## Related types

- [OmitActionId](https://docs.lumencharts.com/charting-library/api/OmitActionId)
- [ActionState](https://docs.lumencharts.com/charting-library/api/ActionState)
- [OnActionExecuteHandler](https://docs.lumencharts.com/charting-library/api/OnActionExecuteHandler)

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


---

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

[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.

## createAction {#createaction}

```ts
createAction: (options: ActionOptions) => IUpdatableAction;
```

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

## createAsyncAction {#createasyncaction}

```ts
createAsyncAction: (loader: () => Promise<ActionOptions>) => IUpdatableAction;
```

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

## createSeparator {#createseparator}

```ts
createSeparator: () => ISeparator;
```

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

## Related types

- [ActionOptions](https://docs.lumencharts.com/charting-library/api/ActionOptions)
- [IUpdatableAction](https://docs.lumencharts.com/charting-library/api/IUpdatableAction)
- [ISeparator](https://docs.lumencharts.com/charting-library/api/ISeparator)

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


---

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

[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.

## actionId {#actionid}

```ts
actionId: ActionId;
```

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

## active {#active}

```ts
active: boolean;
```

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

## label {#label}

```ts
label: string;
```

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

## styledLabel {#styledlabel}

```ts
styledLabel?: StyledText[];
```

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

## disabled {#disabled}

```ts
disabled: boolean;
```

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

## subItems {#subitems}

```ts
subItems: IActionVariant[];
```

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

## checkable {#checkable}

```ts
checkable: boolean;
```

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

## checked {#checked}

```ts
checked: boolean;
```

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

## hint {#hint}

```ts
hint?: string;
```

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

## icon {#icon}

```ts
icon?: string;
```

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

## iconChecked {#iconchecked}

```ts
iconChecked?: string;
```

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

## loading {#loading}

```ts
loading: boolean;
```

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

## shortcutHint {#shortcuthint}

```ts
shortcutHint?: string;
```

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

## Related types

- [ActionId](https://docs.lumencharts.com/charting-library/api/ActionId)
- [StyledText](https://docs.lumencharts.com/charting-library/api/StyledText)
- [IActionVariant](https://docs.lumencharts.com/charting-library/api/IActionVariant)

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


---

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

[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.

## title {#title}

```ts
title: string;
```

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

## propertyName {#propertyname}

```ts
propertyName: string;
```

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

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


---

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

[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.

## color1 {#color1}

```ts
color1: string;
```

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

## color2 {#color2}

```ts
color2: string;
```

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

## linecolor {#linecolor}

```ts
linecolor: string;
```

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

## linestyle {#linestyle}

```ts
linestyle: number;
```

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

## linewidth {#linewidth}

```ts
linewidth: number;
```

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

## transparency {#transparency}

```ts
transparency: number;
```

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

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


---

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

[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.

```ts
export type AvailableSaveloadVersions = "1.0" | "1.1";
```

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


---

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

[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.

## bringForwardEnabled {#bringforwardenabled}

```ts
bringForwardEnabled: boolean;
```

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

## bringToFrontEnabled {#bringtofrontenabled}

```ts
bringToFrontEnabled: boolean;
```

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

## sendBackwardEnabled {#sendbackwardenabled}

```ts
sendBackwardEnabled: boolean;
```

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

## sendToBackEnabled {#sendtobackenabled}

```ts
sendToBackEnabled: boolean;
```

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

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


---

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

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

## time {#time}

```ts
time: number;
```

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

## open {#open}

```ts
open: number;
```

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

## high {#high}

```ts
high: number;
```

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

## low {#low}

```ts
low: number;
```

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

## close {#close}

```ts
close: number;
```

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

## volume {#volume}

```ts
volume?: number;
```

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

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


---

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

[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.

```ts
export type BarDetailizationMode = "default" | "high";
```

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


---

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

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

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

## downColor {#downcolor}

```ts
downColor: string;
```

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

## barColorsOnPrevClose {#barcolorsonprevclose}

```ts
barColorsOnPrevClose: boolean;
```

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

## dontDrawOpen {#dontdrawopen}

```ts
dontDrawOpen: boolean;
```

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

## thinBars {#thinbars}

```ts
thinBars: boolean;
```

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

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


---

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

[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.

## topFillColor1 {#topfillcolor1}

```ts
topFillColor1: string;
```

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

## topFillColor2 {#topfillcolor2}

```ts
topFillColor2: string;
```

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

## bottomFillColor1 {#bottomfillcolor1}

```ts
bottomFillColor1: string;
```

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

## bottomFillColor2 {#bottomfillcolor2}

```ts
bottomFillColor2: string;
```

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

## topLineColor {#toplinecolor}

```ts
topLineColor: string;
```

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

## bottomLineColor {#bottomlinecolor}

```ts
bottomLineColor: string;
```

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

## baselineColor {#baselinecolor}

```ts
baselineColor: string;
```

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

## topLineWidth {#toplinewidth}

```ts
topLineWidth: number;
```

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

## bottomLineWidth {#bottomlinewidth}

```ts
bottomLineWidth: number;
```

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

## transparency {#transparency}

```ts
transparency: number;
```

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

## baseLevelPercentage {#baselevelpercentage}

```ts
baseLevelPercentage: number;
```

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

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


---

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

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

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

## downColor {#downcolor}

```ts
downColor: string;
```

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

## drawWick {#drawwick}

```ts
drawWick: boolean;
```

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

## drawBorder {#drawborder}

```ts
drawBorder: boolean;
```

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

## drawBody {#drawbody}

```ts
drawBody: boolean;
```

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

## borderColor {#bordercolor}

```ts
borderColor: string;
```

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

## borderUpColor {#borderupcolor}

```ts
borderUpColor: string;
```

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

## borderDownColor {#borderdowncolor}

```ts
borderDownColor: string;
```

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

## wickColor {#wickcolor}

```ts
wickColor: string;
```

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

## wickUpColor {#wickupcolor}

```ts
wickUpColor: string;
```

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

## wickDownColor {#wickdowncolor}

```ts
wickDownColor: string;
```

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

## barColorsOnPrevClose {#barcolorsonprevclose}

```ts
barColorsOnPrevClose: boolean;
```

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

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


---

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

[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.

## disableUndo {#disableundo}

```ts
disableUndo: boolean;
```

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

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


---

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

[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.

```ts
export type ChartActionId =
  | "chartProperties"
  | "compareOrAdd"
  | "scalesProperties"
  | "paneObjectTree"
  | "insertIndicator"
  | "symbolSearch"
  | "changeInterval"
  | "timeScaleReset"
  | "chartReset"
  | "seriesHide"
  | "studyHide"
  | "lineToggleLock"
  | "lineHide"
  | "scaleSeriesOnly"
  | "drawingToolbarAction"
  | "stayInDrawingModeAction"
  | "hideAllMarks"
  | "showCountdown"
  | "showSeriesLastValue"
  | "showSymbolLabelsAction"
  | "showStudyLastValue"
  | "showStudyPlotNamesAction"
  | "undo"
  | "redo"
  | "paneRemoveAllStudiesDrawingTools"
  | "showSymbolInfoDialog";
```

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


---

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

[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.

Chart-level native command families `openAutomation` can install.

```ts
export type ChartAutomationFamily = 'drawings' | 'studies' | 'settings';
```

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


---

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

[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.

Native owners the caller already holds for this chart (for example from
`createDrawingCommands` or `createDrawingDocument`). A supplied owner is used
as-is and is never destroyed by the session; the caller keeps ownership.

## drawings {#drawings}

```ts
drawings?: ChartDrawingApi;
```

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

## studies {#studies}

```ts
studies?: ChartStudyApi;
```

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

## settings {#settings}

```ts
settings?: ChartSettingsApi;
```

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

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


---

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

[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.

## id {#id}

```ts
id: string | undefined;
```

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

## name {#name}

```ts
name: string;
```

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

## symbol {#symbol}

```ts
symbol: string;
```

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

## resolution {#resolution}

```ts
resolution: ResolutionString;
```

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

## content {#content}

```ts
content: string;
```

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

## Related types

- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)

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


---

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

[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.

Host-facing datafeed connection status. Carries no provider error text.

## state {#state}

```ts
readonly state: ChartDatafeedState;
```

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

## retryAttempt {#retryattempt}

```ts
readonly retryAttempt: number;
```

Consecutive failed attempts in the current `reconnecting` or `retrying` run; `0` otherwise.

## Related types

- [ChartDatafeedState](https://docs.lumencharts.com/charting-library/api/ChartDatafeedState)

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


---

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

[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.

Realtime connection state of a chart's datafeed, reported by [IChartWidgetApi.datafeedStatus](https://docs.lumencharts.com/charting-library/api/IChartWidgetApi#datafeedstatus).
`loading-history` also covers the wait for a promise-returning `subscribeBars` to confirm (bounded by
a deadline); `reconnecting` means history stays on screen while the stream is resubscribed with backoff.

```ts
export type ChartDatafeedState = "idle" | "resolving" | "loading-history" | "live" | "reconnecting" | "retrying" | "error" | "disposed";
```

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


---

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

[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.

Main-series data availability reported by [IChartWidgetApi.dataStatus](https://docs.lumencharts.com/charting-library/api/IChartWidgetApi#datastatus).

## state {#state}

```ts
readonly state: "loading" | "ready" | "empty" | "error";
```

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

## message {#message}

```ts
readonly message: string | null;
```

Plain-language reason when `state` is `error`; otherwise `null`.

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


---

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

[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.

## chartType {#charttype}

```ts
chartType: SeriesType;
```

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

## chartTypeName {#charttypename}

```ts
chartTypeName: string;
```

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

## description {#description}

```ts
description?: string;
```

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

## symbol {#symbol}

```ts
symbol: string;
```

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

## exchange {#exchange}

```ts
exchange?: string;
```

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

## ticker {#ticker}

```ts
ticker?: string;
```

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

## visibleRange {#visiblerange}

```ts
visibleRange: VisibleTimeRange;
```

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

## visibleData {#visibledata}

```ts
visibleData?: ExportedData;
```

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

## symbolInfo {#symbolinfo}

```ts
symbolInfo: LibrarySymbolInfo | null;
```

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

## chartIndex {#chartindex}

```ts
chartIndex: number;
```

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

## chartCount {#chartcount}

```ts
chartCount: number;
```

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

## priceFormatter {#priceformatter}

```ts
priceFormatter: ISymbolValueFormatter;
```

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

## interval {#interval}

```ts
interval: ResolutionString;
```

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

## isIntraday {#isintraday}

```ts
isIntraday: boolean;
```

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

## Related types

- [SeriesType](https://docs.lumencharts.com/charting-library/api/SeriesType)
- [VisibleTimeRange](https://docs.lumencharts.com/charting-library/api/VisibleTimeRange)
- [ExportedData](https://docs.lumencharts.com/charting-library/api/ExportedData)
- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)
- [ISymbolValueFormatter](https://docs.lumencharts.com/charting-library/api/ISymbolValueFormatter)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)

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


---

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

[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.

```ts
export type ChartDescriptorFunction = (
  context: ChartDescriptionContext,
) => Promise<string | null>;
```

## Related types

- [ChartDescriptionContext](https://docs.lumencharts.com/charting-library/api/ChartDescriptionContext)

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


---

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

[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.

## id {#id}

```ts
id: number;
```

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

## name {#name}

```ts
name: string;
```

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

## symbol {#symbol}

```ts
symbol: string;
```

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

## resolution {#resolution}

```ts
resolution: ResolutionString;
```

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

## timestamp {#timestamp}

```ts
timestamp: number;
```

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

## Related types

- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)

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


---

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

[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.

## signature {#signature}

```ts
[key: string]: string | number | boolean;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

## timezone {#timezone}

```ts
timezone: TimezoneId;
```

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

## priceScaleSelectionStrategyName {#pricescaleselectionstrategyname}

```ts
priceScaleSelectionStrategyName: "left" | "right" | "auto";
```

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

## paneProperties.backgroundType {#paneproperties-2e-backgroundtype}

```ts
"paneProperties.backgroundType": ColorTypes;
```

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

## paneProperties.background {#paneproperties-2e-background}

```ts
"paneProperties.background": string;
```

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

## paneProperties.backgroundGradientStartColor {#paneproperties-2e-backgroundgradientstartcolor}

```ts
"paneProperties.backgroundGradientStartColor": string;
```

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

## paneProperties.backgroundGradientEndColor {#paneproperties-2e-backgroundgradientendcolor}

```ts
"paneProperties.backgroundGradientEndColor": string;
```

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

## paneProperties.vertGridProperties.color {#paneproperties-2e-vertgridproperties-2e-color}

```ts
"paneProperties.vertGridProperties.color": string;
```

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

## paneProperties.vertGridProperties.style {#paneproperties-2e-vertgridproperties-2e-style}

```ts
"paneProperties.vertGridProperties.style": OverrideLineStyle;
```

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

## paneProperties.horzGridProperties.color {#paneproperties-2e-horzgridproperties-2e-color}

```ts
"paneProperties.horzGridProperties.color": string;
```

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

## paneProperties.horzGridProperties.style {#paneproperties-2e-horzgridproperties-2e-style}

```ts
"paneProperties.horzGridProperties.style": OverrideLineStyle;
```

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

## crossHairProperties.color {#crosshairproperties-2e-color}

```ts
"crossHairProperties.color": string;
```

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

## crossHairProperties.style {#crosshairproperties-2e-style}

```ts
"crossHairProperties.style": OverrideLineStyle;
```

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

## crossHairProperties.transparency {#crosshairproperties-2e-transparency}

```ts
"crossHairProperties.transparency": number;
```

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

## crossHairProperties.width {#crosshairproperties-2e-width}

```ts
"crossHairProperties.width": number;
```

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

## paneProperties.topMargin {#paneproperties-2e-topmargin}

```ts
"paneProperties.topMargin": number;
```

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

## paneProperties.bottomMargin {#paneproperties-2e-bottommargin}

```ts
"paneProperties.bottomMargin": number;
```

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

## paneProperties.separatorColor {#paneproperties-2e-separatorcolor}

```ts
"paneProperties.separatorColor": string;
```

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

## paneProperties.legendProperties.showStudyArguments {#paneproperties-2e-legendproperties-2e-showstudyarguments}

```ts
"paneProperties.legendProperties.showStudyArguments": boolean;
```

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

## paneProperties.legendProperties.showStudyTitles {#paneproperties-2e-legendproperties-2e-showstudytitles}

```ts
"paneProperties.legendProperties.showStudyTitles": boolean;
```

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

## paneProperties.legendProperties.showStudyValues {#paneproperties-2e-legendproperties-2e-showstudyvalues}

```ts
"paneProperties.legendProperties.showStudyValues": boolean;
```

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

## paneProperties.legendProperties.showSeriesTitle {#paneproperties-2e-legendproperties-2e-showseriestitle}

```ts
"paneProperties.legendProperties.showSeriesTitle": boolean;
```

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

## paneProperties.legendProperties.showSeriesOHLC {#paneproperties-2e-legendproperties-2e-showseriesohlc}

```ts
"paneProperties.legendProperties.showSeriesOHLC": boolean;
```

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

## paneProperties.legendProperties.showBarChange {#paneproperties-2e-legendproperties-2e-showbarchange}

```ts
"paneProperties.legendProperties.showBarChange": boolean;
```

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

## paneProperties.legendProperties.showVolume {#paneproperties-2e-legendproperties-2e-showvolume}

```ts
"paneProperties.legendProperties.showVolume": boolean;
```

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

## paneProperties.legendProperties.showBackground {#paneproperties-2e-legendproperties-2e-showbackground}

```ts
"paneProperties.legendProperties.showBackground": boolean;
```

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

## paneProperties.legendProperties.backgroundTransparency {#paneproperties-2e-legendproperties-2e-backgroundtransparency}

```ts
"paneProperties.legendProperties.backgroundTransparency": number;
```

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

## scalesProperties.lineColor {#scalesproperties-2e-linecolor}

```ts
"scalesProperties.lineColor": string;
```

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

## scalesProperties.textColor {#scalesproperties-2e-textcolor}

```ts
"scalesProperties.textColor": string;
```

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

## scalesProperties.fontSize {#scalesproperties-2e-fontsize}

```ts
"scalesProperties.fontSize": number;
```

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

## scalesProperties.showSeriesLastValue {#scalesproperties-2e-showserieslastvalue}

```ts
"scalesProperties.showSeriesLastValue": boolean;
```

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

## scalesProperties.seriesLastValueMode {#scalesproperties-2e-serieslastvaluemode}

```ts
"scalesProperties.seriesLastValueMode": OverridePriceAxisLastValueMode;
```

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

## scalesProperties.showStudyLastValue {#scalesproperties-2e-showstudylastvalue}

```ts
"scalesProperties.showStudyLastValue": boolean;
```

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

## scalesProperties.showSymbolLabels {#scalesproperties-2e-showsymbollabels}

```ts
"scalesProperties.showSymbolLabels": boolean;
```

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

## scalesProperties.showStudyPlotLabels {#scalesproperties-2e-showstudyplotlabels}

```ts
"scalesProperties.showStudyPlotLabels": boolean;
```

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

## scalesProperties.showBidAskLabels {#scalesproperties-2e-showbidasklabels}

```ts
"scalesProperties.showBidAskLabels": boolean;
```

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

## scalesProperties.showPrePostMarketPriceLabel {#scalesproperties-2e-showprepostmarketpricelabel}

```ts
"scalesProperties.showPrePostMarketPriceLabel": boolean;
```

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

## scalesProperties.axisHighlightColor {#scalesproperties-2e-axishighlightcolor}

```ts
"scalesProperties.axisHighlightColor": string;
```

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

## scalesProperties.axisLineToolLabelBackgroundColorCommon {#scalesproperties-2e-axislinetoollabelbackgroundcolorcommon}

```ts
"scalesProperties.axisLineToolLabelBackgroundColorCommon": string;
```

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

## scalesProperties.axisLineToolLabelBackgroundColorActive {#scalesproperties-2e-axislinetoollabelbackgroundcoloractive}

```ts
"scalesProperties.axisLineToolLabelBackgroundColorActive": string;
```

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

## scalesProperties.showPriceScaleCrosshairLabel {#scalesproperties-2e-showpricescalecrosshairlabel}

```ts
"scalesProperties.showPriceScaleCrosshairLabel": boolean;
```

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

## scalesProperties.showTimeScaleCrosshairLabel {#scalesproperties-2e-showtimescalecrosshairlabel}

```ts
"scalesProperties.showTimeScaleCrosshairLabel": boolean;
```

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

## scalesProperties.crosshairLabelBgColorLight {#scalesproperties-2e-crosshairlabelbgcolorlight}

```ts
"scalesProperties.crosshairLabelBgColorLight": string;
```

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

## scalesProperties.crosshairLabelBgColorDark {#scalesproperties-2e-crosshairlabelbgcolordark}

```ts
"scalesProperties.crosshairLabelBgColorDark": string;
```

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

## mainSeriesProperties.style {#mainseriesproperties-2e-style}

```ts
"mainSeriesProperties.style": ChartStyle;
```

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

## mainSeriesProperties.showCountdown {#mainseriesproperties-2e-showcountdown}

```ts
"mainSeriesProperties.showCountdown": boolean;
```

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

## mainSeriesProperties.bidAsk.visible {#mainseriesproperties-2e-bidask-2e-visible}

```ts
"mainSeriesProperties.bidAsk.visible": boolean;
```

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

## mainSeriesProperties.bidAsk.lineStyle {#mainseriesproperties-2e-bidask-2e-linestyle}

```ts
"mainSeriesProperties.bidAsk.lineStyle": OverrideLineStyle;
```

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

## mainSeriesProperties.bidAsk.lineWidth {#mainseriesproperties-2e-bidask-2e-linewidth}

```ts
"mainSeriesProperties.bidAsk.lineWidth": number;
```

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

## mainSeriesProperties.bidAsk.bidLineColor {#mainseriesproperties-2e-bidask-2e-bidlinecolor}

```ts
"mainSeriesProperties.bidAsk.bidLineColor": string;
```

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

## mainSeriesProperties.bidAsk.askLineColor {#mainseriesproperties-2e-bidask-2e-asklinecolor}

```ts
"mainSeriesProperties.bidAsk.askLineColor": string;
```

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

## mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible {#mainseriesproperties-2e-highlowavgprice-2e-highlowpricelinesvisible}

```ts
"mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible": boolean;
```

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

## mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible {#mainseriesproperties-2e-highlowavgprice-2e-highlowpricelabelsvisible}

```ts
"mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible": boolean;
```

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

## mainSeriesProperties.highLowAvgPrice.averageClosePriceLineVisible {#mainseriesproperties-2e-highlowavgprice-2e-averageclosepricelinevisible}

```ts
"mainSeriesProperties.highLowAvgPrice.averageClosePriceLineVisible": boolean;
```

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

## mainSeriesProperties.highLowAvgPrice.averageClosePriceLabelVisible {#mainseriesproperties-2e-highlowavgprice-2e-averageclosepricelabelvisible}

```ts
"mainSeriesProperties.highLowAvgPrice.averageClosePriceLabelVisible": boolean;
```

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

## mainSeriesProperties.highLowAvgPrice.highLowPriceLinesColor {#mainseriesproperties-2e-highlowavgprice-2e-highlowpricelinescolor}

```ts
"mainSeriesProperties.highLowAvgPrice.highLowPriceLinesColor": string;
```

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

## mainSeriesProperties.highLowAvgPrice.highLowPriceLinesWidth {#mainseriesproperties-2e-highlowavgprice-2e-highlowpricelineswidth}

```ts
"mainSeriesProperties.highLowAvgPrice.highLowPriceLinesWidth": number;
```

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

## mainSeriesProperties.highLowAvgPrice.averagePriceLineColor {#mainseriesproperties-2e-highlowavgprice-2e-averagepricelinecolor}

```ts
"mainSeriesProperties.highLowAvgPrice.averagePriceLineColor": string;
```

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

## mainSeriesProperties.highLowAvgPrice.averagePriceLineWidth {#mainseriesproperties-2e-highlowavgprice-2e-averagepricelinewidth}

```ts
"mainSeriesProperties.highLowAvgPrice.averagePriceLineWidth": number;
```

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

## mainSeriesProperties.visible {#mainseriesproperties-2e-visible}

```ts
"mainSeriesProperties.visible": boolean;
```

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

## mainSeriesProperties.sessionId {#mainseriesproperties-2e-sessionid}

```ts
"mainSeriesProperties.sessionId": "regular" | "extended";
```

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

## mainSeriesProperties.showPriceLine {#mainseriesproperties-2e-showpriceline}

```ts
"mainSeriesProperties.showPriceLine": boolean;
```

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

## mainSeriesProperties.priceLineWidth {#mainseriesproperties-2e-pricelinewidth}

```ts
"mainSeriesProperties.priceLineWidth": number;
```

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

## mainSeriesProperties.priceLineColor {#mainseriesproperties-2e-pricelinecolor}

```ts
"mainSeriesProperties.priceLineColor": string;
```

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

## mainSeriesProperties.showPrevClosePriceLine {#mainseriesproperties-2e-showprevclosepriceline}

```ts
"mainSeriesProperties.showPrevClosePriceLine": boolean;
```

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

## mainSeriesProperties.prevClosePriceLineWidth {#mainseriesproperties-2e-prevclosepricelinewidth}

```ts
"mainSeriesProperties.prevClosePriceLineWidth": number;
```

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

## mainSeriesProperties.prevClosePriceLineColor {#mainseriesproperties-2e-prevclosepricelinecolor}

```ts
"mainSeriesProperties.prevClosePriceLineColor": string;
```

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

## mainSeriesProperties.minTick {#mainseriesproperties-2e-mintick}

```ts
"mainSeriesProperties.minTick": string;
```

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

## mainSeriesProperties.statusViewStyle.showExchange {#mainseriesproperties-2e-statusviewstyle-2e-showexchange}

```ts
"mainSeriesProperties.statusViewStyle.showExchange": boolean;
```

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

## mainSeriesProperties.statusViewStyle.showInterval {#mainseriesproperties-2e-statusviewstyle-2e-showinterval}

```ts
"mainSeriesProperties.statusViewStyle.showInterval": boolean;
```

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

## mainSeriesProperties.statusViewStyle.symbolTextSource {#mainseriesproperties-2e-statusviewstyle-2e-symboltextsource}

```ts
"mainSeriesProperties.statusViewStyle.symbolTextSource": SeriesStatusViewSymbolTextSource;
```

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

## mainSeriesProperties.candleStyle.upColor {#mainseriesproperties-2e-candlestyle-2e-upcolor}

```ts
"mainSeriesProperties.candleStyle.upColor": string;
```

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

## mainSeriesProperties.candleStyle.downColor {#mainseriesproperties-2e-candlestyle-2e-downcolor}

```ts
"mainSeriesProperties.candleStyle.downColor": string;
```

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

## mainSeriesProperties.candleStyle.drawWick {#mainseriesproperties-2e-candlestyle-2e-drawwick}

```ts
"mainSeriesProperties.candleStyle.drawWick": boolean;
```

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

## mainSeriesProperties.candleStyle.drawBorder {#mainseriesproperties-2e-candlestyle-2e-drawborder}

```ts
"mainSeriesProperties.candleStyle.drawBorder": boolean;
```

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

## mainSeriesProperties.candleStyle.borderColor {#mainseriesproperties-2e-candlestyle-2e-bordercolor}

```ts
"mainSeriesProperties.candleStyle.borderColor": string;
```

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

## mainSeriesProperties.candleStyle.borderUpColor {#mainseriesproperties-2e-candlestyle-2e-borderupcolor}

```ts
"mainSeriesProperties.candleStyle.borderUpColor": string;
```

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

## mainSeriesProperties.candleStyle.borderDownColor {#mainseriesproperties-2e-candlestyle-2e-borderdowncolor}

```ts
"mainSeriesProperties.candleStyle.borderDownColor": string;
```

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

## mainSeriesProperties.candleStyle.wickColor {#mainseriesproperties-2e-candlestyle-2e-wickcolor}

```ts
"mainSeriesProperties.candleStyle.wickColor": string;
```

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

## mainSeriesProperties.candleStyle.wickUpColor {#mainseriesproperties-2e-candlestyle-2e-wickupcolor}

```ts
"mainSeriesProperties.candleStyle.wickUpColor": string;
```

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

## mainSeriesProperties.candleStyle.wickDownColor {#mainseriesproperties-2e-candlestyle-2e-wickdowncolor}

```ts
"mainSeriesProperties.candleStyle.wickDownColor": string;
```

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

## mainSeriesProperties.candleStyle.barColorsOnPrevClose {#mainseriesproperties-2e-candlestyle-2e-barcolorsonprevclose}

```ts
"mainSeriesProperties.candleStyle.barColorsOnPrevClose": boolean;
```

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

## mainSeriesProperties.candleStyle.drawBody {#mainseriesproperties-2e-candlestyle-2e-drawbody}

```ts
"mainSeriesProperties.candleStyle.drawBody": boolean;
```

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

## mainSeriesProperties.hollowCandleStyle.upColor {#mainseriesproperties-2e-hollowcandlestyle-2e-upcolor}

```ts
"mainSeriesProperties.hollowCandleStyle.upColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.downColor {#mainseriesproperties-2e-hollowcandlestyle-2e-downcolor}

```ts
"mainSeriesProperties.hollowCandleStyle.downColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.drawWick {#mainseriesproperties-2e-hollowcandlestyle-2e-drawwick}

```ts
"mainSeriesProperties.hollowCandleStyle.drawWick": boolean;
```

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

## mainSeriesProperties.hollowCandleStyle.drawBorder {#mainseriesproperties-2e-hollowcandlestyle-2e-drawborder}

```ts
"mainSeriesProperties.hollowCandleStyle.drawBorder": boolean;
```

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

## mainSeriesProperties.hollowCandleStyle.borderColor {#mainseriesproperties-2e-hollowcandlestyle-2e-bordercolor}

```ts
"mainSeriesProperties.hollowCandleStyle.borderColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.borderUpColor {#mainseriesproperties-2e-hollowcandlestyle-2e-borderupcolor}

```ts
"mainSeriesProperties.hollowCandleStyle.borderUpColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.borderDownColor {#mainseriesproperties-2e-hollowcandlestyle-2e-borderdowncolor}

```ts
"mainSeriesProperties.hollowCandleStyle.borderDownColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.wickColor {#mainseriesproperties-2e-hollowcandlestyle-2e-wickcolor}

```ts
"mainSeriesProperties.hollowCandleStyle.wickColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.wickUpColor {#mainseriesproperties-2e-hollowcandlestyle-2e-wickupcolor}

```ts
"mainSeriesProperties.hollowCandleStyle.wickUpColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.wickDownColor {#mainseriesproperties-2e-hollowcandlestyle-2e-wickdowncolor}

```ts
"mainSeriesProperties.hollowCandleStyle.wickDownColor": string;
```

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

## mainSeriesProperties.hollowCandleStyle.drawBody {#mainseriesproperties-2e-hollowcandlestyle-2e-drawbody}

```ts
"mainSeriesProperties.hollowCandleStyle.drawBody": boolean;
```

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

## mainSeriesProperties.haStyle.upColor {#mainseriesproperties-2e-hastyle-2e-upcolor}

```ts
"mainSeriesProperties.haStyle.upColor": string;
```

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

## mainSeriesProperties.haStyle.downColor {#mainseriesproperties-2e-hastyle-2e-downcolor}

```ts
"mainSeriesProperties.haStyle.downColor": string;
```

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

## mainSeriesProperties.haStyle.drawWick {#mainseriesproperties-2e-hastyle-2e-drawwick}

```ts
"mainSeriesProperties.haStyle.drawWick": boolean;
```

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

## mainSeriesProperties.haStyle.drawBorder {#mainseriesproperties-2e-hastyle-2e-drawborder}

```ts
"mainSeriesProperties.haStyle.drawBorder": boolean;
```

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

## mainSeriesProperties.haStyle.borderColor {#mainseriesproperties-2e-hastyle-2e-bordercolor}

```ts
"mainSeriesProperties.haStyle.borderColor": string;
```

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

## mainSeriesProperties.haStyle.borderUpColor {#mainseriesproperties-2e-hastyle-2e-borderupcolor}

```ts
"mainSeriesProperties.haStyle.borderUpColor": string;
```

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

## mainSeriesProperties.haStyle.borderDownColor {#mainseriesproperties-2e-hastyle-2e-borderdowncolor}

```ts
"mainSeriesProperties.haStyle.borderDownColor": string;
```

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

## mainSeriesProperties.haStyle.wickColor {#mainseriesproperties-2e-hastyle-2e-wickcolor}

```ts
"mainSeriesProperties.haStyle.wickColor": string;
```

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

## mainSeriesProperties.haStyle.wickUpColor {#mainseriesproperties-2e-hastyle-2e-wickupcolor}

```ts
"mainSeriesProperties.haStyle.wickUpColor": string;
```

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

## mainSeriesProperties.haStyle.wickDownColor {#mainseriesproperties-2e-hastyle-2e-wickdowncolor}

```ts
"mainSeriesProperties.haStyle.wickDownColor": string;
```

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

## mainSeriesProperties.haStyle.barColorsOnPrevClose {#mainseriesproperties-2e-hastyle-2e-barcolorsonprevclose}

```ts
"mainSeriesProperties.haStyle.barColorsOnPrevClose": boolean;
```

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

## mainSeriesProperties.haStyle.drawBody {#mainseriesproperties-2e-hastyle-2e-drawbody}

```ts
"mainSeriesProperties.haStyle.drawBody": boolean;
```

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

## mainSeriesProperties.barStyle.upColor {#mainseriesproperties-2e-barstyle-2e-upcolor}

```ts
"mainSeriesProperties.barStyle.upColor": string;
```

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

## mainSeriesProperties.barStyle.downColor {#mainseriesproperties-2e-barstyle-2e-downcolor}

```ts
"mainSeriesProperties.barStyle.downColor": string;
```

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

## mainSeriesProperties.barStyle.barColorsOnPrevClose {#mainseriesproperties-2e-barstyle-2e-barcolorsonprevclose}

```ts
"mainSeriesProperties.barStyle.barColorsOnPrevClose": boolean;
```

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

## mainSeriesProperties.barStyle.dontDrawOpen {#mainseriesproperties-2e-barstyle-2e-dontdrawopen}

```ts
"mainSeriesProperties.barStyle.dontDrawOpen": boolean;
```

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

## mainSeriesProperties.barStyle.thinBars {#mainseriesproperties-2e-barstyle-2e-thinbars}

```ts
"mainSeriesProperties.barStyle.thinBars": boolean;
```

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

## mainSeriesProperties.hiloStyle.color {#mainseriesproperties-2e-hilostyle-2e-color}

```ts
"mainSeriesProperties.hiloStyle.color": string;
```

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

## mainSeriesProperties.hiloStyle.showBorders {#mainseriesproperties-2e-hilostyle-2e-showborders}

```ts
"mainSeriesProperties.hiloStyle.showBorders": boolean;
```

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

## mainSeriesProperties.hiloStyle.borderColor {#mainseriesproperties-2e-hilostyle-2e-bordercolor}

```ts
"mainSeriesProperties.hiloStyle.borderColor": string;
```

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

## mainSeriesProperties.hiloStyle.showLabels {#mainseriesproperties-2e-hilostyle-2e-showlabels}

```ts
"mainSeriesProperties.hiloStyle.showLabels": boolean;
```

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

## mainSeriesProperties.hiloStyle.labelColor {#mainseriesproperties-2e-hilostyle-2e-labelcolor}

```ts
"mainSeriesProperties.hiloStyle.labelColor": string;
```

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

## mainSeriesProperties.columnStyle.upColor {#mainseriesproperties-2e-columnstyle-2e-upcolor}

```ts
"mainSeriesProperties.columnStyle.upColor": string;
```

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

## mainSeriesProperties.columnStyle.downColor {#mainseriesproperties-2e-columnstyle-2e-downcolor}

```ts
"mainSeriesProperties.columnStyle.downColor": string;
```

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

## mainSeriesProperties.columnStyle.barColorsOnPrevClose {#mainseriesproperties-2e-columnstyle-2e-barcolorsonprevclose}

```ts
"mainSeriesProperties.columnStyle.barColorsOnPrevClose": boolean;
```

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

## mainSeriesProperties.columnStyle.priceSource {#mainseriesproperties-2e-columnstyle-2e-pricesource}

```ts
"mainSeriesProperties.columnStyle.priceSource": PriceSource;
```

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

## mainSeriesProperties.lineStyle.color {#mainseriesproperties-2e-linestyle-2e-color}

```ts
"mainSeriesProperties.lineStyle.color": string;
```

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

## mainSeriesProperties.lineStyle.linestyle {#mainseriesproperties-2e-linestyle-2e-linestyle}

```ts
"mainSeriesProperties.lineStyle.linestyle": OverrideLineStyle;
```

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

## mainSeriesProperties.lineStyle.linewidth {#mainseriesproperties-2e-linestyle-2e-linewidth}

```ts
"mainSeriesProperties.lineStyle.linewidth": number;
```

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

## mainSeriesProperties.lineStyle.priceSource {#mainseriesproperties-2e-linestyle-2e-pricesource}

```ts
"mainSeriesProperties.lineStyle.priceSource": PriceSource;
```

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

## mainSeriesProperties.areaStyle.color1 {#mainseriesproperties-2e-areastyle-2e-color1}

```ts
"mainSeriesProperties.areaStyle.color1": string;
```

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

## mainSeriesProperties.areaStyle.color2 {#mainseriesproperties-2e-areastyle-2e-color2}

```ts
"mainSeriesProperties.areaStyle.color2": string;
```

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

## mainSeriesProperties.areaStyle.linecolor {#mainseriesproperties-2e-areastyle-2e-linecolor}

```ts
"mainSeriesProperties.areaStyle.linecolor": string;
```

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

## mainSeriesProperties.areaStyle.linestyle {#mainseriesproperties-2e-areastyle-2e-linestyle}

```ts
"mainSeriesProperties.areaStyle.linestyle": OverrideLineStyle;
```

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

## mainSeriesProperties.areaStyle.linewidth {#mainseriesproperties-2e-areastyle-2e-linewidth}

```ts
"mainSeriesProperties.areaStyle.linewidth": number;
```

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

## mainSeriesProperties.areaStyle.priceSource {#mainseriesproperties-2e-areastyle-2e-pricesource}

```ts
"mainSeriesProperties.areaStyle.priceSource": PriceSource;
```

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

## mainSeriesProperties.areaStyle.transparency {#mainseriesproperties-2e-areastyle-2e-transparency}

```ts
"mainSeriesProperties.areaStyle.transparency": number;
```

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

## mainSeriesProperties.hlcAreaStyle.closeLineColor {#mainseriesproperties-2e-hlcareastyle-2e-closelinecolor}

```ts
"mainSeriesProperties.hlcAreaStyle.closeLineColor": string;
```

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

## mainSeriesProperties.hlcAreaStyle.closeLineStyle {#mainseriesproperties-2e-hlcareastyle-2e-closelinestyle}

```ts
"mainSeriesProperties.hlcAreaStyle.closeLineStyle": OverrideLineStyle;
```

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

## mainSeriesProperties.hlcAreaStyle.closeLineWidth {#mainseriesproperties-2e-hlcareastyle-2e-closelinewidth}

```ts
"mainSeriesProperties.hlcAreaStyle.closeLineWidth": number;
```

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

## mainSeriesProperties.hlcAreaStyle.closeLowFillColor {#mainseriesproperties-2e-hlcareastyle-2e-closelowfillcolor}

```ts
"mainSeriesProperties.hlcAreaStyle.closeLowFillColor": string;
```

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

## mainSeriesProperties.hlcAreaStyle.highCloseFillColor {#mainseriesproperties-2e-hlcareastyle-2e-highclosefillcolor}

```ts
"mainSeriesProperties.hlcAreaStyle.highCloseFillColor": string;
```

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

## mainSeriesProperties.hlcAreaStyle.highLineColor {#mainseriesproperties-2e-hlcareastyle-2e-highlinecolor}

```ts
"mainSeriesProperties.hlcAreaStyle.highLineColor": string;
```

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

## mainSeriesProperties.hlcAreaStyle.highLineStyle {#mainseriesproperties-2e-hlcareastyle-2e-highlinestyle}

```ts
"mainSeriesProperties.hlcAreaStyle.highLineStyle": OverrideLineStyle;
```

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

## mainSeriesProperties.hlcAreaStyle.highLineWidth {#mainseriesproperties-2e-hlcareastyle-2e-highlinewidth}

```ts
"mainSeriesProperties.hlcAreaStyle.highLineWidth": number;
```

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

## mainSeriesProperties.hlcAreaStyle.lowLineColor {#mainseriesproperties-2e-hlcareastyle-2e-lowlinecolor}

```ts
"mainSeriesProperties.hlcAreaStyle.lowLineColor": string;
```

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

## mainSeriesProperties.hlcAreaStyle.lowLineStyle {#mainseriesproperties-2e-hlcareastyle-2e-lowlinestyle}

```ts
"mainSeriesProperties.hlcAreaStyle.lowLineStyle": OverrideLineStyle;
```

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

## mainSeriesProperties.hlcAreaStyle.lowLineWidth {#mainseriesproperties-2e-hlcareastyle-2e-lowlinewidth}

```ts
"mainSeriesProperties.hlcAreaStyle.lowLineWidth": number;
```

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

## mainSeriesProperties.priceAxisProperties.percentage {#mainseriesproperties-2e-priceaxisproperties-2e-percentage}

```ts
"mainSeriesProperties.priceAxisProperties.percentage": boolean;
```

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

## mainSeriesProperties.priceAxisProperties.indexedTo100 {#mainseriesproperties-2e-priceaxisproperties-2e-indexedto100}

```ts
"mainSeriesProperties.priceAxisProperties.indexedTo100": boolean;
```

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

## mainSeriesProperties.priceAxisProperties.log {#mainseriesproperties-2e-priceaxisproperties-2e-log}

```ts
"mainSeriesProperties.priceAxisProperties.log": boolean;
```

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

## mainSeriesProperties.priceAxisProperties.isInverted {#mainseriesproperties-2e-priceaxisproperties-2e-isinverted}

```ts
"mainSeriesProperties.priceAxisProperties.isInverted": boolean;
```

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

## mainSeriesProperties.priceAxisProperties.alignLabels {#mainseriesproperties-2e-priceaxisproperties-2e-alignlabels}

```ts
"mainSeriesProperties.priceAxisProperties.alignLabels": boolean;
```

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

## mainSeriesProperties.renkoStyle.upColor {#mainseriesproperties-2e-renkostyle-2e-upcolor}

```ts
"mainSeriesProperties.renkoStyle.upColor": string;
```

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

## mainSeriesProperties.renkoStyle.downColor {#mainseriesproperties-2e-renkostyle-2e-downcolor}

```ts
"mainSeriesProperties.renkoStyle.downColor": string;
```

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

## mainSeriesProperties.renkoStyle.borderUpColor {#mainseriesproperties-2e-renkostyle-2e-borderupcolor}

```ts
"mainSeriesProperties.renkoStyle.borderUpColor": string;
```

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

## mainSeriesProperties.renkoStyle.borderDownColor {#mainseriesproperties-2e-renkostyle-2e-borderdowncolor}

```ts
"mainSeriesProperties.renkoStyle.borderDownColor": string;
```

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

## mainSeriesProperties.renkoStyle.upColorProjection {#mainseriesproperties-2e-renkostyle-2e-upcolorprojection}

```ts
"mainSeriesProperties.renkoStyle.upColorProjection": string;
```

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

## mainSeriesProperties.renkoStyle.downColorProjection {#mainseriesproperties-2e-renkostyle-2e-downcolorprojection}

```ts
"mainSeriesProperties.renkoStyle.downColorProjection": string;
```

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

## mainSeriesProperties.renkoStyle.borderUpColorProjection {#mainseriesproperties-2e-renkostyle-2e-borderupcolorprojection}

```ts
"mainSeriesProperties.renkoStyle.borderUpColorProjection": string;
```

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

## mainSeriesProperties.renkoStyle.borderDownColorProjection {#mainseriesproperties-2e-renkostyle-2e-borderdowncolorprojection}

```ts
"mainSeriesProperties.renkoStyle.borderDownColorProjection": string;
```

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

## mainSeriesProperties.renkoStyle.wickUpColor {#mainseriesproperties-2e-renkostyle-2e-wickupcolor}

```ts
"mainSeriesProperties.renkoStyle.wickUpColor": string;
```

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

## mainSeriesProperties.renkoStyle.wickDownColor {#mainseriesproperties-2e-renkostyle-2e-wickdowncolor}

```ts
"mainSeriesProperties.renkoStyle.wickDownColor": string;
```

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

## mainSeriesProperties.pbStyle.upColor {#mainseriesproperties-2e-pbstyle-2e-upcolor}

```ts
"mainSeriesProperties.pbStyle.upColor": string;
```

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

## mainSeriesProperties.pbStyle.downColor {#mainseriesproperties-2e-pbstyle-2e-downcolor}

```ts
"mainSeriesProperties.pbStyle.downColor": string;
```

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

## mainSeriesProperties.pbStyle.borderUpColor {#mainseriesproperties-2e-pbstyle-2e-borderupcolor}

```ts
"mainSeriesProperties.pbStyle.borderUpColor": string;
```

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

## mainSeriesProperties.pbStyle.borderDownColor {#mainseriesproperties-2e-pbstyle-2e-borderdowncolor}

```ts
"mainSeriesProperties.pbStyle.borderDownColor": string;
```

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

## mainSeriesProperties.pbStyle.upColorProjection {#mainseriesproperties-2e-pbstyle-2e-upcolorprojection}

```ts
"mainSeriesProperties.pbStyle.upColorProjection": string;
```

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

## mainSeriesProperties.pbStyle.downColorProjection {#mainseriesproperties-2e-pbstyle-2e-downcolorprojection}

```ts
"mainSeriesProperties.pbStyle.downColorProjection": string;
```

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

## mainSeriesProperties.pbStyle.borderUpColorProjection {#mainseriesproperties-2e-pbstyle-2e-borderupcolorprojection}

```ts
"mainSeriesProperties.pbStyle.borderUpColorProjection": string;
```

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

## mainSeriesProperties.pbStyle.borderDownColorProjection {#mainseriesproperties-2e-pbstyle-2e-borderdowncolorprojection}

```ts
"mainSeriesProperties.pbStyle.borderDownColorProjection": string;
```

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

## mainSeriesProperties.kagiStyle.upColor {#mainseriesproperties-2e-kagistyle-2e-upcolor}

```ts
"mainSeriesProperties.kagiStyle.upColor": string;
```

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

## mainSeriesProperties.kagiStyle.downColor {#mainseriesproperties-2e-kagistyle-2e-downcolor}

```ts
"mainSeriesProperties.kagiStyle.downColor": string;
```

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

## mainSeriesProperties.kagiStyle.upColorProjection {#mainseriesproperties-2e-kagistyle-2e-upcolorprojection}

```ts
"mainSeriesProperties.kagiStyle.upColorProjection": string;
```

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

## mainSeriesProperties.kagiStyle.downColorProjection {#mainseriesproperties-2e-kagistyle-2e-downcolorprojection}

```ts
"mainSeriesProperties.kagiStyle.downColorProjection": string;
```

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

## mainSeriesProperties.pnfStyle.upColor {#mainseriesproperties-2e-pnfstyle-2e-upcolor}

```ts
"mainSeriesProperties.pnfStyle.upColor": string;
```

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

## mainSeriesProperties.pnfStyle.downColor {#mainseriesproperties-2e-pnfstyle-2e-downcolor}

```ts
"mainSeriesProperties.pnfStyle.downColor": string;
```

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

## mainSeriesProperties.pnfStyle.upColorProjection {#mainseriesproperties-2e-pnfstyle-2e-upcolorprojection}

```ts
"mainSeriesProperties.pnfStyle.upColorProjection": string;
```

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

## mainSeriesProperties.pnfStyle.downColorProjection {#mainseriesproperties-2e-pnfstyle-2e-downcolorprojection}

```ts
"mainSeriesProperties.pnfStyle.downColorProjection": string;
```

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

## mainSeriesProperties.baselineStyle.baselineColor {#mainseriesproperties-2e-baselinestyle-2e-baselinecolor}

```ts
"mainSeriesProperties.baselineStyle.baselineColor": string;
```

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

## mainSeriesProperties.baselineStyle.topFillColor1 {#mainseriesproperties-2e-baselinestyle-2e-topfillcolor1}

```ts
"mainSeriesProperties.baselineStyle.topFillColor1": string;
```

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

## mainSeriesProperties.baselineStyle.topFillColor2 {#mainseriesproperties-2e-baselinestyle-2e-topfillcolor2}

```ts
"mainSeriesProperties.baselineStyle.topFillColor2": string;
```

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

## mainSeriesProperties.baselineStyle.bottomFillColor1 {#mainseriesproperties-2e-baselinestyle-2e-bottomfillcolor1}

```ts
"mainSeriesProperties.baselineStyle.bottomFillColor1": string;
```

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

## mainSeriesProperties.baselineStyle.bottomFillColor2 {#mainseriesproperties-2e-baselinestyle-2e-bottomfillcolor2}

```ts
"mainSeriesProperties.baselineStyle.bottomFillColor2": string;
```

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

## mainSeriesProperties.baselineStyle.topLineColor {#mainseriesproperties-2e-baselinestyle-2e-toplinecolor}

```ts
"mainSeriesProperties.baselineStyle.topLineColor": string;
```

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

## mainSeriesProperties.baselineStyle.bottomLineColor {#mainseriesproperties-2e-baselinestyle-2e-bottomlinecolor}

```ts
"mainSeriesProperties.baselineStyle.bottomLineColor": string;
```

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

## mainSeriesProperties.baselineStyle.topLineWidth {#mainseriesproperties-2e-baselinestyle-2e-toplinewidth}

```ts
"mainSeriesProperties.baselineStyle.topLineWidth": number;
```

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

## mainSeriesProperties.baselineStyle.bottomLineWidth {#mainseriesproperties-2e-baselinestyle-2e-bottomlinewidth}

```ts
"mainSeriesProperties.baselineStyle.bottomLineWidth": number;
```

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

## mainSeriesProperties.baselineStyle.priceSource {#mainseriesproperties-2e-baselinestyle-2e-pricesource}

```ts
"mainSeriesProperties.baselineStyle.priceSource": PriceSource;
```

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

## mainSeriesProperties.baselineStyle.transparency {#mainseriesproperties-2e-baselinestyle-2e-transparency}

```ts
"mainSeriesProperties.baselineStyle.transparency": number;
```

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

## mainSeriesProperties.baselineStyle.baseLevelPercentage {#mainseriesproperties-2e-baselinestyle-2e-baselevelpercentage}

```ts
"mainSeriesProperties.baselineStyle.baseLevelPercentage": number;
```

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

## mainSeriesProperties.lineWithMarkersStyle.color {#mainseriesproperties-2e-linewithmarkersstyle-2e-color}

```ts
"mainSeriesProperties.lineWithMarkersStyle.color": string;
```

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

## mainSeriesProperties.lineWithMarkersStyle.linestyle {#mainseriesproperties-2e-linewithmarkersstyle-2e-linestyle}

```ts
"mainSeriesProperties.lineWithMarkersStyle.linestyle": OverrideLineStyle;
```

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

## mainSeriesProperties.lineWithMarkersStyle.linewidth {#mainseriesproperties-2e-linewithmarkersstyle-2e-linewidth}

```ts
"mainSeriesProperties.lineWithMarkersStyle.linewidth": number;
```

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

## mainSeriesProperties.lineWithMarkersStyle.priceSource {#mainseriesproperties-2e-linewithmarkersstyle-2e-pricesource}

```ts
"mainSeriesProperties.lineWithMarkersStyle.priceSource": string;
```

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

## Related types

- [TimezoneId](https://docs.lumencharts.com/charting-library/api/TimezoneId)
- [ColorTypes](https://docs.lumencharts.com/charting-library/api/ColorTypes)
- [OverrideLineStyle](https://docs.lumencharts.com/charting-library/api/OverrideLineStyle)
- [OverridePriceAxisLastValueMode](https://docs.lumencharts.com/charting-library/api/OverridePriceAxisLastValueMode)
- [ChartStyle](https://docs.lumencharts.com/charting-library/api/ChartStyle)
- [SeriesStatusViewSymbolTextSource](https://docs.lumencharts.com/charting-library/api/SeriesStatusViewSymbolTextSource)
- [PriceSource](https://docs.lumencharts.com/charting-library/api/PriceSource)

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


---

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

[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.

```ts
export declare const enum ChartStyle {
  Bar = 0,
  Candle = 1,
  Line = 2,
  Area = 3,
  Renko = 4,
  Kagi = 5,
  PnF = 6,
  LineBreak = 7,
  HeikinAshi = 8,
  HollowCandle = 9,
  Baseline = 10,
  HiLo = 12,
  Column = 13,
  LineWithMarkers = 14,
  Stepline = 15,
  HLCArea = 16,
  
  VolumeFootprint = 17,
}
```

- `VolumeFootprint`: **Beta.** The volume footprint chart type. Requires the `chart_style_volume_footprint` feature.

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


---

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

[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.

## content {#content}

```ts
content?: ChartTemplateContent;
```

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

## Related types

- [ChartTemplateContent](https://docs.lumencharts.com/charting-library/api/ChartTemplateContent)

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


---

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

[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.

## signature {#signature}

```ts
[key: string]: any;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

## chartProperties {#chartproperties}

```ts
chartProperties?: {
    paneProperties: any;
    scalesProperties: any;
  };
```

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

## mainSourceProperties {#mainsourceproperties}

```ts
mainSourceProperties?: any;
```

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

## version {#version}

```ts
version?: number;
```

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

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


---

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

[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.

```ts
export type ChartTypeFavorites =
  | "Area"
  | "Bars"
  | "Candles"
  | "Heiken Ashi"
  | "Hollow Candles"
  | "Line"
  | "Line Break"
  | "Baseline"
  | "LineWithMarkers"
  | "Stepline"
  | "Columns"
  | "High-low";
```

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


---

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

[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.

```ts
export declare const enum ClearMarksMode {
  All = 0,
  BarMarks = 1,
  TimeScaleMarks = 2,
}
```

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


---

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

[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.

## backgroundColor {#backgroundcolor}

```ts
backgroundColor: string;
```

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

## borderColor {#bordercolor}

```ts
borderColor: string;
```

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

## font {#font}

```ts
font: string;
```

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

## fontSize {#fontsize}

```ts
fontSize: number;
```

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

## legendMode {#legendmode}

```ts
legendMode: LegendMode;
```

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

## hideResolution {#hideresolution}

```ts
hideResolution: boolean;
```

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

## Related types

- [LegendMode](https://docs.lumencharts.com/charting-library/api/LegendMode)

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


---

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

[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.

```ts
export type ColorTypes = "solid" | "gradient";
```

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


---

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

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

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

## downColor {#downcolor}

```ts
downColor: string;
```

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

## barColorsOnPrevClose {#barcolorsonprevclose}

```ts
barColorsOnPrevClose: boolean;
```

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

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


---

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

[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.

## symbol {#symbol}

```ts
symbol: string;
```

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

## title {#title}

```ts
title: string;
```

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

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


---

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

[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.

## position {#position}

```ts
position: "top" | "bottom";
```

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

## text {#text}

```ts
text: string;
```

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

## click {#click}

```ts
click: EmptyCallback;
```

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

## Related types

- [EmptyCallback](https://docs.lumencharts.com/charting-library/api/EmptyCallback)

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


---

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

[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.

```ts
export type ContextMenuItemsProcessor = (
  items: readonly IActionVariant[],
  actionsFactory: ActionsFactory,
  params: CreateContextMenuParams,
) => Promise<readonly IActionVariant[]>;
```

## Related types

- [IActionVariant](https://docs.lumencharts.com/charting-library/api/IActionVariant)
- [ActionsFactory](https://docs.lumencharts.com/charting-library/api/ActionsFactory)
- [CreateContextMenuParams](https://docs.lumencharts.com/charting-library/api/CreateContextMenuParams)

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


---

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

[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.

## items_processor {#items_processor}

```ts
items_processor?: ContextMenuItemsProcessor;
```

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

## renderer_factory {#renderer_factory}

```ts
renderer_factory?: ContextMenuRendererFactory;
```

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

## Related types

- [ContextMenuItemsProcessor](https://docs.lumencharts.com/charting-library/api/ContextMenuItemsProcessor)
- [ContextMenuRendererFactory](https://docs.lumencharts.com/charting-library/api/ContextMenuRendererFactory)

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


---

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

[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.

## clientX {#clientx}

```ts
clientX: number;
```

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

## clientY {#clienty}

```ts
clientY: number;
```

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

## touches {#touches}

```ts
touches?: readonly {
    clientX: number;
    clientY: number;
  }[];
```

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

## attachToXBy {#attachtoxby}

```ts
attachToXBy?: "left" | "right" | "auto";
```

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

## attachToYBy {#attachtoyby}

```ts
attachToYBy?: "auto" | "auto-strict" | "top" | "bottom";
```

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

## box {#box}

```ts
box?: {
    x: number;
    y: number;
    w: number;
    h: number;
    overlapX?: boolean;
  };
```

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

## marginX {#marginx}

```ts
marginX?: number;
```

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

## marginY {#marginy}

```ts
marginY?: number;
```

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

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


---

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

[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.

```ts
export type ContextMenuRendererFactory = (
  items: readonly IActionVariant[],
  params: CreateContextMenuParams,
  onDestroy: () => void,
) => Promise<IContextMenuRenderer | null>;
```

## Related types

- [IActionVariant](https://docs.lumencharts.com/charting-library/api/IActionVariant)
- [CreateContextMenuParams](https://docs.lumencharts.com/charting-library/api/CreateContextMenuParams)
- [IContextMenuRenderer](https://docs.lumencharts.com/charting-library/api/IContextMenuRenderer)

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


---

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

[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.

## Extends

[CreateShapeOptionsBase](https://docs.lumencharts.com/charting-library/api/CreateShapeOptionsBase)

## shape {#shape}

```ts
shape: "anchored_text" | "anchored_note";
```

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

## Related types

- [CreateShapeOptionsBase](https://docs.lumencharts.com/charting-library/api/CreateShapeOptionsBase)

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


---

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

[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.

```ts
export type CreateButtonOptions =
  CreateHTMLButtonOptions | CreateChartUiStyledButtonOptions;
```

## Related types

- [CreateHTMLButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateHTMLButtonOptions)
- [CreateChartUiStyledButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateChartUiStyledButtonOptions)

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


---

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

[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.

## align {#align}

```ts
align: "left" | "right";
```

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

## useChartUiStyle {#usechartuistyle}

```ts
useChartUiStyle: true;
```

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

## text {#text}

```ts
text: string;
```

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

## title {#title}

```ts
title?: string;
```

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

## onClick {#onclick}

```ts
onClick?: () => void;
```

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

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


---

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

[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.

## menuName {#menuname}

```ts
menuName: string;
```

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

## detail {#detail}

```ts
detail?:
    | {
        type: "series";
        id: string;
      }
    | {
        type: "study";
        id: string | null;
      }
    | {
        type: "shape";
        id: number | string | null;
      }
    | {
        type: "groupOfShapes";
        id: string | null;
      }
    | {
        type: "position";
        id: string | null;
      }
    | {
        type: "order";
        id: string | null;
      };
```

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

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


---

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

[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.

## align {#align}

```ts
align: "left" | "right";
```

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

## useChartUiStyle {#usechartuistyle}

```ts
useChartUiStyle: false;
```

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

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


---

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

[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.

## Extends

[CreateShapeOptionsBase](https://docs.lumencharts.com/charting-library/api/CreateShapeOptionsBase)

## shape {#shape}

```ts
shape?: Exclude<
    SupportedLineTools,
    "cursor" | "dot" | "arrow_cursor" | "eraser" | "measure" | "zoom"
  >;
```

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

## Related types

- [CreateShapeOptionsBase](https://docs.lumencharts.com/charting-library/api/CreateShapeOptionsBase)
- [SupportedLineTools](https://docs.lumencharts.com/charting-library/api/SupportedLineTools)

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


---

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

[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.

## Extends

[CreateShapeOptionsBase](https://docs.lumencharts.com/charting-library/api/CreateShapeOptionsBase)

## shape {#shape}

```ts
shape?:
    | "arrow_up"
    | "arrow_down"
    | "flag"
    | "vertical_line"
    | "horizontal_line"
    | "long_position"
    | "short_position"
    | "icon"
    | "emoji"
    | "sticker"
    | "anchored_text"
    | "anchored_note";
```

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

## ownerStudyId {#ownerstudyid}

```ts
ownerStudyId?: EntityId;
```

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

## Related types

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

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


---

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

[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.

## text {#text}

```ts
text?: string;
```

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

## lock {#lock}

```ts
lock?: boolean;
```

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

## disableSelection {#disableselection}

```ts
disableSelection?: boolean;
```

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

## disableSave {#disablesave}

```ts
disableSave?: boolean;
```

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

## disableUndo {#disableundo}

```ts
disableUndo?: boolean;
```

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

## overrides {#overrides}

```ts
overrides?: TOverrides;
```

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

## zOrder {#zorder}

```ts
zOrder?: "top" | "bottom";
```

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

## showInObjectsTree {#showinobjectstree}

```ts
showInObjectsTree?: boolean;
```

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

## ownerStudyId {#ownerstudyid}

```ts
ownerStudyId?: EntityId;
```

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

## filled {#filled}

```ts
filled?: boolean;
```

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

## icon {#icon}

```ts
icon?: number;
```

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

## Related types

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

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


---

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

[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.

## checkLimit {#checklimit}

```ts
checkLimit?: boolean;
```

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

## priceScale {#pricescale}

```ts
priceScale?: StudyPriceScale;
```

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

## allowChangeCurrency {#allowchangecurrency}

```ts
allowChangeCurrency?: boolean;
```

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

## allowChangeUnit {#allowchangeunit}

```ts
allowChangeUnit?: boolean;
```

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

## disableUndo {#disableundo}

```ts
disableUndo?: boolean;
```

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

## Related types

- [StudyPriceScale](https://docs.lumencharts.com/charting-library/api/StudyPriceScale)

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


---

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

[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.

## saveSymbol {#savesymbol}

```ts
saveSymbol?: boolean;
```

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

## saveInterval {#saveinterval}

```ts
saveInterval?: boolean;
```

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

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


---

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

[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.

## time {#time}

```ts
time: number;
```

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

## price {#price}

```ts
price: number;
```

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

## entityValues {#entityvalues}

```ts
entityValues?: Record<EntityId, CrossHairMovedEventSource>;
```

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

## offsetX {#offsetx}

```ts
offsetX?: number;
```

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

## offsetY {#offsety}

```ts
offsetY?: number;
```

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

## Related types

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

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


---

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

[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.

## isHovered {#ishovered}

```ts
isHovered: boolean;
```

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

## title {#title}

```ts
title: string;
```

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

## values {#values}

```ts
values: CrossHairMovedEventSourceValue[];
```

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

## Related types

- [CrossHairMovedEventSourceValue](https://docs.lumencharts.com/charting-library/api/CrossHairMovedEventSourceValue)

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


---

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

[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.

## title {#title}

```ts
title: string;
```

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

## value {#value}

```ts
value: string;
```

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

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


---

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

[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.

## selectedCurrency {#selectedcurrency}

```ts
selectedCurrency: PriceScaleSelectedCurrency;
```

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

## currencies {#currencies}

```ts
currencies: string[];
```

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

## Related types

- [PriceScaleSelectedCurrency](https://docs.lumencharts.com/charting-library/api/PriceScaleSelectedCurrency)

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


---

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

[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.

## id {#id}

```ts
id: string;
```

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

## code {#code}

```ts
code: string;
```

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

## logoUrl {#logourl}

```ts
logoUrl?: string;
```

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

## description {#description}

```ts
description?: string;
```

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

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


---

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

[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.

## Extends

[CustomTimezoneInfo](https://docs.lumencharts.com/charting-library/api/CustomTimezoneInfo)

## id {#id}

```ts
id: CustomTimezoneId;
```

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

## Related types

- [CustomTimezoneInfo](https://docs.lumencharts.com/charting-library/api/CustomTimezoneInfo)
- [CustomTimezoneId](https://docs.lumencharts.com/charting-library/api/CustomTimezoneId)

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


---

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

[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.

## format {#format}

```ts
format(date: Date): string;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `date` | `Date` | Yes |

## formatLocal {#formatlocal}

```ts
formatLocal(date: Date): string;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `date` | `Date` | Yes |

## parse {#parse}

```ts
parse(value: string): string;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

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


---

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

[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.

## timeFormatter {#timeformatter}

```ts
timeFormatter?: CustomFormatter;
```

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

## dateFormatter {#dateformatter}

```ts
dateFormatter?: CustomFormatter;
```

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

## tickMarkFormatter {#tickmarkformatter}

```ts
tickMarkFormatter?: (date: Date, tickMarkType: TickMarkType) => string;
```

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

## priceFormatterFactory {#priceformatterfactory}

```ts
priceFormatterFactory?: SeriesFormatterFactory;
```

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

## studyFormatterFactory {#studyformatterfactory}

```ts
studyFormatterFactory?: CustomStudyFormatterFactory;
```

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

## Related types

- [CustomFormatter](https://docs.lumencharts.com/charting-library/api/CustomFormatter)
- [TickMarkType](https://docs.lumencharts.com/charting-library/api/TickMarkType)
- [SeriesFormatterFactory](https://docs.lumencharts.com/charting-library/api/SeriesFormatterFactory)
- [CustomStudyFormatterFactory](https://docs.lumencharts.com/charting-library/api/CustomStudyFormatterFactory)

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


---

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

[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.

## name {#name}

```ts
readonly name: string;
```

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

## metainfo {#metainfo}

```ts
readonly metainfo: StudyMetaInfo;
```

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

## constructor {#constructor}

```ts
readonly constructor:
    | LibraryPineStudyConstructor<IPineStudyResult>
    | ((this: LibraryPineStudy<IPineStudyResult>) => void);
```

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

## Related types

- [StudyMetaInfo](https://docs.lumencharts.com/charting-library/api/StudyMetaInfo)
- [LibraryPineStudyConstructor](https://docs.lumencharts.com/charting-library/api/LibraryPineStudyConstructor)
- [IPineStudyResult](https://docs.lumencharts.com/charting-library/api/IPineStudyResult)
- [LibraryPineStudy](https://docs.lumencharts.com/charting-library/api/LibraryPineStudy)

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


---

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

[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.

## text {#text}

```ts
text: string;
```

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

## tooltip {#tooltip}

```ts
tooltip?: string;
```

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

## onClick {#onclick}

```ts
onClick: () => void;
```

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

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


---

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

[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.

## title {#title}

```ts
title: string;
```

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

## color {#color}

```ts
color?: string;
```

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

## icon {#icon}

```ts
icon?: string;
```

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

## content {#content}

```ts
content: string[];
```

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

## action {#action}

```ts
action?: CustomStatusDropDownAction;
```

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

## Related types

- [CustomStatusDropDownAction](https://docs.lumencharts.com/charting-library/api/CustomStatusDropDownAction)

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


---

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

[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.

```ts
export type CustomStudyFormatter = Omit<INumberFormatter, "parse">;
```

## Related types

- [INumberFormatter](https://docs.lumencharts.com/charting-library/api/INumberFormatter)

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


---

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

[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.

```ts
export type CustomStudyFormatterFactory = (
  format: CustomStudyFormatterFormat,
  symbolInfo: LibrarySymbolInfo | null,
  precision: string | undefined,
) => CustomStudyFormatter | null;
```

## Related types

- [CustomStudyFormatterFormat](https://docs.lumencharts.com/charting-library/api/CustomStudyFormatterFormat)
- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)
- [CustomStudyFormatter](https://docs.lumencharts.com/charting-library/api/CustomStudyFormatter)

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


---

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

[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.

## type {#type}

```ts
type: "price" | "volume" | "percent" | "inherit";
```

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

## precision {#precision}

```ts
precision?: number;
```

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

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


---

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

[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.

```ts
export type CustomTimezoneId = Nominal<"CustomTimezoneId", string>;
```

## Related types

- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)

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


---

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

[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.

## alias {#alias}

```ts
alias: TimezoneId | GmtTimezoneId;
```

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

## title {#title}

```ts
title: string;
```

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

## Related types

- [TimezoneId](https://docs.lumencharts.com/charting-library/api/TimezoneId)
- [GmtTimezoneId](https://docs.lumencharts.com/charting-library/api/GmtTimezoneId)

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


---

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

[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.

```ts
export type CustomTimezones =
  | "Africa/Cairo"
  | "Africa/Casablanca"
  | "Africa/Johannesburg"
  | "Africa/Lagos"
  | "Africa/Nairobi"
  | "Africa/Tunis"
  | "America/Anchorage"
  | "America/Argentina/Buenos_Aires"
  | "America/Bogota"
  | "America/Caracas"
  | "America/Chicago"
  | "America/El_Salvador"
  | "America/Juneau"
  | "America/Lima"
  | "America/Los_Angeles"
  | "America/Mexico_City"
  | "America/New_York"
  | "America/Phoenix"
  | "America/Santiago"
  | "America/Sao_Paulo"
  | "America/Toronto"
  | "America/Vancouver"
  | "Asia/Almaty"
  | "Asia/Ashkhabad"
  | "Asia/Bahrain"
  | "Asia/Bangkok"
  | "Asia/Chongqing"
  | "Asia/Colombo"
  | "Asia/Dhaka"
  | "Asia/Dubai"
  | "Asia/Ho_Chi_Minh"
  | "Asia/Hong_Kong"
  | "Asia/Jakarta"
  | "Asia/Jerusalem"
  | "Asia/Karachi"
  | "Asia/Kathmandu"
  | "Asia/Kolkata"
  | "Asia/Kuwait"
  | "Asia/Manila"
  | "Asia/Muscat"
  | "Asia/Nicosia"
  | "Asia/Qatar"
  | "Asia/Riyadh"
  | "Asia/Seoul"
  | "Asia/Shanghai"
  | "Asia/Singapore"
  | "Asia/Taipei"
  | "Asia/Tehran"
  | "Asia/Tokyo"
  | "Asia/Yangon"
  | "Atlantic/Reykjavik"
  | "Australia/Adelaide"
  | "Australia/Brisbane"
  | "Australia/Perth"
  | "Australia/Sydney"
  | "Europe/Amsterdam"
  | "Europe/Athens"
  | "Europe/Belgrade"
  | "Europe/Berlin"
  | "Europe/Bratislava"
  | "Europe/Brussels"
  | "Europe/Bucharest"
  | "Europe/Budapest"
  | "Europe/Copenhagen"
  | "Europe/Dublin"
  | "Europe/Helsinki"
  | "Europe/Istanbul"
  | "Europe/Lisbon"
  | "Europe/London"
  | "Europe/Luxembourg"
  | "Europe/Madrid"
  | "Europe/Malta"
  | "Europe/Moscow"
  | "Europe/Oslo"
  | "Europe/Paris"
  | "Europe/Prague"
  | "Europe/Riga"
  | "Europe/Rome"
  | "Europe/Stockholm"
  | "Europe/Tallinn"
  | "Europe/Vienna"
  | "Europe/Vilnius"
  | "Europe/Warsaw"
  | "Europe/Zurich"
  | "Pacific/Auckland"
  | "Pacific/Chatham"
  | "Pacific/Fakaofo"
  | "Pacific/Honolulu"
  | "Pacific/Norfolk"
  | "US/Mountain";
```

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


---

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

[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.

```ts
export type CustomTranslateFunction = (
  key: string,
  options?: CustomTranslateOptions,
  isTranslated?: boolean,
) => string | null;
```

## Related types

- [CustomTranslateOptions](https://docs.lumencharts.com/charting-library/api/CustomTranslateOptions)

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


---

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

[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.

## plural {#plural}

```ts
plural?: string | string[];
```

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

## count {#count}

```ts
count?: number;
```

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

## context {#context}

```ts
context?: string;
```

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

## replace {#replace}

```ts
replace?: Record<string, string>;
```

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

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


---

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

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

## exchanges {#exchanges}

```ts
exchanges?: Exchange[];
```

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

## supported_resolutions {#supported_resolutions}

```ts
supported_resolutions?: ResolutionString[];
```

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

## units {#units}

```ts
units?: Record<string, Unit[]>;
```

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

## currency_codes {#currency_codes}

```ts
currency_codes?: (string | CurrencyItem)[];
```

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

## supports_marks {#supports_marks}

```ts
supports_marks?: boolean;
```

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

## supports_time {#supports_time}

```ts
supports_time?: boolean;
```

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

## supports_timescale_marks {#supports_timescale_marks}

```ts
supports_timescale_marks?: boolean;
```

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

## symbols_types {#symbols_types}

```ts
symbols_types?: DatafeedSymbolType[];
```

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

## symbols_grouping {#symbols_grouping}

```ts
symbols_grouping?: Record<string, string>;
```

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

## Related types

- [Exchange](https://docs.lumencharts.com/charting-library/api/Exchange)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [Unit](https://docs.lumencharts.com/charting-library/api/Unit)
- [CurrencyItem](https://docs.lumencharts.com/charting-library/api/CurrencyItem)
- [DatafeedSymbolType](https://docs.lumencharts.com/charting-library/api/DatafeedSymbolType)

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


---

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

[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.

## ch {#ch}

```ts
ch?: number;
```

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

## chp {#chp}

```ts
chp?: number;
```

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

## short_name {#short_name}

```ts
short_name?: string;
```

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

## exchange {#exchange}

```ts
exchange?: string;
```

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

## description {#description}

```ts
description?: string;
```

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

## lp {#lp}

```ts
lp?: number;
```

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

## ask {#ask}

```ts
ask?: number;
```

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

## bid {#bid}

```ts
bid?: number;
```

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

## spread {#spread}

```ts
spread?: number;
```

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

## open_price {#open_price}

```ts
open_price?: number;
```

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

## high_price {#high_price}

```ts
high_price?: number;
```

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

## low_price {#low_price}

```ts
low_price?: number;
```

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

## prev_close_price {#prev_close_price}

```ts
prev_close_price?: number;
```

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

## volume {#volume}

```ts
volume?: number;
```

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

## original_name {#original_name}

```ts
original_name?: string;
```

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

## signature {#signature}

```ts
[valueName: string]: string | number | string[] | number[] | undefined;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `valueName` | `string` | Yes |

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


---

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

[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.

## name {#name}

```ts
name: string;
```

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

## value {#value}

```ts
value: string;
```

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

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


---

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

[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.

```ts
export type DateFormat = keyof typeof dateFormatFunctions;
```

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


---

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

[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.

```ts
declare type DeepPartial<T> = {
  [P in keyof T]?: T[P] extends (infer U)[]
    ? DeepPartial<U>[]
    : T[P] extends readonly (infer X)[]
      ? readonly DeepPartial<X>[]
      : DeepPartial<T[P]>;
};
```

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


---

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

[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.

```ts
export type DeepWriteable<T> = {
  -readonly [P in keyof T]: DeepWriteable<T[P]>;
};
```

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


---

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

[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.

## title {#title}

```ts
title: string;
```

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

## body {#body}

```ts
body: string;
```

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

## callback {#callback}

```ts
callback: CallbackType;
```

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

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


---

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

[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.

```ts
export type Direction = "buy" | "sell";
```

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


---

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

[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.

```ts
export type DOMCallback = (data: DOMData) => void;
```

## Related types

- [DOMData](https://docs.lumencharts.com/charting-library/api/DOMData)

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


---

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

[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.

## snapshot {#snapshot}

```ts
snapshot: boolean;
```

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

## asks {#asks}

```ts
asks: DOMLevel[];
```

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

## bids {#bids}

```ts
bids: DOMLevel[];
```

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

## Related types

- [DOMLevel](https://docs.lumencharts.com/charting-library/api/DOMLevel)

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


---

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

[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.

## price {#price}

```ts
price: number;
```

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

## volume {#volume}

```ts
volume: number;
```

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

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


---

<!-- Public documentation export; not library implementation source. -->
# Drawing tool overrides

[Integration guide](https://docs.lumencharts.com/charting-library/drawings/catalog) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Default style properties for each drawing tool, with their types and default values. They are part of [WidgetOverrides](https://docs.lumencharts.com/charting-library/api/WidgetOverrides), so set them in the widget `overrides` option to change how new drawings look. Find a tool by its public name in the [drawing catalog](https://docs.lumencharts.com/charting-library/drawings/catalog). Legacy product-specific keys are not a promise of implementation.

## AbcdLineToolOverrides {#abcdlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolabcd.bold` | `boolean` |  |
| `linetoolabcd.color` | `string` |  |
| `linetoolabcd.fontsize` | `number` |  |
| `linetoolabcd.italic` | `boolean` |  |
| `linetoolabcd.linewidth` | `number` |  |
| `linetoolabcd.textcolor` | `string` |  |

## AnchoredvwapLineToolOverrides {#anchoredvwaplinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolanchoredvwap.inputs.source` | `string` |  |
| `linetoolanchoredvwap.inputs.start_time` | `number` |  |
| `linetoolanchoredvwap.precision` | `string` |  |
| `linetoolanchoredvwap.styles.VWAP.color` | `string` |  |
| `linetoolanchoredvwap.styles.VWAP.display` | `number` |  |
| `linetoolanchoredvwap.styles.VWAP.linestyle` | `number` |  |
| `linetoolanchoredvwap.styles.VWAP.linewidth` | `number` |  |
| `linetoolanchoredvwap.styles.VWAP.plottype` | `number` |  |
| `linetoolanchoredvwap.styles.VWAP.trackPrice` | `boolean` |  |
| `linetoolanchoredvwap.styles.VWAP.transparency` | `number` |  |

## ArcLineToolOverrides {#arclinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolarc.backgroundColor` | `string` |  |
| `linetoolarc.color` | `string` |  |
| `linetoolarc.fillBackground` | `boolean` |  |
| `linetoolarc.linewidth` | `number` |  |
| `linetoolarc.transparency` | `number` |  |

## ArrowLineToolOverrides {#arrowlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolarrow.alwaysShowStats` | `boolean` |  |
| `linetoolarrow.bold` | `boolean` |  |
| `linetoolarrow.extendLeft` | `boolean` |  |
| `linetoolarrow.extendRight` | `boolean` |  |
| `linetoolarrow.fontsize` | `number` |  |
| `linetoolarrow.horzLabelsAlign` | `string` |  |
| `linetoolarrow.italic` | `boolean` |  |
| `linetoolarrow.leftEnd` | `number` |  |
| `linetoolarrow.linecolor` | `string` |  |
| `linetoolarrow.linestyle` | `number` |  |
| `linetoolarrow.linewidth` | `number` |  |
| `linetoolarrow.rightEnd` | `number` |  |
| `linetoolarrow.showAngle` | `boolean` |  |
| `linetoolarrow.showBarsRange` | `boolean` |  |
| `linetoolarrow.showDateTimeRange` | `boolean` |  |
| `linetoolarrow.showDistance` | `boolean` |  |
| `linetoolarrow.showLabel` | `boolean` |  |
| `linetoolarrow.showMiddlePoint` | `boolean` |  |
| `linetoolarrow.showPercentPriceRange` | `boolean` |  |
| `linetoolarrow.showPipsPriceRange` | `boolean` |  |
| `linetoolarrow.showPriceLabels` | `boolean` |  |
| `linetoolarrow.showPriceRange` | `boolean` |  |
| `linetoolarrow.statsPosition` | `number` |  |
| `linetoolarrow.textcolor` | `string` |  |
| `linetoolarrow.vertLabelsAlign` | `string` |  |

## ArrowmarkdownLineToolOverrides {#arrowmarkdownlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolarrowmarkdown.arrowColor` | `string` |  |
| `linetoolarrowmarkdown.bold` | `boolean` |  |
| `linetoolarrowmarkdown.color` | `string` |  |
| `linetoolarrowmarkdown.fontsize` | `number` |  |
| `linetoolarrowmarkdown.italic` | `boolean` |  |
| `linetoolarrowmarkdown.showLabel` | `boolean` |  |

## ArrowmarkerLineToolOverrides {#arrowmarkerlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolarrowmarker.backgroundColor` | `string` |  |
| `linetoolarrowmarker.bold` | `boolean` |  |
| `linetoolarrowmarker.fontsize` | `number` |  |
| `linetoolarrowmarker.italic` | `boolean` |  |
| `linetoolarrowmarker.showLabel` | `boolean` |  |
| `linetoolarrowmarker.textColor` | `string` |  |

## ArrowmarkleftLineToolOverrides {#arrowmarkleftlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolarrowmarkleft.arrowColor` | `string` |  |
| `linetoolarrowmarkleft.bold` | `boolean` |  |
| `linetoolarrowmarkleft.color` | `string` |  |
| `linetoolarrowmarkleft.fontsize` | `number` |  |
| `linetoolarrowmarkleft.italic` | `boolean` |  |
| `linetoolarrowmarkleft.showLabel` | `boolean` |  |

## ArrowmarkrightLineToolOverrides {#arrowmarkrightlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolarrowmarkright.arrowColor` | `string` |  |
| `linetoolarrowmarkright.bold` | `boolean` |  |
| `linetoolarrowmarkright.color` | `string` |  |
| `linetoolarrowmarkright.fontsize` | `number` |  |
| `linetoolarrowmarkright.italic` | `boolean` |  |
| `linetoolarrowmarkright.showLabel` | `boolean` |  |

## ArrowmarkupLineToolOverrides {#arrowmarkuplinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolarrowmarkup.arrowColor` | `string` |  |
| `linetoolarrowmarkup.bold` | `boolean` |  |
| `linetoolarrowmarkup.color` | `string` |  |
| `linetoolarrowmarkup.fontsize` | `number` |  |
| `linetoolarrowmarkup.italic` | `boolean` |  |
| `linetoolarrowmarkup.showLabel` | `boolean` |  |

## BalloonLineToolOverrides {#balloonlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolballoon.backgroundColor` | `string` |  |
| `linetoolballoon.borderColor` | `string` |  |
| `linetoolballoon.color` | `string` |  |
| `linetoolballoon.fontsize` | `number` |  |
| `linetoolballoon.transparency` | `number` |  |

## BarspatternLineToolOverrides {#barspatternlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolbarspattern.color` | `string` |  |
| `linetoolbarspattern.flipped` | `boolean` |  |
| `linetoolbarspattern.mirrored` | `boolean` |  |
| `linetoolbarspattern.mode` | `number` |  |

## BeziercubicLineToolOverrides {#beziercubiclinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolbeziercubic.backgroundColor` | `string` |  |
| `linetoolbeziercubic.extendLeft` | `boolean` |  |
| `linetoolbeziercubic.extendRight` | `boolean` |  |
| `linetoolbeziercubic.fillBackground` | `boolean` |  |
| `linetoolbeziercubic.leftEnd` | `number` |  |
| `linetoolbeziercubic.linecolor` | `string` |  |
| `linetoolbeziercubic.linestyle` | `number` |  |
| `linetoolbeziercubic.linewidth` | `number` |  |
| `linetoolbeziercubic.rightEnd` | `number` |  |
| `linetoolbeziercubic.transparency` | `number` |  |

## BezierquadroLineToolOverrides {#bezierquadrolinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolbezierquadro.backgroundColor` | `string` |  |
| `linetoolbezierquadro.extendLeft` | `boolean` |  |
| `linetoolbezierquadro.extendRight` | `boolean` |  |
| `linetoolbezierquadro.fillBackground` | `boolean` |  |
| `linetoolbezierquadro.leftEnd` | `number` |  |
| `linetoolbezierquadro.linecolor` | `string` |  |
| `linetoolbezierquadro.linestyle` | `number` |  |
| `linetoolbezierquadro.linewidth` | `number` |  |
| `linetoolbezierquadro.rightEnd` | `number` |  |
| `linetoolbezierquadro.transparency` | `number` |  |

## BrushLineToolOverrides {#brushlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolbrush.backgroundColor` | `string` |  |
| `linetoolbrush.fillBackground` | `boolean` |  |
| `linetoolbrush.leftEnd` | `number` |  |
| `linetoolbrush.linecolor` | `string` |  |
| `linetoolbrush.linestyle` | `number` |  |
| `linetoolbrush.linewidth` | `number` |  |
| `linetoolbrush.rightEnd` | `number` |  |
| `linetoolbrush.smooth` | `number` |  |
| `linetoolbrush.transparency` | `number` |  |

## CalloutLineToolOverrides {#calloutlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolcallout.backgroundColor` | `string` |  |
| `linetoolcallout.bold` | `boolean` |  |
| `linetoolcallout.bordercolor` | `string` |  |
| `linetoolcallout.color` | `string` |  |
| `linetoolcallout.fontsize` | `number` |  |
| `linetoolcallout.italic` | `boolean` |  |
| `linetoolcallout.linewidth` | `number` |  |
| `linetoolcallout.transparency` | `number` |  |
| `linetoolcallout.wordWrap` | `boolean` |  |
| `linetoolcallout.wordWrapWidth` | `number` |  |

## CircleLineToolOverrides {#circlelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolcircle.backgroundColor` | `string` |  |
| `linetoolcircle.bold` | `boolean` |  |
| `linetoolcircle.color` | `string` |  |
| `linetoolcircle.fillBackground` | `boolean` |  |
| `linetoolcircle.fontSize` | `number` |  |
| `linetoolcircle.italic` | `boolean` |  |
| `linetoolcircle.linewidth` | `number` |  |
| `linetoolcircle.showLabel` | `boolean` |  |
| `linetoolcircle.textColor` | `string` |  |

## CommentLineToolOverrides {#commentlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolcomment.backgroundColor` | `string` |  |
| `linetoolcomment.borderColor` | `string` |  |
| `linetoolcomment.color` | `string` |  |
| `linetoolcomment.fontsize` | `number` |  |
| `linetoolcomment.transparency` | `number` |  |

## CrosslineLineToolOverrides {#crosslinelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolcrossline.linecolor` | `string` |  |
| `linetoolcrossline.linestyle` | `number` |  |
| `linetoolcrossline.linewidth` | `number` |  |
| `linetoolcrossline.showPrice` | `boolean` |  |
| `linetoolcrossline.showTime` | `boolean` |  |

## CypherpatternLineToolOverrides {#cypherpatternlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolcypherpattern.backgroundColor` | `string` |  |
| `linetoolcypherpattern.bold` | `boolean` |  |
| `linetoolcypherpattern.color` | `string` |  |
| `linetoolcypherpattern.fillBackground` | `boolean` |  |
| `linetoolcypherpattern.fontsize` | `number` |  |
| `linetoolcypherpattern.italic` | `boolean` |  |
| `linetoolcypherpattern.linewidth` | `number` |  |
| `linetoolcypherpattern.textcolor` | `string` |  |
| `linetoolcypherpattern.transparency` | `number` |  |

## DisjointangleLineToolOverrides {#disjointanglelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooldisjointangle.backgroundColor` | `string` |  |
| `linetooldisjointangle.bold` | `boolean` |  |
| `linetooldisjointangle.extendLeft` | `boolean` |  |
| `linetooldisjointangle.extendRight` | `boolean` |  |
| `linetooldisjointangle.fillBackground` | `boolean` |  |
| `linetooldisjointangle.fontsize` | `number` |  |
| `linetooldisjointangle.italic` | `boolean` |  |
| `linetooldisjointangle.labelBold` | `boolean` |  |
| `linetooldisjointangle.labelFontSize` | `number` |  |
| `linetooldisjointangle.labelHorzAlign` | `string` |  |
| `linetooldisjointangle.labelItalic` | `boolean` |  |
| `linetooldisjointangle.labelTextColor` | `string` |  |
| `linetooldisjointangle.labelVertAlign` | `string` |  |
| `linetooldisjointangle.labelVisible` | `boolean` |  |
| `linetooldisjointangle.leftEnd` | `number` |  |
| `linetooldisjointangle.linecolor` | `string` |  |
| `linetooldisjointangle.linestyle` | `number` |  |
| `linetooldisjointangle.linewidth` | `number` |  |
| `linetooldisjointangle.rightEnd` | `number` |  |
| `linetooldisjointangle.showBarsRange` | `boolean` |  |
| `linetooldisjointangle.showDateTimeRange` | `boolean` |  |
| `linetooldisjointangle.showPriceRange` | `boolean` |  |
| `linetooldisjointangle.showPrices` | `boolean` |  |
| `linetooldisjointangle.textcolor` | `string` |  |
| `linetooldisjointangle.transparency` | `number` |  |

## ElliottcorrectionLineToolOverrides {#elliottcorrectionlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolelliottcorrection.color` | `string` |  |
| `linetoolelliottcorrection.degree` | `number` |  |
| `linetoolelliottcorrection.linewidth` | `number` |  |
| `linetoolelliottcorrection.showWave` | `boolean` |  |

## ElliottdoublecomboLineToolOverrides {#elliottdoublecombolinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolelliottdoublecombo.color` | `string` |  |
| `linetoolelliottdoublecombo.degree` | `number` |  |
| `linetoolelliottdoublecombo.linewidth` | `number` |  |
| `linetoolelliottdoublecombo.showWave` | `boolean` |  |

## ElliottimpulseLineToolOverrides {#elliottimpulselinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolelliottimpulse.color` | `string` |  |
| `linetoolelliottimpulse.degree` | `number` |  |
| `linetoolelliottimpulse.linewidth` | `number` |  |
| `linetoolelliottimpulse.showWave` | `boolean` |  |

## ElliotttriangleLineToolOverrides {#elliotttrianglelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolelliotttriangle.color` | `string` |  |
| `linetoolelliotttriangle.degree` | `number` |  |
| `linetoolelliotttriangle.linewidth` | `number` |  |
| `linetoolelliotttriangle.showWave` | `boolean` |  |

## ElliotttriplecomboLineToolOverrides {#elliotttriplecombolinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolelliotttriplecombo.color` | `string` |  |
| `linetoolelliotttriplecombo.degree` | `number` |  |
| `linetoolelliotttriplecombo.linewidth` | `number` |  |
| `linetoolelliotttriplecombo.showWave` | `boolean` |  |

## EllipseLineToolOverrides {#ellipselinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolellipse.backgroundColor` | `string` |  |
| `linetoolellipse.bold` | `boolean` |  |
| `linetoolellipse.color` | `string` |  |
| `linetoolellipse.fillBackground` | `boolean` |  |
| `linetoolellipse.fontSize` | `number` |  |
| `linetoolellipse.italic` | `boolean` |  |
| `linetoolellipse.linewidth` | `number` |  |
| `linetoolellipse.showLabel` | `boolean` |  |
| `linetoolellipse.textColor` | `string` |  |
| `linetoolellipse.transparency` | `number` |  |

## EmojiLineToolOverrides {#emojilinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolemoji.angle` | `number` |  |
| `linetoolemoji.emoji` | `string` |  |
| `linetoolemoji.size` | `number` |  |

## ExecutionLineToolOverrides {#executionlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolexecution.arrowBuyColor` | `string` |  |
| `linetoolexecution.arrowHeight` | `number` |  |
| `linetoolexecution.arrowSellColor` | `string` |  |
| `linetoolexecution.arrowSpacing` | `number` |  |
| `linetoolexecution.direction` | `string` |  |
| `linetoolexecution.fontBold` | `boolean` |  |
| `linetoolexecution.fontFamily` | `string` |  |
| `linetoolexecution.fontItalic` | `boolean` |  |
| `linetoolexecution.fontSize` | `number` |  |
| `linetoolexecution.text` | `string` |  |
| `linetoolexecution.textColor` | `string` |  |
| `linetoolexecution.textTransparency` | `number` |  |
| `linetoolexecution.tooltip` | `string` |  |

## ExtendedLineToolOverrides {#extendedlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolextended.alwaysShowStats` | `boolean` |  |
| `linetoolextended.bold` | `boolean` |  |
| `linetoolextended.extendLeft` | `boolean` |  |
| `linetoolextended.extendRight` | `boolean` |  |
| `linetoolextended.fontsize` | `number` |  |
| `linetoolextended.horzLabelsAlign` | `string` |  |
| `linetoolextended.italic` | `boolean` |  |
| `linetoolextended.leftEnd` | `number` |  |
| `linetoolextended.linecolor` | `string` |  |
| `linetoolextended.linestyle` | `number` |  |
| `linetoolextended.linewidth` | `number` |  |
| `linetoolextended.rightEnd` | `number` |  |
| `linetoolextended.showAngle` | `boolean` |  |
| `linetoolextended.showBarsRange` | `boolean` |  |
| `linetoolextended.showDateTimeRange` | `boolean` |  |
| `linetoolextended.showDistance` | `boolean` |  |
| `linetoolextended.showLabel` | `boolean` |  |
| `linetoolextended.showMiddlePoint` | `boolean` |  |
| `linetoolextended.showPercentPriceRange` | `boolean` |  |
| `linetoolextended.showPipsPriceRange` | `boolean` |  |
| `linetoolextended.showPriceLabels` | `boolean` |  |
| `linetoolextended.showPriceRange` | `boolean` |  |
| `linetoolextended.statsPosition` | `number` |  |
| `linetoolextended.textcolor` | `string` |  |
| `linetoolextended.vertLabelsAlign` | `string` |  |

## FibchannelLineToolOverrides {#fibchannellinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolfibchannel.coeffsAsPercents` | `boolean` |  |
| `linetoolfibchannel.extendLeft` | `boolean` |  |
| `linetoolfibchannel.extendRight` | `boolean` |  |
| `linetoolfibchannel.fillBackground` | `boolean` |  |
| `linetoolfibchannel.horzLabelsAlign` | `string` |  |
| `linetoolfibchannel.labelFontSize` | `number` |  |
| `linetoolfibchannel.level1.coeff` | `number` |  |
| `linetoolfibchannel.level1.color` | `string` |  |
| `linetoolfibchannel.level1.visible` | `boolean` |  |
| `linetoolfibchannel.level10.coeff` | `number` |  |
| `linetoolfibchannel.level10.color` | `string` |  |
| `linetoolfibchannel.level10.visible` | `boolean` |  |
| `linetoolfibchannel.level11.coeff` | `number` |  |
| `linetoolfibchannel.level11.color` | `string` |  |
| `linetoolfibchannel.level11.visible` | `boolean` |  |
| `linetoolfibchannel.level12.coeff` | `number` |  |
| `linetoolfibchannel.level12.color` | `string` |  |
| `linetoolfibchannel.level12.visible` | `boolean` |  |
| `linetoolfibchannel.level13.coeff` | `number` |  |
| `linetoolfibchannel.level13.color` | `string` |  |
| `linetoolfibchannel.level13.visible` | `boolean` |  |
| `linetoolfibchannel.level14.coeff` | `number` |  |
| `linetoolfibchannel.level14.color` | `string` |  |
| `linetoolfibchannel.level14.visible` | `boolean` |  |
| `linetoolfibchannel.level15.coeff` | `number` |  |
| `linetoolfibchannel.level15.color` | `string` |  |
| `linetoolfibchannel.level15.visible` | `boolean` |  |
| `linetoolfibchannel.level16.coeff` | `number` |  |
| `linetoolfibchannel.level16.color` | `string` |  |
| `linetoolfibchannel.level16.visible` | `boolean` |  |
| `linetoolfibchannel.level17.coeff` | `number` |  |
| `linetoolfibchannel.level17.color` | `string` |  |
| `linetoolfibchannel.level17.visible` | `boolean` |  |
| `linetoolfibchannel.level18.coeff` | `number` |  |
| `linetoolfibchannel.level18.color` | `string` |  |
| `linetoolfibchannel.level18.visible` | `boolean` |  |
| `linetoolfibchannel.level19.coeff` | `number` |  |
| `linetoolfibchannel.level19.color` | `string` |  |
| `linetoolfibchannel.level19.visible` | `boolean` |  |
| `linetoolfibchannel.level2.coeff` | `number` |  |
| `linetoolfibchannel.level2.color` | `string` |  |
| `linetoolfibchannel.level2.visible` | `boolean` |  |
| `linetoolfibchannel.level20.coeff` | `number` |  |
| `linetoolfibchannel.level20.color` | `string` |  |
| `linetoolfibchannel.level20.visible` | `boolean` |  |
| `linetoolfibchannel.level21.coeff` | `number` |  |
| `linetoolfibchannel.level21.color` | `string` |  |
| `linetoolfibchannel.level21.visible` | `boolean` |  |
| `linetoolfibchannel.level22.coeff` | `number` |  |
| `linetoolfibchannel.level22.color` | `string` |  |
| `linetoolfibchannel.level22.visible` | `boolean` |  |
| `linetoolfibchannel.level23.coeff` | `number` |  |
| `linetoolfibchannel.level23.color` | `string` |  |
| `linetoolfibchannel.level23.visible` | `boolean` |  |
| `linetoolfibchannel.level24.coeff` | `number` |  |
| `linetoolfibchannel.level24.color` | `string` |  |
| `linetoolfibchannel.level24.visible` | `boolean` |  |
| `linetoolfibchannel.level3.coeff` | `number` |  |
| `linetoolfibchannel.level3.color` | `string` |  |
| `linetoolfibchannel.level3.visible` | `boolean` |  |
| `linetoolfibchannel.level4.coeff` | `number` |  |
| `linetoolfibchannel.level4.color` | `string` |  |
| `linetoolfibchannel.level4.visible` | `boolean` |  |
| `linetoolfibchannel.level5.coeff` | `number` |  |
| `linetoolfibchannel.level5.color` | `string` |  |
| `linetoolfibchannel.level5.visible` | `boolean` |  |
| `linetoolfibchannel.level6.coeff` | `number` |  |
| `linetoolfibchannel.level6.color` | `string` |  |
| `linetoolfibchannel.level6.visible` | `boolean` |  |
| `linetoolfibchannel.level7.coeff` | `number` |  |
| `linetoolfibchannel.level7.color` | `string` |  |
| `linetoolfibchannel.level7.visible` | `boolean` |  |
| `linetoolfibchannel.level8.coeff` | `number` |  |
| `linetoolfibchannel.level8.color` | `string` |  |
| `linetoolfibchannel.level8.visible` | `boolean` |  |
| `linetoolfibchannel.level9.coeff` | `number` |  |
| `linetoolfibchannel.level9.color` | `string` |  |
| `linetoolfibchannel.level9.visible` | `boolean` |  |
| `linetoolfibchannel.levelsStyle.linestyle` | `number` |  |
| `linetoolfibchannel.levelsStyle.linewidth` | `number` |  |
| `linetoolfibchannel.showCoeffs` | `boolean` |  |
| `linetoolfibchannel.showPrices` | `boolean` |  |
| `linetoolfibchannel.transparency` | `number` |  |
| `linetoolfibchannel.vertLabelsAlign` | `string` |  |

## FibcirclesLineToolOverrides {#fibcircleslinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolfibcircles.coeffsAsPercents` | `boolean` |  |
| `linetoolfibcircles.fillBackground` | `boolean` |  |
| `linetoolfibcircles.level1.coeff` | `number` |  |
| `linetoolfibcircles.level1.color` | `string` |  |
| `linetoolfibcircles.level1.linestyle` | `number` |  |
| `linetoolfibcircles.level1.linewidth` | `number` |  |
| `linetoolfibcircles.level1.visible` | `boolean` |  |
| `linetoolfibcircles.level10.coeff` | `number` |  |
| `linetoolfibcircles.level10.color` | `string` |  |
| `linetoolfibcircles.level10.linestyle` | `number` |  |
| `linetoolfibcircles.level10.linewidth` | `number` |  |
| `linetoolfibcircles.level10.visible` | `boolean` |  |
| `linetoolfibcircles.level11.coeff` | `number` |  |
| `linetoolfibcircles.level11.color` | `string` |  |
| `linetoolfibcircles.level11.linestyle` | `number` |  |
| `linetoolfibcircles.level11.linewidth` | `number` |  |
| `linetoolfibcircles.level11.visible` | `boolean` |  |
| `linetoolfibcircles.level2.coeff` | `number` |  |
| `linetoolfibcircles.level2.color` | `string` |  |
| `linetoolfibcircles.level2.linestyle` | `number` |  |
| `linetoolfibcircles.level2.linewidth` | `number` |  |
| `linetoolfibcircles.level2.visible` | `boolean` |  |
| `linetoolfibcircles.level3.coeff` | `number` |  |
| `linetoolfibcircles.level3.color` | `string` |  |
| `linetoolfibcircles.level3.linestyle` | `number` |  |
| `linetoolfibcircles.level3.linewidth` | `number` |  |
| `linetoolfibcircles.level3.visible` | `boolean` |  |
| `linetoolfibcircles.level4.coeff` | `number` |  |
| `linetoolfibcircles.level4.color` | `string` |  |
| `linetoolfibcircles.level4.linestyle` | `number` |  |
| `linetoolfibcircles.level4.linewidth` | `number` |  |
| `linetoolfibcircles.level4.visible` | `boolean` |  |
| `linetoolfibcircles.level5.coeff` | `number` |  |
| `linetoolfibcircles.level5.color` | `string` |  |
| `linetoolfibcircles.level5.linestyle` | `number` |  |
| `linetoolfibcircles.level5.linewidth` | `number` |  |
| `linetoolfibcircles.level5.visible` | `boolean` |  |
| `linetoolfibcircles.level6.coeff` | `number` |  |
| `linetoolfibcircles.level6.color` | `string` |  |
| `linetoolfibcircles.level6.linestyle` | `number` |  |
| `linetoolfibcircles.level6.linewidth` | `number` |  |
| `linetoolfibcircles.level6.visible` | `boolean` |  |
| `linetoolfibcircles.level7.coeff` | `number` |  |
| `linetoolfibcircles.level7.color` | `string` |  |
| `linetoolfibcircles.level7.linestyle` | `number` |  |
| `linetoolfibcircles.level7.linewidth` | `number` |  |
| `linetoolfibcircles.level7.visible` | `boolean` |  |
| `linetoolfibcircles.level8.coeff` | `number` |  |
| `linetoolfibcircles.level8.color` | `string` |  |
| `linetoolfibcircles.level8.linestyle` | `number` |  |
| `linetoolfibcircles.level8.linewidth` | `number` |  |
| `linetoolfibcircles.level8.visible` | `boolean` |  |
| `linetoolfibcircles.level9.coeff` | `number` |  |
| `linetoolfibcircles.level9.color` | `string` |  |
| `linetoolfibcircles.level9.linestyle` | `number` |  |
| `linetoolfibcircles.level9.linewidth` | `number` |  |
| `linetoolfibcircles.level9.visible` | `boolean` |  |
| `linetoolfibcircles.showCoeffs` | `boolean` |  |
| `linetoolfibcircles.transparency` | `number` |  |
| `linetoolfibcircles.trendline.color` | `string` |  |
| `linetoolfibcircles.trendline.linestyle` | `number` |  |
| `linetoolfibcircles.trendline.linewidth` | `number` |  |
| `linetoolfibcircles.trendline.visible` | `boolean` |  |

## FibretracementLineToolOverrides {#fibretracementlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolfibretracement.coeffsAsPercents` | `boolean` |  |
| `linetoolfibretracement.extendLines` | `boolean` |  |
| `linetoolfibretracement.extendLinesLeft` | `boolean` |  |
| `linetoolfibretracement.fibLevelsBasedOnLogScale` | `boolean` |  |
| `linetoolfibretracement.fillBackground` | `boolean` |  |
| `linetoolfibretracement.horzLabelsAlign` | `string` |  |
| `linetoolfibretracement.labelFontSize` | `number` |  |
| `linetoolfibretracement.level1.coeff` | `number` |  |
| `linetoolfibretracement.level1.color` | `string` |  |
| `linetoolfibretracement.level1.visible` | `boolean` |  |
| `linetoolfibretracement.level10.coeff` | `number` |  |
| `linetoolfibretracement.level10.color` | `string` |  |
| `linetoolfibretracement.level10.visible` | `boolean` |  |
| `linetoolfibretracement.level11.coeff` | `number` |  |
| `linetoolfibretracement.level11.color` | `string` |  |
| `linetoolfibretracement.level11.visible` | `boolean` |  |
| `linetoolfibretracement.level12.coeff` | `number` |  |
| `linetoolfibretracement.level12.color` | `string` |  |
| `linetoolfibretracement.level12.visible` | `boolean` |  |
| `linetoolfibretracement.level13.coeff` | `number` |  |
| `linetoolfibretracement.level13.color` | `string` |  |
| `linetoolfibretracement.level13.visible` | `boolean` |  |
| `linetoolfibretracement.level14.coeff` | `number` |  |
| `linetoolfibretracement.level14.color` | `string` |  |
| `linetoolfibretracement.level14.visible` | `boolean` |  |
| `linetoolfibretracement.level15.coeff` | `number` |  |
| `linetoolfibretracement.level15.color` | `string` |  |
| `linetoolfibretracement.level15.visible` | `boolean` |  |
| `linetoolfibretracement.level16.coeff` | `number` |  |
| `linetoolfibretracement.level16.color` | `string` |  |
| `linetoolfibretracement.level16.visible` | `boolean` |  |
| `linetoolfibretracement.level17.coeff` | `number` |  |
| `linetoolfibretracement.level17.color` | `string` |  |
| `linetoolfibretracement.level17.visible` | `boolean` |  |
| `linetoolfibretracement.level18.coeff` | `number` |  |
| `linetoolfibretracement.level18.color` | `string` |  |
| `linetoolfibretracement.level18.visible` | `boolean` |  |
| `linetoolfibretracement.level19.coeff` | `number` |  |
| `linetoolfibretracement.level19.color` | `string` |  |
| `linetoolfibretracement.level19.visible` | `boolean` |  |
| `linetoolfibretracement.level2.coeff` | `number` |  |
| `linetoolfibretracement.level2.color` | `string` |  |
| `linetoolfibretracement.level2.visible` | `boolean` |  |
| `linetoolfibretracement.level20.coeff` | `number` |  |
| `linetoolfibretracement.level20.color` | `string` |  |
| `linetoolfibretracement.level20.visible` | `boolean` |  |
| `linetoolfibretracement.level21.coeff` | `number` |  |
| `linetoolfibretracement.level21.color` | `string` |  |
| `linetoolfibretracement.level21.visible` | `boolean` |  |
| `linetoolfibretracement.level22.coeff` | `number` |  |
| `linetoolfibretracement.level22.color` | `string` |  |
| `linetoolfibretracement.level22.visible` | `boolean` |  |
| `linetoolfibretracement.level23.coeff` | `number` |  |
| `linetoolfibretracement.level23.color` | `string` |  |
| `linetoolfibretracement.level23.visible` | `boolean` |  |
| `linetoolfibretracement.level24.coeff` | `number` |  |
| `linetoolfibretracement.level24.color` | `string` |  |
| `linetoolfibretracement.level24.visible` | `boolean` |  |
| `linetoolfibretracement.level3.coeff` | `number` |  |
| `linetoolfibretracement.level3.color` | `string` |  |
| `linetoolfibretracement.level3.visible` | `boolean` |  |
| `linetoolfibretracement.level4.coeff` | `number` |  |
| `linetoolfibretracement.level4.color` | `string` |  |
| `linetoolfibretracement.level4.visible` | `boolean` |  |
| `linetoolfibretracement.level5.coeff` | `number` |  |
| `linetoolfibretracement.level5.color` | `string` |  |
| `linetoolfibretracement.level5.visible` | `boolean` |  |
| `linetoolfibretracement.level6.coeff` | `number` |  |
| `linetoolfibretracement.level6.color` | `string` |  |
| `linetoolfibretracement.level6.visible` | `boolean` |  |
| `linetoolfibretracement.level7.coeff` | `number` |  |
| `linetoolfibretracement.level7.color` | `string` |  |
| `linetoolfibretracement.level7.visible` | `boolean` |  |
| `linetoolfibretracement.level8.coeff` | `number` |  |
| `linetoolfibretracement.level8.color` | `string` |  |
| `linetoolfibretracement.level8.visible` | `boolean` |  |
| `linetoolfibretracement.level9.coeff` | `number` |  |
| `linetoolfibretracement.level9.color` | `string` |  |
| `linetoolfibretracement.level9.visible` | `boolean` |  |
| `linetoolfibretracement.levelsStyle.linestyle` | `number` |  |
| `linetoolfibretracement.levelsStyle.linewidth` | `number` |  |
| `linetoolfibretracement.reverse` | `boolean` |  |
| `linetoolfibretracement.showCoeffs` | `boolean` |  |
| `linetoolfibretracement.showPrices` | `boolean` |  |
| `linetoolfibretracement.transparency` | `number` |  |
| `linetoolfibretracement.trendline.color` | `string` |  |
| `linetoolfibretracement.trendline.linestyle` | `number` |  |
| `linetoolfibretracement.trendline.linewidth` | `number` |  |
| `linetoolfibretracement.trendline.visible` | `boolean` |  |
| `linetoolfibretracement.vertLabelsAlign` | `string` |  |

## FibspeedresistancearcsLineToolOverrides {#fibspeedresistancearcslinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolfibspeedresistancearcs.fillBackground` | `boolean` |  |
| `linetoolfibspeedresistancearcs.fullCircles` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level1.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level1.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level1.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level1.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level1.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level10.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level10.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level10.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level10.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level10.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level11.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level11.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level11.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level11.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level11.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level2.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level2.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level2.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level2.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level2.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level3.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level3.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level3.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level3.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level3.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level4.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level4.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level4.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level4.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level4.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level5.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level5.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level5.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level5.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level5.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level6.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level6.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level6.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level6.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level6.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level7.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level7.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level7.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level7.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level7.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level8.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level8.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level8.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level8.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level8.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.level9.coeff` | `number` |  |
| `linetoolfibspeedresistancearcs.level9.color` | `string` |  |
| `linetoolfibspeedresistancearcs.level9.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.level9.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.level9.visible` | `boolean` |  |
| `linetoolfibspeedresistancearcs.showCoeffs` | `boolean` |  |
| `linetoolfibspeedresistancearcs.transparency` | `number` |  |
| `linetoolfibspeedresistancearcs.trendline.color` | `string` |  |
| `linetoolfibspeedresistancearcs.trendline.linestyle` | `number` |  |
| `linetoolfibspeedresistancearcs.trendline.linewidth` | `number` |  |
| `linetoolfibspeedresistancearcs.trendline.visible` | `boolean` |  |

## FibspeedresistancefanLineToolOverrides {#fibspeedresistancefanlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolfibspeedresistancefan.fillBackground` | `boolean` |  |
| `linetoolfibspeedresistancefan.grid.color` | `string` |  |
| `linetoolfibspeedresistancefan.grid.linestyle` | `number` |  |
| `linetoolfibspeedresistancefan.grid.linewidth` | `number` |  |
| `linetoolfibspeedresistancefan.grid.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.hlevel1.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.hlevel1.color` | `string` |  |
| `linetoolfibspeedresistancefan.hlevel1.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.hlevel2.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.hlevel2.color` | `string` |  |
| `linetoolfibspeedresistancefan.hlevel2.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.hlevel3.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.hlevel3.color` | `string` |  |
| `linetoolfibspeedresistancefan.hlevel3.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.hlevel4.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.hlevel4.color` | `string` |  |
| `linetoolfibspeedresistancefan.hlevel4.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.hlevel5.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.hlevel5.color` | `string` |  |
| `linetoolfibspeedresistancefan.hlevel5.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.hlevel6.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.hlevel6.color` | `string` |  |
| `linetoolfibspeedresistancefan.hlevel6.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.hlevel7.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.hlevel7.color` | `string` |  |
| `linetoolfibspeedresistancefan.hlevel7.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.linestyle` | `number` |  |
| `linetoolfibspeedresistancefan.linewidth` | `number` |  |
| `linetoolfibspeedresistancefan.reverse` | `boolean` |  |
| `linetoolfibspeedresistancefan.showBottomLabels` | `boolean` |  |
| `linetoolfibspeedresistancefan.showLeftLabels` | `boolean` |  |
| `linetoolfibspeedresistancefan.showRightLabels` | `boolean` |  |
| `linetoolfibspeedresistancefan.showTopLabels` | `boolean` |  |
| `linetoolfibspeedresistancefan.transparency` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel1.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel1.color` | `string` |  |
| `linetoolfibspeedresistancefan.vlevel1.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.vlevel2.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel2.color` | `string` |  |
| `linetoolfibspeedresistancefan.vlevel2.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.vlevel3.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel3.color` | `string` |  |
| `linetoolfibspeedresistancefan.vlevel3.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.vlevel4.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel4.color` | `string` |  |
| `linetoolfibspeedresistancefan.vlevel4.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.vlevel5.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel5.color` | `string` |  |
| `linetoolfibspeedresistancefan.vlevel5.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.vlevel6.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel6.color` | `string` |  |
| `linetoolfibspeedresistancefan.vlevel6.visible` | `boolean` |  |
| `linetoolfibspeedresistancefan.vlevel7.coeff` | `number` |  |
| `linetoolfibspeedresistancefan.vlevel7.color` | `string` |  |
| `linetoolfibspeedresistancefan.vlevel7.visible` | `boolean` |  |

## FibtimezoneLineToolOverrides {#fibtimezonelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolfibtimezone.baselinecolor` | `string` |  |
| `linetoolfibtimezone.fillBackground` | `boolean` |  |
| `linetoolfibtimezone.horzLabelsAlign` | `string` |  |
| `linetoolfibtimezone.level1.coeff` | `number` |  |
| `linetoolfibtimezone.level1.color` | `string` |  |
| `linetoolfibtimezone.level1.linestyle` | `number` |  |
| `linetoolfibtimezone.level1.linewidth` | `number` |  |
| `linetoolfibtimezone.level1.visible` | `boolean` |  |
| `linetoolfibtimezone.level10.coeff` | `number` |  |
| `linetoolfibtimezone.level10.color` | `string` |  |
| `linetoolfibtimezone.level10.linestyle` | `number` |  |
| `linetoolfibtimezone.level10.linewidth` | `number` |  |
| `linetoolfibtimezone.level10.visible` | `boolean` |  |
| `linetoolfibtimezone.level11.coeff` | `number` |  |
| `linetoolfibtimezone.level11.color` | `string` |  |
| `linetoolfibtimezone.level11.linestyle` | `number` |  |
| `linetoolfibtimezone.level11.linewidth` | `number` |  |
| `linetoolfibtimezone.level11.visible` | `boolean` |  |
| `linetoolfibtimezone.level2.coeff` | `number` |  |
| `linetoolfibtimezone.level2.color` | `string` |  |
| `linetoolfibtimezone.level2.linestyle` | `number` |  |
| `linetoolfibtimezone.level2.linewidth` | `number` |  |
| `linetoolfibtimezone.level2.visible` | `boolean` |  |
| `linetoolfibtimezone.level3.coeff` | `number` |  |
| `linetoolfibtimezone.level3.color` | `string` |  |
| `linetoolfibtimezone.level3.linestyle` | `number` |  |
| `linetoolfibtimezone.level3.linewidth` | `number` |  |
| `linetoolfibtimezone.level3.visible` | `boolean` |  |
| `linetoolfibtimezone.level4.coeff` | `number` |  |
| `linetoolfibtimezone.level4.color` | `string` |  |
| `linetoolfibtimezone.level4.linestyle` | `number` |  |
| `linetoolfibtimezone.level4.linewidth` | `number` |  |
| `linetoolfibtimezone.level4.visible` | `boolean` |  |
| `linetoolfibtimezone.level5.coeff` | `number` |  |
| `linetoolfibtimezone.level5.color` | `string` |  |
| `linetoolfibtimezone.level5.linestyle` | `number` |  |
| `linetoolfibtimezone.level5.linewidth` | `number` |  |
| `linetoolfibtimezone.level5.visible` | `boolean` |  |
| `linetoolfibtimezone.level6.coeff` | `number` |  |
| `linetoolfibtimezone.level6.color` | `string` |  |
| `linetoolfibtimezone.level6.linestyle` | `number` |  |
| `linetoolfibtimezone.level6.linewidth` | `number` |  |
| `linetoolfibtimezone.level6.visible` | `boolean` |  |
| `linetoolfibtimezone.level7.coeff` | `number` |  |
| `linetoolfibtimezone.level7.color` | `string` |  |
| `linetoolfibtimezone.level7.linestyle` | `number` |  |
| `linetoolfibtimezone.level7.linewidth` | `number` |  |
| `linetoolfibtimezone.level7.visible` | `boolean` |  |
| `linetoolfibtimezone.level8.coeff` | `number` |  |
| `linetoolfibtimezone.level8.color` | `string` |  |
| `linetoolfibtimezone.level8.linestyle` | `number` |  |
| `linetoolfibtimezone.level8.linewidth` | `number` |  |
| `linetoolfibtimezone.level8.visible` | `boolean` |  |
| `linetoolfibtimezone.level9.coeff` | `number` |  |
| `linetoolfibtimezone.level9.color` | `string` |  |
| `linetoolfibtimezone.level9.linestyle` | `number` |  |
| `linetoolfibtimezone.level9.linewidth` | `number` |  |
| `linetoolfibtimezone.level9.visible` | `boolean` |  |
| `linetoolfibtimezone.linecolor` | `string` |  |
| `linetoolfibtimezone.linestyle` | `number` |  |
| `linetoolfibtimezone.linewidth` | `number` |  |
| `linetoolfibtimezone.showLabels` | `boolean` |  |
| `linetoolfibtimezone.transparency` | `number` |  |
| `linetoolfibtimezone.trendline.color` | `string` |  |
| `linetoolfibtimezone.trendline.linestyle` | `number` |  |
| `linetoolfibtimezone.trendline.linewidth` | `number` |  |
| `linetoolfibtimezone.trendline.visible` | `boolean` |  |
| `linetoolfibtimezone.vertLabelsAlign` | `string` |  |

## FibwedgeLineToolOverrides {#fibwedgelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolfibwedge.fillBackground` | `boolean` |  |
| `linetoolfibwedge.level1.coeff` | `number` |  |
| `linetoolfibwedge.level1.color` | `string` |  |
| `linetoolfibwedge.level1.linestyle` | `number` |  |
| `linetoolfibwedge.level1.linewidth` | `number` |  |
| `linetoolfibwedge.level1.visible` | `boolean` |  |
| `linetoolfibwedge.level10.coeff` | `number` |  |
| `linetoolfibwedge.level10.color` | `string` |  |
| `linetoolfibwedge.level10.linestyle` | `number` |  |
| `linetoolfibwedge.level10.linewidth` | `number` |  |
| `linetoolfibwedge.level10.visible` | `boolean` |  |
| `linetoolfibwedge.level11.coeff` | `number` |  |
| `linetoolfibwedge.level11.color` | `string` |  |
| `linetoolfibwedge.level11.linestyle` | `number` |  |
| `linetoolfibwedge.level11.linewidth` | `number` |  |
| `linetoolfibwedge.level11.visible` | `boolean` |  |
| `linetoolfibwedge.level2.coeff` | `number` |  |
| `linetoolfibwedge.level2.color` | `string` |  |
| `linetoolfibwedge.level2.linestyle` | `number` |  |
| `linetoolfibwedge.level2.linewidth` | `number` |  |
| `linetoolfibwedge.level2.visible` | `boolean` |  |
| `linetoolfibwedge.level3.coeff` | `number` |  |
| `linetoolfibwedge.level3.color` | `string` |  |
| `linetoolfibwedge.level3.linestyle` | `number` |  |
| `linetoolfibwedge.level3.linewidth` | `number` |  |
| `linetoolfibwedge.level3.visible` | `boolean` |  |
| `linetoolfibwedge.level4.coeff` | `number` |  |
| `linetoolfibwedge.level4.color` | `string` |  |
| `linetoolfibwedge.level4.linestyle` | `number` |  |
| `linetoolfibwedge.level4.linewidth` | `number` |  |
| `linetoolfibwedge.level4.visible` | `boolean` |  |
| `linetoolfibwedge.level5.coeff` | `number` |  |
| `linetoolfibwedge.level5.color` | `string` |  |
| `linetoolfibwedge.level5.linestyle` | `number` |  |
| `linetoolfibwedge.level5.linewidth` | `number` |  |
| `linetoolfibwedge.level5.visible` | `boolean` |  |
| `linetoolfibwedge.level6.coeff` | `number` |  |
| `linetoolfibwedge.level6.color` | `string` |  |
| `linetoolfibwedge.level6.linestyle` | `number` |  |
| `linetoolfibwedge.level6.linewidth` | `number` |  |
| `linetoolfibwedge.level6.visible` | `boolean` |  |
| `linetoolfibwedge.level7.coeff` | `number` |  |
| `linetoolfibwedge.level7.color` | `string` |  |
| `linetoolfibwedge.level7.linestyle` | `number` |  |
| `linetoolfibwedge.level7.linewidth` | `number` |  |
| `linetoolfibwedge.level7.visible` | `boolean` |  |
| `linetoolfibwedge.level8.coeff` | `number` |  |
| `linetoolfibwedge.level8.color` | `string` |  |
| `linetoolfibwedge.level8.linestyle` | `number` |  |
| `linetoolfibwedge.level8.linewidth` | `number` |  |
| `linetoolfibwedge.level8.visible` | `boolean` |  |
| `linetoolfibwedge.level9.coeff` | `number` |  |
| `linetoolfibwedge.level9.color` | `string` |  |
| `linetoolfibwedge.level9.linestyle` | `number` |  |
| `linetoolfibwedge.level9.linewidth` | `number` |  |
| `linetoolfibwedge.level9.visible` | `boolean` |  |
| `linetoolfibwedge.showCoeffs` | `boolean` |  |
| `linetoolfibwedge.transparency` | `number` |  |
| `linetoolfibwedge.trendline.color` | `string` |  |
| `linetoolfibwedge.trendline.linestyle` | `number` |  |
| `linetoolfibwedge.trendline.linewidth` | `number` |  |
| `linetoolfibwedge.trendline.visible` | `boolean` |  |

## FivepointspatternLineToolOverrides {#fivepointspatternlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetool5pointspattern.backgroundColor` | `string` |  |
| `linetool5pointspattern.bold` | `boolean` |  |
| `linetool5pointspattern.color` | `string` |  |
| `linetool5pointspattern.fillBackground` | `boolean` |  |
| `linetool5pointspattern.fontsize` | `number` |  |
| `linetool5pointspattern.italic` | `boolean` |  |
| `linetool5pointspattern.linewidth` | `number` |  |
| `linetool5pointspattern.textcolor` | `string` |  |
| `linetool5pointspattern.transparency` | `number` |  |

## FlagmarkLineToolOverrides {#flagmarklinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolflagmark.flagColor` | `string` |  |

## FlatbottomLineToolOverrides {#flatbottomlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolflatbottom.backgroundColor` | `string` |  |
| `linetoolflatbottom.bold` | `boolean` |  |
| `linetoolflatbottom.extendLeft` | `boolean` |  |
| `linetoolflatbottom.extendRight` | `boolean` |  |
| `linetoolflatbottom.fillBackground` | `boolean` |  |
| `linetoolflatbottom.fontsize` | `number` |  |
| `linetoolflatbottom.italic` | `boolean` |  |
| `linetoolflatbottom.labelBold` | `boolean` |  |
| `linetoolflatbottom.labelFontSize` | `number` |  |
| `linetoolflatbottom.labelHorzAlign` | `string` |  |
| `linetoolflatbottom.labelItalic` | `boolean` |  |
| `linetoolflatbottom.labelTextColor` | `string` |  |
| `linetoolflatbottom.labelVertAlign` | `string` |  |
| `linetoolflatbottom.labelVisible` | `boolean` |  |
| `linetoolflatbottom.leftEnd` | `number` |  |
| `linetoolflatbottom.linecolor` | `string` |  |
| `linetoolflatbottom.linestyle` | `number` |  |
| `linetoolflatbottom.linewidth` | `number` |  |
| `linetoolflatbottom.rightEnd` | `number` |  |
| `linetoolflatbottom.showBarsRange` | `boolean` |  |
| `linetoolflatbottom.showDateTimeRange` | `boolean` |  |
| `linetoolflatbottom.showPriceRange` | `boolean` |  |
| `linetoolflatbottom.showPrices` | `boolean` |  |
| `linetoolflatbottom.textcolor` | `string` |  |
| `linetoolflatbottom.transparency` | `number` |  |

## GanncomplexLineToolOverrides {#ganncomplexlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolganncomplex.arcs.0.color` | `string` |  |
| `linetoolganncomplex.arcs.0.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.0.width` | `number` |  |
| `linetoolganncomplex.arcs.0.x` | `number` |  |
| `linetoolganncomplex.arcs.0.y` | `number` |  |
| `linetoolganncomplex.arcs.1.color` | `string` |  |
| `linetoolganncomplex.arcs.1.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.1.width` | `number` |  |
| `linetoolganncomplex.arcs.1.x` | `number` |  |
| `linetoolganncomplex.arcs.1.y` | `number` |  |
| `linetoolganncomplex.arcs.10.color` | `string` |  |
| `linetoolganncomplex.arcs.10.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.10.width` | `number` |  |
| `linetoolganncomplex.arcs.10.x` | `number` |  |
| `linetoolganncomplex.arcs.10.y` | `number` |  |
| `linetoolganncomplex.arcs.2.color` | `string` |  |
| `linetoolganncomplex.arcs.2.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.2.width` | `number` |  |
| `linetoolganncomplex.arcs.2.x` | `number` |  |
| `linetoolganncomplex.arcs.2.y` | `number` |  |
| `linetoolganncomplex.arcs.3.color` | `string` |  |
| `linetoolganncomplex.arcs.3.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.3.width` | `number` |  |
| `linetoolganncomplex.arcs.3.x` | `number` |  |
| `linetoolganncomplex.arcs.3.y` | `number` |  |
| `linetoolganncomplex.arcs.4.color` | `string` |  |
| `linetoolganncomplex.arcs.4.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.4.width` | `number` |  |
| `linetoolganncomplex.arcs.4.x` | `number` |  |
| `linetoolganncomplex.arcs.4.y` | `number` |  |
| `linetoolganncomplex.arcs.5.color` | `string` |  |
| `linetoolganncomplex.arcs.5.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.5.width` | `number` |  |
| `linetoolganncomplex.arcs.5.x` | `number` |  |
| `linetoolganncomplex.arcs.5.y` | `number` |  |
| `linetoolganncomplex.arcs.6.color` | `string` |  |
| `linetoolganncomplex.arcs.6.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.6.width` | `number` |  |
| `linetoolganncomplex.arcs.6.x` | `number` |  |
| `linetoolganncomplex.arcs.6.y` | `number` |  |
| `linetoolganncomplex.arcs.7.color` | `string` |  |
| `linetoolganncomplex.arcs.7.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.7.width` | `number` |  |
| `linetoolganncomplex.arcs.7.x` | `number` |  |
| `linetoolganncomplex.arcs.7.y` | `number` |  |
| `linetoolganncomplex.arcs.8.color` | `string` |  |
| `linetoolganncomplex.arcs.8.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.8.width` | `number` |  |
| `linetoolganncomplex.arcs.8.x` | `number` |  |
| `linetoolganncomplex.arcs.8.y` | `number` |  |
| `linetoolganncomplex.arcs.9.color` | `string` |  |
| `linetoolganncomplex.arcs.9.visible` | `boolean` |  |
| `linetoolganncomplex.arcs.9.width` | `number` |  |
| `linetoolganncomplex.arcs.9.x` | `number` |  |
| `linetoolganncomplex.arcs.9.y` | `number` |  |
| `linetoolganncomplex.arcsBackground.fillBackground` | `boolean` |  |
| `linetoolganncomplex.arcsBackground.transparency` | `number` |  |
| `linetoolganncomplex.fanlines.0.color` | `string` |  |
| `linetoolganncomplex.fanlines.0.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.0.width` | `number` |  |
| `linetoolganncomplex.fanlines.0.x` | `number` |  |
| `linetoolganncomplex.fanlines.0.y` | `number` |  |
| `linetoolganncomplex.fanlines.1.color` | `string` |  |
| `linetoolganncomplex.fanlines.1.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.1.width` | `number` |  |
| `linetoolganncomplex.fanlines.1.x` | `number` |  |
| `linetoolganncomplex.fanlines.1.y` | `number` |  |
| `linetoolganncomplex.fanlines.10.color` | `string` |  |
| `linetoolganncomplex.fanlines.10.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.10.width` | `number` |  |
| `linetoolganncomplex.fanlines.10.x` | `number` |  |
| `linetoolganncomplex.fanlines.10.y` | `number` |  |
| `linetoolganncomplex.fanlines.2.color` | `string` |  |
| `linetoolganncomplex.fanlines.2.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.2.width` | `number` |  |
| `linetoolganncomplex.fanlines.2.x` | `number` |  |
| `linetoolganncomplex.fanlines.2.y` | `number` |  |
| `linetoolganncomplex.fanlines.3.color` | `string` |  |
| `linetoolganncomplex.fanlines.3.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.3.width` | `number` |  |
| `linetoolganncomplex.fanlines.3.x` | `number` |  |
| `linetoolganncomplex.fanlines.3.y` | `number` |  |
| `linetoolganncomplex.fanlines.4.color` | `string` |  |
| `linetoolganncomplex.fanlines.4.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.4.width` | `number` |  |
| `linetoolganncomplex.fanlines.4.x` | `number` |  |
| `linetoolganncomplex.fanlines.4.y` | `number` |  |
| `linetoolganncomplex.fanlines.5.color` | `string` |  |
| `linetoolganncomplex.fanlines.5.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.5.width` | `number` |  |
| `linetoolganncomplex.fanlines.5.x` | `number` |  |
| `linetoolganncomplex.fanlines.5.y` | `number` |  |
| `linetoolganncomplex.fanlines.6.color` | `string` |  |
| `linetoolganncomplex.fanlines.6.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.6.width` | `number` |  |
| `linetoolganncomplex.fanlines.6.x` | `number` |  |
| `linetoolganncomplex.fanlines.6.y` | `number` |  |
| `linetoolganncomplex.fanlines.7.color` | `string` |  |
| `linetoolganncomplex.fanlines.7.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.7.width` | `number` |  |
| `linetoolganncomplex.fanlines.7.x` | `number` |  |
| `linetoolganncomplex.fanlines.7.y` | `number` |  |
| `linetoolganncomplex.fanlines.8.color` | `string` |  |
| `linetoolganncomplex.fanlines.8.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.8.width` | `number` |  |
| `linetoolganncomplex.fanlines.8.x` | `number` |  |
| `linetoolganncomplex.fanlines.8.y` | `number` |  |
| `linetoolganncomplex.fanlines.9.color` | `string` |  |
| `linetoolganncomplex.fanlines.9.visible` | `boolean` |  |
| `linetoolganncomplex.fanlines.9.width` | `number` |  |
| `linetoolganncomplex.fanlines.9.x` | `number` |  |
| `linetoolganncomplex.fanlines.9.y` | `number` |  |
| `linetoolganncomplex.fillBackground` | `boolean` |  |
| `linetoolganncomplex.labelsStyle.bold` | `boolean` |  |
| `linetoolganncomplex.labelsStyle.fontSize` | `number` |  |
| `linetoolganncomplex.labelsStyle.italic` | `boolean` |  |
| `linetoolganncomplex.levels.0.color` | `string` |  |
| `linetoolganncomplex.levels.0.visible` | `boolean` |  |
| `linetoolganncomplex.levels.0.width` | `number` |  |
| `linetoolganncomplex.levels.1.color` | `string` |  |
| `linetoolganncomplex.levels.1.visible` | `boolean` |  |
| `linetoolganncomplex.levels.1.width` | `number` |  |
| `linetoolganncomplex.levels.2.color` | `string` |  |
| `linetoolganncomplex.levels.2.visible` | `boolean` |  |
| `linetoolganncomplex.levels.2.width` | `number` |  |
| `linetoolganncomplex.levels.3.color` | `string` |  |
| `linetoolganncomplex.levels.3.visible` | `boolean` |  |
| `linetoolganncomplex.levels.3.width` | `number` |  |
| `linetoolganncomplex.levels.4.color` | `string` |  |
| `linetoolganncomplex.levels.4.visible` | `boolean` |  |
| `linetoolganncomplex.levels.4.width` | `number` |  |
| `linetoolganncomplex.levels.5.color` | `string` |  |
| `linetoolganncomplex.levels.5.visible` | `boolean` |  |
| `linetoolganncomplex.levels.5.width` | `number` |  |
| `linetoolganncomplex.reverse` | `boolean` |  |
| `linetoolganncomplex.scaleRatio` | `string` |  |
| `linetoolganncomplex.showLabels` | `boolean` |  |

## GannfanLineToolOverrides {#gannfanlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolgannfan.fillBackground` | `boolean` |  |
| `linetoolgannfan.level1.coeff1` | `number` |  |
| `linetoolgannfan.level1.coeff2` | `number` |  |
| `linetoolgannfan.level1.color` | `string` |  |
| `linetoolgannfan.level1.linestyle` | `number` |  |
| `linetoolgannfan.level1.linewidth` | `number` |  |
| `linetoolgannfan.level1.visible` | `boolean` |  |
| `linetoolgannfan.level2.coeff1` | `number` |  |
| `linetoolgannfan.level2.coeff2` | `number` |  |
| `linetoolgannfan.level2.color` | `string` |  |
| `linetoolgannfan.level2.linestyle` | `number` |  |
| `linetoolgannfan.level2.linewidth` | `number` |  |
| `linetoolgannfan.level2.visible` | `boolean` |  |
| `linetoolgannfan.level3.coeff1` | `number` |  |
| `linetoolgannfan.level3.coeff2` | `number` |  |
| `linetoolgannfan.level3.color` | `string` |  |
| `linetoolgannfan.level3.linestyle` | `number` |  |
| `linetoolgannfan.level3.linewidth` | `number` |  |
| `linetoolgannfan.level3.visible` | `boolean` |  |
| `linetoolgannfan.level4.coeff1` | `number` |  |
| `linetoolgannfan.level4.coeff2` | `number` |  |
| `linetoolgannfan.level4.color` | `string` |  |
| `linetoolgannfan.level4.linestyle` | `number` |  |
| `linetoolgannfan.level4.linewidth` | `number` |  |
| `linetoolgannfan.level4.visible` | `boolean` |  |
| `linetoolgannfan.level5.coeff1` | `number` |  |
| `linetoolgannfan.level5.coeff2` | `number` |  |
| `linetoolgannfan.level5.color` | `string` |  |
| `linetoolgannfan.level5.linestyle` | `number` |  |
| `linetoolgannfan.level5.linewidth` | `number` |  |
| `linetoolgannfan.level5.visible` | `boolean` |  |
| `linetoolgannfan.level6.coeff1` | `number` |  |
| `linetoolgannfan.level6.coeff2` | `number` |  |
| `linetoolgannfan.level6.color` | `string` |  |
| `linetoolgannfan.level6.linestyle` | `number` |  |
| `linetoolgannfan.level6.linewidth` | `number` |  |
| `linetoolgannfan.level6.visible` | `boolean` |  |
| `linetoolgannfan.level7.coeff1` | `number` |  |
| `linetoolgannfan.level7.coeff2` | `number` |  |
| `linetoolgannfan.level7.color` | `string` |  |
| `linetoolgannfan.level7.linestyle` | `number` |  |
| `linetoolgannfan.level7.linewidth` | `number` |  |
| `linetoolgannfan.level7.visible` | `boolean` |  |
| `linetoolgannfan.level8.coeff1` | `number` |  |
| `linetoolgannfan.level8.coeff2` | `number` |  |
| `linetoolgannfan.level8.color` | `string` |  |
| `linetoolgannfan.level8.linestyle` | `number` |  |
| `linetoolgannfan.level8.linewidth` | `number` |  |
| `linetoolgannfan.level8.visible` | `boolean` |  |
| `linetoolgannfan.level9.coeff1` | `number` |  |
| `linetoolgannfan.level9.coeff2` | `number` |  |
| `linetoolgannfan.level9.color` | `string` |  |
| `linetoolgannfan.level9.linestyle` | `number` |  |
| `linetoolgannfan.level9.linewidth` | `number` |  |
| `linetoolgannfan.level9.visible` | `boolean` |  |
| `linetoolgannfan.linewidth` | `number` |  |
| `linetoolgannfan.showLabels` | `boolean` |  |
| `linetoolgannfan.transparency` | `number` |  |

## GannfixedLineToolOverrides {#gannfixedlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolgannfixed.arcs.0.color` | `string` |  |
| `linetoolgannfixed.arcs.0.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.0.width` | `number` |  |
| `linetoolgannfixed.arcs.0.x` | `number` |  |
| `linetoolgannfixed.arcs.0.y` | `number` |  |
| `linetoolgannfixed.arcs.1.color` | `string` |  |
| `linetoolgannfixed.arcs.1.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.1.width` | `number` |  |
| `linetoolgannfixed.arcs.1.x` | `number` |  |
| `linetoolgannfixed.arcs.1.y` | `number` |  |
| `linetoolgannfixed.arcs.10.color` | `string` |  |
| `linetoolgannfixed.arcs.10.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.10.width` | `number` |  |
| `linetoolgannfixed.arcs.10.x` | `number` |  |
| `linetoolgannfixed.arcs.10.y` | `number` |  |
| `linetoolgannfixed.arcs.2.color` | `string` |  |
| `linetoolgannfixed.arcs.2.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.2.width` | `number` |  |
| `linetoolgannfixed.arcs.2.x` | `number` |  |
| `linetoolgannfixed.arcs.2.y` | `number` |  |
| `linetoolgannfixed.arcs.3.color` | `string` |  |
| `linetoolgannfixed.arcs.3.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.3.width` | `number` |  |
| `linetoolgannfixed.arcs.3.x` | `number` |  |
| `linetoolgannfixed.arcs.3.y` | `number` |  |
| `linetoolgannfixed.arcs.4.color` | `string` |  |
| `linetoolgannfixed.arcs.4.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.4.width` | `number` |  |
| `linetoolgannfixed.arcs.4.x` | `number` |  |
| `linetoolgannfixed.arcs.4.y` | `number` |  |
| `linetoolgannfixed.arcs.5.color` | `string` |  |
| `linetoolgannfixed.arcs.5.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.5.width` | `number` |  |
| `linetoolgannfixed.arcs.5.x` | `number` |  |
| `linetoolgannfixed.arcs.5.y` | `number` |  |
| `linetoolgannfixed.arcs.6.color` | `string` |  |
| `linetoolgannfixed.arcs.6.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.6.width` | `number` |  |
| `linetoolgannfixed.arcs.6.x` | `number` |  |
| `linetoolgannfixed.arcs.6.y` | `number` |  |
| `linetoolgannfixed.arcs.7.color` | `string` |  |
| `linetoolgannfixed.arcs.7.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.7.width` | `number` |  |
| `linetoolgannfixed.arcs.7.x` | `number` |  |
| `linetoolgannfixed.arcs.7.y` | `number` |  |
| `linetoolgannfixed.arcs.8.color` | `string` |  |
| `linetoolgannfixed.arcs.8.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.8.width` | `number` |  |
| `linetoolgannfixed.arcs.8.x` | `number` |  |
| `linetoolgannfixed.arcs.8.y` | `number` |  |
| `linetoolgannfixed.arcs.9.color` | `string` |  |
| `linetoolgannfixed.arcs.9.visible` | `boolean` |  |
| `linetoolgannfixed.arcs.9.width` | `number` |  |
| `linetoolgannfixed.arcs.9.x` | `number` |  |
| `linetoolgannfixed.arcs.9.y` | `number` |  |
| `linetoolgannfixed.arcsBackground.fillBackground` | `boolean` |  |
| `linetoolgannfixed.arcsBackground.transparency` | `number` |  |
| `linetoolgannfixed.fanlines.0.color` | `string` |  |
| `linetoolgannfixed.fanlines.0.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.0.width` | `number` |  |
| `linetoolgannfixed.fanlines.0.x` | `number` |  |
| `linetoolgannfixed.fanlines.0.y` | `number` |  |
| `linetoolgannfixed.fanlines.1.color` | `string` |  |
| `linetoolgannfixed.fanlines.1.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.1.width` | `number` |  |
| `linetoolgannfixed.fanlines.1.x` | `number` |  |
| `linetoolgannfixed.fanlines.1.y` | `number` |  |
| `linetoolgannfixed.fanlines.10.color` | `string` |  |
| `linetoolgannfixed.fanlines.10.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.10.width` | `number` |  |
| `linetoolgannfixed.fanlines.10.x` | `number` |  |
| `linetoolgannfixed.fanlines.10.y` | `number` |  |
| `linetoolgannfixed.fanlines.2.color` | `string` |  |
| `linetoolgannfixed.fanlines.2.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.2.width` | `number` |  |
| `linetoolgannfixed.fanlines.2.x` | `number` |  |
| `linetoolgannfixed.fanlines.2.y` | `number` |  |
| `linetoolgannfixed.fanlines.3.color` | `string` |  |
| `linetoolgannfixed.fanlines.3.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.3.width` | `number` |  |
| `linetoolgannfixed.fanlines.3.x` | `number` |  |
| `linetoolgannfixed.fanlines.3.y` | `number` |  |
| `linetoolgannfixed.fanlines.4.color` | `string` |  |
| `linetoolgannfixed.fanlines.4.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.4.width` | `number` |  |
| `linetoolgannfixed.fanlines.4.x` | `number` |  |
| `linetoolgannfixed.fanlines.4.y` | `number` |  |
| `linetoolgannfixed.fanlines.5.color` | `string` |  |
| `linetoolgannfixed.fanlines.5.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.5.width` | `number` |  |
| `linetoolgannfixed.fanlines.5.x` | `number` |  |
| `linetoolgannfixed.fanlines.5.y` | `number` |  |
| `linetoolgannfixed.fanlines.6.color` | `string` |  |
| `linetoolgannfixed.fanlines.6.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.6.width` | `number` |  |
| `linetoolgannfixed.fanlines.6.x` | `number` |  |
| `linetoolgannfixed.fanlines.6.y` | `number` |  |
| `linetoolgannfixed.fanlines.7.color` | `string` |  |
| `linetoolgannfixed.fanlines.7.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.7.width` | `number` |  |
| `linetoolgannfixed.fanlines.7.x` | `number` |  |
| `linetoolgannfixed.fanlines.7.y` | `number` |  |
| `linetoolgannfixed.fanlines.8.color` | `string` |  |
| `linetoolgannfixed.fanlines.8.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.8.width` | `number` |  |
| `linetoolgannfixed.fanlines.8.x` | `number` |  |
| `linetoolgannfixed.fanlines.8.y` | `number` |  |
| `linetoolgannfixed.fanlines.9.color` | `string` |  |
| `linetoolgannfixed.fanlines.9.visible` | `boolean` |  |
| `linetoolgannfixed.fanlines.9.width` | `number` |  |
| `linetoolgannfixed.fanlines.9.x` | `number` |  |
| `linetoolgannfixed.fanlines.9.y` | `number` |  |
| `linetoolgannfixed.fillBackground` | `boolean` |  |
| `linetoolgannfixed.levels.0.color` | `string` |  |
| `linetoolgannfixed.levels.0.visible` | `boolean` |  |
| `linetoolgannfixed.levels.0.width` | `number` |  |
| `linetoolgannfixed.levels.1.color` | `string` |  |
| `linetoolgannfixed.levels.1.visible` | `boolean` |  |
| `linetoolgannfixed.levels.1.width` | `number` |  |
| `linetoolgannfixed.levels.2.color` | `string` |  |
| `linetoolgannfixed.levels.2.visible` | `boolean` |  |
| `linetoolgannfixed.levels.2.width` | `number` |  |
| `linetoolgannfixed.levels.3.color` | `string` |  |
| `linetoolgannfixed.levels.3.visible` | `boolean` |  |
| `linetoolgannfixed.levels.3.width` | `number` |  |
| `linetoolgannfixed.levels.4.color` | `string` |  |
| `linetoolgannfixed.levels.4.visible` | `boolean` |  |
| `linetoolgannfixed.levels.4.width` | `number` |  |
| `linetoolgannfixed.levels.5.color` | `string` |  |
| `linetoolgannfixed.levels.5.visible` | `boolean` |  |
| `linetoolgannfixed.levels.5.width` | `number` |  |
| `linetoolgannfixed.reverse` | `boolean` |  |

## GannsquareLineToolOverrides {#gannsquarelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolgannsquare.color` | `string` |  |
| `linetoolgannsquare.fans.color` | `string` |  |
| `linetoolgannsquare.fans.visible` | `boolean` |  |
| `linetoolgannsquare.fillHorzBackground` | `boolean` |  |
| `linetoolgannsquare.fillVertBackground` | `boolean` |  |
| `linetoolgannsquare.hlevel1.coeff` | `number` |  |
| `linetoolgannsquare.hlevel1.color` | `string` |  |
| `linetoolgannsquare.hlevel1.visible` | `boolean` |  |
| `linetoolgannsquare.hlevel2.coeff` | `number` |  |
| `linetoolgannsquare.hlevel2.color` | `string` |  |
| `linetoolgannsquare.hlevel2.visible` | `boolean` |  |
| `linetoolgannsquare.hlevel3.coeff` | `number` |  |
| `linetoolgannsquare.hlevel3.color` | `string` |  |
| `linetoolgannsquare.hlevel3.visible` | `boolean` |  |
| `linetoolgannsquare.hlevel4.coeff` | `number` |  |
| `linetoolgannsquare.hlevel4.color` | `string` |  |
| `linetoolgannsquare.hlevel4.visible` | `boolean` |  |
| `linetoolgannsquare.hlevel5.coeff` | `number` |  |
| `linetoolgannsquare.hlevel5.color` | `string` |  |
| `linetoolgannsquare.hlevel5.visible` | `boolean` |  |
| `linetoolgannsquare.hlevel6.coeff` | `number` |  |
| `linetoolgannsquare.hlevel6.color` | `string` |  |
| `linetoolgannsquare.hlevel6.visible` | `boolean` |  |
| `linetoolgannsquare.hlevel7.coeff` | `number` |  |
| `linetoolgannsquare.hlevel7.color` | `string` |  |
| `linetoolgannsquare.hlevel7.visible` | `boolean` |  |
| `linetoolgannsquare.horzTransparency` | `number` |  |
| `linetoolgannsquare.linestyle` | `number` |  |
| `linetoolgannsquare.linewidth` | `number` |  |
| `linetoolgannsquare.reverse` | `boolean` |  |
| `linetoolgannsquare.showBottomLabels` | `boolean` |  |
| `linetoolgannsquare.showLeftLabels` | `boolean` |  |
| `linetoolgannsquare.showRightLabels` | `boolean` |  |
| `linetoolgannsquare.showTopLabels` | `boolean` |  |
| `linetoolgannsquare.vertTransparency` | `number` |  |
| `linetoolgannsquare.vlevel1.coeff` | `number` |  |
| `linetoolgannsquare.vlevel1.color` | `string` |  |
| `linetoolgannsquare.vlevel1.visible` | `boolean` |  |
| `linetoolgannsquare.vlevel2.coeff` | `number` |  |
| `linetoolgannsquare.vlevel2.color` | `string` |  |
| `linetoolgannsquare.vlevel2.visible` | `boolean` |  |
| `linetoolgannsquare.vlevel3.coeff` | `number` |  |
| `linetoolgannsquare.vlevel3.color` | `string` |  |
| `linetoolgannsquare.vlevel3.visible` | `boolean` |  |
| `linetoolgannsquare.vlevel4.coeff` | `number` |  |
| `linetoolgannsquare.vlevel4.color` | `string` |  |
| `linetoolgannsquare.vlevel4.visible` | `boolean` |  |
| `linetoolgannsquare.vlevel5.coeff` | `number` |  |
| `linetoolgannsquare.vlevel5.color` | `string` |  |
| `linetoolgannsquare.vlevel5.visible` | `boolean` |  |
| `linetoolgannsquare.vlevel6.coeff` | `number` |  |
| `linetoolgannsquare.vlevel6.color` | `string` |  |
| `linetoolgannsquare.vlevel6.visible` | `boolean` |  |
| `linetoolgannsquare.vlevel7.coeff` | `number` |  |
| `linetoolgannsquare.vlevel7.color` | `string` |  |
| `linetoolgannsquare.vlevel7.visible` | `boolean` |  |

## GhostfeedLineToolOverrides {#ghostfeedlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolghostfeed.averageHL` | `number` |  |
| `linetoolghostfeed.candleStyle.borderColor` | `string` |  |
| `linetoolghostfeed.candleStyle.borderDownColor` | `string` |  |
| `linetoolghostfeed.candleStyle.borderUpColor` | `string` |  |
| `linetoolghostfeed.candleStyle.downColor` | `string` |  |
| `linetoolghostfeed.candleStyle.drawBorder` | `boolean` |  |
| `linetoolghostfeed.candleStyle.drawWick` | `boolean` |  |
| `linetoolghostfeed.candleStyle.upColor` | `string` |  |
| `linetoolghostfeed.candleStyle.wickColor` | `string` |  |
| `linetoolghostfeed.transparency` | `number` |  |
| `linetoolghostfeed.variance` | `number` |  |

## HeadandshouldersLineToolOverrides {#headandshoulderslinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolheadandshoulders.backgroundColor` | `string` |  |
| `linetoolheadandshoulders.bold` | `boolean` |  |
| `linetoolheadandshoulders.color` | `string` |  |
| `linetoolheadandshoulders.fillBackground` | `boolean` |  |
| `linetoolheadandshoulders.fontsize` | `number` |  |
| `linetoolheadandshoulders.italic` | `boolean` |  |
| `linetoolheadandshoulders.linewidth` | `number` |  |
| `linetoolheadandshoulders.textcolor` | `string` |  |
| `linetoolheadandshoulders.transparency` | `number` |  |

## HighlighterLineToolOverrides {#highlighterlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolhighlighter.linecolor` | `string` |  |
| `linetoolhighlighter.smooth` | `number` |  |
| `linetoolhighlighter.transparency` | `number` |  |

## HorzlineLineToolOverrides {#horzlinelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolhorzline.bold` | `boolean` |  |
| `linetoolhorzline.fontsize` | `number` |  |
| `linetoolhorzline.horzLabelsAlign` | `string` |  |
| `linetoolhorzline.italic` | `boolean` |  |
| `linetoolhorzline.linecolor` | `string` |  |
| `linetoolhorzline.linestyle` | `number` |  |
| `linetoolhorzline.linewidth` | `number` |  |
| `linetoolhorzline.showLabel` | `boolean` |  |
| `linetoolhorzline.showPrice` | `boolean` |  |
| `linetoolhorzline.textcolor` | `string` |  |
| `linetoolhorzline.vertLabelsAlign` | `string` |  |

## HorzrayLineToolOverrides {#horzraylinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolhorzray.bold` | `boolean` |  |
| `linetoolhorzray.fontsize` | `number` |  |
| `linetoolhorzray.horzLabelsAlign` | `string` |  |
| `linetoolhorzray.italic` | `boolean` |  |
| `linetoolhorzray.linecolor` | `string` |  |
| `linetoolhorzray.linestyle` | `number` |  |
| `linetoolhorzray.linewidth` | `number` |  |
| `linetoolhorzray.showLabel` | `boolean` |  |
| `linetoolhorzray.showPrice` | `boolean` |  |
| `linetoolhorzray.textcolor` | `string` |  |
| `linetoolhorzray.vertLabelsAlign` | `string` |  |

## IconLineToolOverrides {#iconlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolicon.angle` | `number` |  |
| `linetoolicon.color` | `string` |  |
| `linetoolicon.icon` | `number` |  |
| `linetoolicon.size` | `number` |  |

## ImageLineToolOverrides {#imagelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolimage.angle` | `number` |  |
| `linetoolimage.cssHeight` | `number` |  |
| `linetoolimage.cssWidth` | `number` |  |
| `linetoolimage.transparency` | `number` |  |

## InfolineLineToolOverrides {#infolinelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolinfoline.alwaysShowStats` | `boolean` |  |
| `linetoolinfoline.bold` | `boolean` |  |
| `linetoolinfoline.extendLeft` | `boolean` |  |
| `linetoolinfoline.extendRight` | `boolean` |  |
| `linetoolinfoline.fontsize` | `number` |  |
| `linetoolinfoline.horzLabelsAlign` | `string` |  |
| `linetoolinfoline.italic` | `boolean` |  |
| `linetoolinfoline.leftEnd` | `number` |  |
| `linetoolinfoline.linecolor` | `string` |  |
| `linetoolinfoline.linestyle` | `number` |  |
| `linetoolinfoline.linewidth` | `number` |  |
| `linetoolinfoline.rightEnd` | `number` |  |
| `linetoolinfoline.showAngle` | `boolean` |  |
| `linetoolinfoline.showBarsRange` | `boolean` |  |
| `linetoolinfoline.showDateTimeRange` | `boolean` |  |
| `linetoolinfoline.showDistance` | `boolean` |  |
| `linetoolinfoline.showLabel` | `boolean` |  |
| `linetoolinfoline.showMiddlePoint` | `boolean` |  |
| `linetoolinfoline.showPercentPriceRange` | `boolean` |  |
| `linetoolinfoline.showPipsPriceRange` | `boolean` |  |
| `linetoolinfoline.showPriceLabels` | `boolean` |  |
| `linetoolinfoline.showPriceRange` | `boolean` |  |
| `linetoolinfoline.statsPosition` | `number` |  |
| `linetoolinfoline.textcolor` | `string` |  |
| `linetoolinfoline.vertLabelsAlign` | `string` |  |

## InsidepitchforkLineToolOverrides {#insidepitchforklinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolinsidepitchfork.extendLines` | `boolean` |  |
| `linetoolinsidepitchfork.fillBackground` | `boolean` |  |
| `linetoolinsidepitchfork.level0.coeff` | `number` |  |
| `linetoolinsidepitchfork.level0.color` | `string` |  |
| `linetoolinsidepitchfork.level0.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level0.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level0.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level1.coeff` | `number` |  |
| `linetoolinsidepitchfork.level1.color` | `string` |  |
| `linetoolinsidepitchfork.level1.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level1.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level1.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level2.coeff` | `number` |  |
| `linetoolinsidepitchfork.level2.color` | `string` |  |
| `linetoolinsidepitchfork.level2.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level2.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level2.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level3.coeff` | `number` |  |
| `linetoolinsidepitchfork.level3.color` | `string` |  |
| `linetoolinsidepitchfork.level3.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level3.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level3.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level4.coeff` | `number` |  |
| `linetoolinsidepitchfork.level4.color` | `string` |  |
| `linetoolinsidepitchfork.level4.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level4.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level4.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level5.coeff` | `number` |  |
| `linetoolinsidepitchfork.level5.color` | `string` |  |
| `linetoolinsidepitchfork.level5.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level5.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level5.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level6.coeff` | `number` |  |
| `linetoolinsidepitchfork.level6.color` | `string` |  |
| `linetoolinsidepitchfork.level6.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level6.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level6.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level7.coeff` | `number` |  |
| `linetoolinsidepitchfork.level7.color` | `string` |  |
| `linetoolinsidepitchfork.level7.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level7.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level7.visible` | `boolean` |  |
| `linetoolinsidepitchfork.level8.coeff` | `number` |  |
| `linetoolinsidepitchfork.level8.color` | `string` |  |
| `linetoolinsidepitchfork.level8.linestyle` | `number` |  |
| `linetoolinsidepitchfork.level8.linewidth` | `number` |  |
| `linetoolinsidepitchfork.level8.visible` | `boolean` |  |
| `linetoolinsidepitchfork.median.color` | `string` |  |
| `linetoolinsidepitchfork.median.linestyle` | `number` |  |
| `linetoolinsidepitchfork.median.linewidth` | `number` |  |
| `linetoolinsidepitchfork.median.visible` | `boolean` |  |
| `linetoolinsidepitchfork.style` | `number` |  |
| `linetoolinsidepitchfork.transparency` | `number` |  |

## NoteLineToolOverrides {#notelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolnote.backgroundColor` | `string` |  |
| `linetoolnote.backgroundTransparency` | `number` |  |
| `linetoolnote.bold` | `boolean` |  |
| `linetoolnote.borderColor` | `string` |  |
| `linetoolnote.fixedSize` | `boolean` |  |
| `linetoolnote.fontSize` | `number` |  |
| `linetoolnote.italic` | `boolean` |  |
| `linetoolnote.markerColor` | `string` |  |
| `linetoolnote.textColor` | `string` |  |

## NoteabsoluteLineToolOverrides {#noteabsolutelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolnoteabsolute.backgroundColor` | `string` |  |
| `linetoolnoteabsolute.backgroundTransparency` | `number` |  |
| `linetoolnoteabsolute.bold` | `boolean` |  |
| `linetoolnoteabsolute.borderColor` | `string` |  |
| `linetoolnoteabsolute.fixedSize` | `boolean` |  |
| `linetoolnoteabsolute.fontSize` | `number` |  |
| `linetoolnoteabsolute.italic` | `boolean` |  |
| `linetoolnoteabsolute.markerColor` | `string` |  |
| `linetoolnoteabsolute.textColor` | `string` |  |

## OrderLineToolOverrides {#orderlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolorder.bodyBackgroundColor` | `string` |  |
| `linetoolorder.bodyBackgroundTransparency` | `number` |  |
| `linetoolorder.bodyBorderActiveBuyColor` | `string` |  |
| `linetoolorder.bodyBorderActiveSellColor` | `string` |  |
| `linetoolorder.bodyBorderInactiveBuyColor` | `string` |  |
| `linetoolorder.bodyBorderInactiveSellColor` | `string` |  |
| `linetoolorder.bodyFontBold` | `boolean` |  |
| `linetoolorder.bodyFontFamily` | `string` |  |
| `linetoolorder.bodyFontItalic` | `boolean` |  |
| `linetoolorder.bodyFontSize` | `number` |  |
| `linetoolorder.bodyTextActiveBuyColor` | `string` |  |
| `linetoolorder.bodyTextActiveLimitColor` | `string` |  |
| `linetoolorder.bodyTextActiveSellColor` | `string` |  |
| `linetoolorder.bodyTextActiveStopColor` | `string` |  |
| `linetoolorder.bodyTextInactiveBuyColor` | `string` |  |
| `linetoolorder.bodyTextInactiveLimitColor` | `string` |  |
| `linetoolorder.bodyTextInactiveSellColor` | `string` |  |
| `linetoolorder.bodyTextInactiveStopColor` | `string` |  |
| `linetoolorder.cancelButtonBackgroundColor` | `string` |  |
| `linetoolorder.cancelButtonBackgroundTransparency` | `number` |  |
| `linetoolorder.cancelButtonBorderActiveBuyColor` | `string` |  |
| `linetoolorder.cancelButtonBorderActiveSellColor` | `string` |  |
| `linetoolorder.cancelButtonBorderInactiveBuyColor` | `string` |  |
| `linetoolorder.cancelButtonBorderInactiveSellColor` | `string` |  |
| `linetoolorder.cancelButtonIconActiveBuyColor` | `string` |  |
| `linetoolorder.cancelButtonIconActiveSellColor` | `string` |  |
| `linetoolorder.cancelButtonIconInactiveBuyColor` | `string` |  |
| `linetoolorder.cancelButtonIconInactiveSellColor` | `string` |  |
| `linetoolorder.cancelTooltip` | `string` |  |
| `linetoolorder.extendLeft` | `string` |  |
| `linetoolorder.lineActiveBuyColor` | `string` |  |
| `linetoolorder.lineActiveSellColor` | `string` |  |
| `linetoolorder.lineColor` | `string` |  |
| `linetoolorder.lineInactiveBuyColor` | `string` |  |
| `linetoolorder.lineInactiveSellColor` | `string` |  |
| `linetoolorder.lineLength` | `string` |  |
| `linetoolorder.lineLengthUnit` | `string` |  |
| `linetoolorder.lineStyle` | `string` |  |
| `linetoolorder.lineWidth` | `string` |  |
| `linetoolorder.modifyTooltip` | `string` |  |
| `linetoolorder.quantityBackgroundActiveBuyColor` | `string` |  |
| `linetoolorder.quantityBackgroundActiveSellColor` | `string` |  |
| `linetoolorder.quantityBackgroundInactiveBuyColor` | `string` |  |
| `linetoolorder.quantityBackgroundInactiveSellColor` | `string` |  |
| `linetoolorder.quantityBorderActiveBuyColor` | `string` |  |
| `linetoolorder.quantityBorderActiveSellColor` | `string` |  |
| `linetoolorder.quantityBorderInactiveBuyColor` | `string` |  |
| `linetoolorder.quantityBorderInactiveSellColor` | `string` |  |
| `linetoolorder.quantityFontBold` | `boolean` |  |
| `linetoolorder.quantityFontFamily` | `string` |  |
| `linetoolorder.quantityFontItalic` | `boolean` |  |
| `linetoolorder.quantityFontSize` | `number` |  |
| `linetoolorder.quantityTextColor` | `string` |  |
| `linetoolorder.quantityTextTransparency` | `number` |  |
| `linetoolorder.tooltip` | `string` |  |

## ParallelchannelLineToolOverrides {#parallelchannellinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolparallelchannel.backgroundColor` | `string` |  |
| `linetoolparallelchannel.extendLeft` | `boolean` |  |
| `linetoolparallelchannel.extendRight` | `boolean` |  |
| `linetoolparallelchannel.fillBackground` | `boolean` |  |
| `linetoolparallelchannel.labelBold` | `boolean` |  |
| `linetoolparallelchannel.labelFontSize` | `number` |  |
| `linetoolparallelchannel.labelHorzAlign` | `string` |  |
| `linetoolparallelchannel.labelItalic` | `boolean` |  |
| `linetoolparallelchannel.labelTextColor` | `string` |  |
| `linetoolparallelchannel.labelVertAlign` | `string` |  |
| `linetoolparallelchannel.labelVisible` | `boolean` |  |
| `linetoolparallelchannel.linecolor` | `string` |  |
| `linetoolparallelchannel.linestyle` | `number` |  |
| `linetoolparallelchannel.linewidth` | `number` |  |
| `linetoolparallelchannel.midlinecolor` | `string` |  |
| `linetoolparallelchannel.midlinestyle` | `number` |  |
| `linetoolparallelchannel.midlinewidth` | `number` |  |
| `linetoolparallelchannel.showMidline` | `boolean` |  |
| `linetoolparallelchannel.transparency` | `number` |  |

## PathLineToolOverrides {#pathlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolpath.leftEnd` | `number` |  |
| `linetoolpath.lineColor` | `string` |  |
| `linetoolpath.lineStyle` | `number` |  |
| `linetoolpath.lineWidth` | `number` |  |
| `linetoolpath.rightEnd` | `number` |  |

## PitchfanLineToolOverrides {#pitchfanlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolpitchfan.fillBackground` | `boolean` |  |
| `linetoolpitchfan.level0.coeff` | `number` |  |
| `linetoolpitchfan.level0.color` | `string` |  |
| `linetoolpitchfan.level0.linestyle` | `number` |  |
| `linetoolpitchfan.level0.linewidth` | `number` |  |
| `linetoolpitchfan.level0.visible` | `boolean` |  |
| `linetoolpitchfan.level1.coeff` | `number` |  |
| `linetoolpitchfan.level1.color` | `string` |  |
| `linetoolpitchfan.level1.linestyle` | `number` |  |
| `linetoolpitchfan.level1.linewidth` | `number` |  |
| `linetoolpitchfan.level1.visible` | `boolean` |  |
| `linetoolpitchfan.level2.coeff` | `number` |  |
| `linetoolpitchfan.level2.color` | `string` |  |
| `linetoolpitchfan.level2.linestyle` | `number` |  |
| `linetoolpitchfan.level2.linewidth` | `number` |  |
| `linetoolpitchfan.level2.visible` | `boolean` |  |
| `linetoolpitchfan.level3.coeff` | `number` |  |
| `linetoolpitchfan.level3.color` | `string` |  |
| `linetoolpitchfan.level3.linestyle` | `number` |  |
| `linetoolpitchfan.level3.linewidth` | `number` |  |
| `linetoolpitchfan.level3.visible` | `boolean` |  |
| `linetoolpitchfan.level4.coeff` | `number` |  |
| `linetoolpitchfan.level4.color` | `string` |  |
| `linetoolpitchfan.level4.linestyle` | `number` |  |
| `linetoolpitchfan.level4.linewidth` | `number` |  |
| `linetoolpitchfan.level4.visible` | `boolean` |  |
| `linetoolpitchfan.level5.coeff` | `number` |  |
| `linetoolpitchfan.level5.color` | `string` |  |
| `linetoolpitchfan.level5.linestyle` | `number` |  |
| `linetoolpitchfan.level5.linewidth` | `number` |  |
| `linetoolpitchfan.level5.visible` | `boolean` |  |
| `linetoolpitchfan.level6.coeff` | `number` |  |
| `linetoolpitchfan.level6.color` | `string` |  |
| `linetoolpitchfan.level6.linestyle` | `number` |  |
| `linetoolpitchfan.level6.linewidth` | `number` |  |
| `linetoolpitchfan.level6.visible` | `boolean` |  |
| `linetoolpitchfan.level7.coeff` | `number` |  |
| `linetoolpitchfan.level7.color` | `string` |  |
| `linetoolpitchfan.level7.linestyle` | `number` |  |
| `linetoolpitchfan.level7.linewidth` | `number` |  |
| `linetoolpitchfan.level7.visible` | `boolean` |  |
| `linetoolpitchfan.level8.coeff` | `number` |  |
| `linetoolpitchfan.level8.color` | `string` |  |
| `linetoolpitchfan.level8.linestyle` | `number` |  |
| `linetoolpitchfan.level8.linewidth` | `number` |  |
| `linetoolpitchfan.level8.visible` | `boolean` |  |
| `linetoolpitchfan.median.color` | `string` |  |
| `linetoolpitchfan.median.linestyle` | `number` |  |
| `linetoolpitchfan.median.linewidth` | `number` |  |
| `linetoolpitchfan.median.visible` | `boolean` |  |
| `linetoolpitchfan.transparency` | `number` |  |

## PitchforkLineToolOverrides {#pitchforklinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolpitchfork.extendLines` | `boolean` |  |
| `linetoolpitchfork.fillBackground` | `boolean` |  |
| `linetoolpitchfork.level0.coeff` | `number` |  |
| `linetoolpitchfork.level0.color` | `string` |  |
| `linetoolpitchfork.level0.linestyle` | `number` |  |
| `linetoolpitchfork.level0.linewidth` | `number` |  |
| `linetoolpitchfork.level0.visible` | `boolean` |  |
| `linetoolpitchfork.level1.coeff` | `number` |  |
| `linetoolpitchfork.level1.color` | `string` |  |
| `linetoolpitchfork.level1.linestyle` | `number` |  |
| `linetoolpitchfork.level1.linewidth` | `number` |  |
| `linetoolpitchfork.level1.visible` | `boolean` |  |
| `linetoolpitchfork.level2.coeff` | `number` |  |
| `linetoolpitchfork.level2.color` | `string` |  |
| `linetoolpitchfork.level2.linestyle` | `number` |  |
| `linetoolpitchfork.level2.linewidth` | `number` |  |
| `linetoolpitchfork.level2.visible` | `boolean` |  |
| `linetoolpitchfork.level3.coeff` | `number` |  |
| `linetoolpitchfork.level3.color` | `string` |  |
| `linetoolpitchfork.level3.linestyle` | `number` |  |
| `linetoolpitchfork.level3.linewidth` | `number` |  |
| `linetoolpitchfork.level3.visible` | `boolean` |  |
| `linetoolpitchfork.level4.coeff` | `number` |  |
| `linetoolpitchfork.level4.color` | `string` |  |
| `linetoolpitchfork.level4.linestyle` | `number` |  |
| `linetoolpitchfork.level4.linewidth` | `number` |  |
| `linetoolpitchfork.level4.visible` | `boolean` |  |
| `linetoolpitchfork.level5.coeff` | `number` |  |
| `linetoolpitchfork.level5.color` | `string` |  |
| `linetoolpitchfork.level5.linestyle` | `number` |  |
| `linetoolpitchfork.level5.linewidth` | `number` |  |
| `linetoolpitchfork.level5.visible` | `boolean` |  |
| `linetoolpitchfork.level6.coeff` | `number` |  |
| `linetoolpitchfork.level6.color` | `string` |  |
| `linetoolpitchfork.level6.linestyle` | `number` |  |
| `linetoolpitchfork.level6.linewidth` | `number` |  |
| `linetoolpitchfork.level6.visible` | `boolean` |  |
| `linetoolpitchfork.level7.coeff` | `number` |  |
| `linetoolpitchfork.level7.color` | `string` |  |
| `linetoolpitchfork.level7.linestyle` | `number` |  |
| `linetoolpitchfork.level7.linewidth` | `number` |  |
| `linetoolpitchfork.level7.visible` | `boolean` |  |
| `linetoolpitchfork.level8.coeff` | `number` |  |
| `linetoolpitchfork.level8.color` | `string` |  |
| `linetoolpitchfork.level8.linestyle` | `number` |  |
| `linetoolpitchfork.level8.linewidth` | `number` |  |
| `linetoolpitchfork.level8.visible` | `boolean` |  |
| `linetoolpitchfork.median.color` | `string` |  |
| `linetoolpitchfork.median.linestyle` | `number` |  |
| `linetoolpitchfork.median.linewidth` | `number` |  |
| `linetoolpitchfork.median.visible` | `boolean` |  |
| `linetoolpitchfork.style` | `number` |  |
| `linetoolpitchfork.transparency` | `number` |  |

## PolylineLineToolOverrides {#polylinelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolpolyline.backgroundColor` | `string` |  |
| `linetoolpolyline.fillBackground` | `boolean` |  |
| `linetoolpolyline.filled` | `boolean` |  |
| `linetoolpolyline.linecolor` | `string` |  |
| `linetoolpolyline.linestyle` | `number` |  |
| `linetoolpolyline.linewidth` | `number` |  |
| `linetoolpolyline.transparency` | `number` |  |

## PositionLineToolOverrides {#positionlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolposition.bodyBackgroundColor` | `string` |  |
| `linetoolposition.bodyBackgroundTransparency` | `number` |  |
| `linetoolposition.bodyBorderBuyColor` | `string` |  |
| `linetoolposition.bodyBorderSellColor` | `string` |  |
| `linetoolposition.bodyFontBold` | `boolean` |  |
| `linetoolposition.bodyFontFamily` | `string` |  |
| `linetoolposition.bodyFontItalic` | `boolean` |  |
| `linetoolposition.bodyFontSize` | `number` |  |
| `linetoolposition.bodyTextNegativeColor` | `string` |  |
| `linetoolposition.bodyTextNeutralColor` | `string` |  |
| `linetoolposition.bodyTextPositiveColor` | `string` |  |
| `linetoolposition.closeButtonBackgroundColor` | `string` |  |
| `linetoolposition.closeButtonBackgroundTransparency` | `number` |  |
| `linetoolposition.closeButtonBorderBuyColor` | `string` |  |
| `linetoolposition.closeButtonBorderSellColor` | `string` |  |
| `linetoolposition.closeButtonIconBuyColor` | `string` |  |
| `linetoolposition.closeButtonIconSellColor` | `string` |  |
| `linetoolposition.closeTooltip` | `string` |  |
| `linetoolposition.extendLeft` | `string` |  |
| `linetoolposition.lineBuyColor` | `string` |  |
| `linetoolposition.lineLength` | `string` |  |
| `linetoolposition.lineLengthUnit` | `string` |  |
| `linetoolposition.lineSellColor` | `string` |  |
| `linetoolposition.lineStyle` | `string` |  |
| `linetoolposition.lineWidth` | `string` |  |
| `linetoolposition.protectTooltip` | `string` |  |
| `linetoolposition.quantityBackgroundBuyColor` | `string` |  |
| `linetoolposition.quantityBackgroundSellColor` | `string` |  |
| `linetoolposition.quantityBorderBuyColor` | `string` |  |
| `linetoolposition.quantityBorderSellColor` | `string` |  |
| `linetoolposition.quantityFontBold` | `boolean` |  |
| `linetoolposition.quantityFontFamily` | `string` |  |
| `linetoolposition.quantityFontItalic` | `boolean` |  |
| `linetoolposition.quantityFontSize` | `number` |  |
| `linetoolposition.quantityTextColor` | `string` |  |
| `linetoolposition.quantityTextTransparency` | `number` |  |
| `linetoolposition.reverseButtonBackgroundColor` | `string` |  |
| `linetoolposition.reverseButtonBackgroundTransparency` | `number` |  |
| `linetoolposition.reverseButtonBorderBuyColor` | `string` |  |
| `linetoolposition.reverseButtonBorderSellColor` | `string` |  |
| `linetoolposition.reverseButtonIconBuyColor` | `string` |  |
| `linetoolposition.reverseButtonIconSellColor` | `string` |  |
| `linetoolposition.reverseTooltip` | `string` |  |
| `linetoolposition.tooltip` | `string` |  |

## PredictionLineToolOverrides {#predictionlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolprediction.centersColor` | `string` |  |
| `linetoolprediction.failureBackground` | `string` |  |
| `linetoolprediction.failureTextColor` | `string` |  |
| `linetoolprediction.intermediateBackColor` | `string` |  |
| `linetoolprediction.intermediateTextColor` | `string` |  |
| `linetoolprediction.linecolor` | `string` |  |
| `linetoolprediction.linewidth` | `number` |  |
| `linetoolprediction.sourceBackColor` | `string` |  |
| `linetoolprediction.sourceStrokeColor` | `string` |  |
| `linetoolprediction.sourceTextColor` | `string` |  |
| `linetoolprediction.successBackground` | `string` |  |
| `linetoolprediction.successTextColor` | `string` |  |
| `linetoolprediction.targetBackColor` | `string` |  |
| `linetoolprediction.targetStrokeColor` | `string` |  |
| `linetoolprediction.targetTextColor` | `string` |  |
| `linetoolprediction.transparency` | `number` |  |

## PricelabelLineToolOverrides {#pricelabellinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolpricelabel.backgroundColor` | `string` |  |
| `linetoolpricelabel.borderColor` | `string` |  |
| `linetoolpricelabel.color` | `string` |  |
| `linetoolpricelabel.fontsize` | `number` |  |
| `linetoolpricelabel.fontWeight` | `string` |  |
| `linetoolpricelabel.transparency` | `number` |  |

## ProjectionLineToolOverrides {#projectionlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolprojection.color1` | `string` |  |
| `linetoolprojection.color2` | `string` |  |
| `linetoolprojection.fillBackground` | `boolean` |  |
| `linetoolprojection.level1.coeff` | `number` |  |
| `linetoolprojection.level1.color` | `string` |  |
| `linetoolprojection.level1.linestyle` | `number` |  |
| `linetoolprojection.level1.linewidth` | `number` |  |
| `linetoolprojection.level1.visible` | `boolean` |  |
| `linetoolprojection.linewidth` | `number` |  |
| `linetoolprojection.showCoeffs` | `boolean` |  |
| `linetoolprojection.transparency` | `number` |  |
| `linetoolprojection.trendline.color` | `string` |  |
| `linetoolprojection.trendline.linestyle` | `number` |  |
| `linetoolprojection.trendline.visible` | `boolean` |  |

## RayLineToolOverrides {#raylinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolray.alwaysShowStats` | `boolean` |  |
| `linetoolray.bold` | `boolean` |  |
| `linetoolray.extendLeft` | `boolean` |  |
| `linetoolray.extendRight` | `boolean` |  |
| `linetoolray.fontsize` | `number` |  |
| `linetoolray.horzLabelsAlign` | `string` |  |
| `linetoolray.italic` | `boolean` |  |
| `linetoolray.leftEnd` | `number` |  |
| `linetoolray.linecolor` | `string` |  |
| `linetoolray.linestyle` | `number` |  |
| `linetoolray.linewidth` | `number` |  |
| `linetoolray.rightEnd` | `number` |  |
| `linetoolray.showAngle` | `boolean` |  |
| `linetoolray.showBarsRange` | `boolean` |  |
| `linetoolray.showDateTimeRange` | `boolean` |  |
| `linetoolray.showDistance` | `boolean` |  |
| `linetoolray.showLabel` | `boolean` |  |
| `linetoolray.showMiddlePoint` | `boolean` |  |
| `linetoolray.showPercentPriceRange` | `boolean` |  |
| `linetoolray.showPipsPriceRange` | `boolean` |  |
| `linetoolray.showPriceLabels` | `boolean` |  |
| `linetoolray.showPriceRange` | `boolean` |  |
| `linetoolray.statsPosition` | `number` |  |
| `linetoolray.textcolor` | `string` |  |
| `linetoolray.vertLabelsAlign` | `string` |  |

## RectangleLineToolOverrides {#rectanglelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolrectangle.backgroundColor` | `string` |  |
| `linetoolrectangle.bold` | `boolean` |  |
| `linetoolrectangle.color` | `string` |  |
| `linetoolrectangle.extendLeft` | `boolean` |  |
| `linetoolrectangle.extendRight` | `boolean` |  |
| `linetoolrectangle.fillBackground` | `boolean` |  |
| `linetoolrectangle.fontSize` | `number` |  |
| `linetoolrectangle.horzLabelsAlign` | `string` |  |
| `linetoolrectangle.italic` | `boolean` |  |
| `linetoolrectangle.linewidth` | `number` |  |
| `linetoolrectangle.middleLine.lineColor` | `string` |  |
| `linetoolrectangle.middleLine.lineStyle` | `number` |  |
| `linetoolrectangle.middleLine.lineWidth` | `number` |  |
| `linetoolrectangle.middleLine.showLine` | `boolean` |  |
| `linetoolrectangle.showLabel` | `boolean` |  |
| `linetoolrectangle.textColor` | `string` |  |
| `linetoolrectangle.transparency` | `number` |  |
| `linetoolrectangle.vertLabelsAlign` | `string` |  |

## RegressiontrendLineToolOverrides {#regressiontrendlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolregressiontrend.inputs.first bar time` | `number` |  |
| `linetoolregressiontrend.inputs.last bar time` | `number` |  |
| `linetoolregressiontrend.inputs.lower diviation` | `number` |  |
| `linetoolregressiontrend.inputs.source` | `string` |  |
| `linetoolregressiontrend.inputs.upper diviation` | `number` |  |
| `linetoolregressiontrend.inputs.use lower diviation` | `boolean` |  |
| `linetoolregressiontrend.inputs.use upper diviation` | `boolean` |  |
| `linetoolregressiontrend.linestyle` | `number` |  |
| `linetoolregressiontrend.linewidth` | `number` |  |
| `linetoolregressiontrend.precision` | `string` |  |
| `linetoolregressiontrend.styles.baseLine.color` | `string` |  |
| `linetoolregressiontrend.styles.baseLine.display` | `number` |  |
| `linetoolregressiontrend.styles.baseLine.linestyle` | `number` |  |
| `linetoolregressiontrend.styles.baseLine.linewidth` | `number` |  |
| `linetoolregressiontrend.styles.downLine.color` | `string` |  |
| `linetoolregressiontrend.styles.downLine.display` | `number` |  |
| `linetoolregressiontrend.styles.downLine.linestyle` | `number` |  |
| `linetoolregressiontrend.styles.downLine.linewidth` | `number` |  |
| `linetoolregressiontrend.styles.extendLines` | `boolean` |  |
| `linetoolregressiontrend.styles.showPearsons` | `boolean` |  |
| `linetoolregressiontrend.styles.transparency` | `number` |  |
| `linetoolregressiontrend.styles.upLine.color` | `string` |  |
| `linetoolregressiontrend.styles.upLine.display` | `number` |  |
| `linetoolregressiontrend.styles.upLine.linestyle` | `number` |  |
| `linetoolregressiontrend.styles.upLine.linewidth` | `number` |  |

## RiskrewardlongLineToolOverrides {#riskrewardlonglinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolriskrewardlong.accountSize` | `number` |  |
| `linetoolriskrewardlong.alwaysShowStats` | `boolean` |  |
| `linetoolriskrewardlong.borderColor` | `string` |  |
| `linetoolriskrewardlong.compact` | `boolean` |  |
| `linetoolriskrewardlong.drawBorder` | `boolean` |  |
| `linetoolriskrewardlong.fillBackground` | `boolean` |  |
| `linetoolriskrewardlong.fillLabelBackground` | `boolean` |  |
| `linetoolriskrewardlong.fontsize` | `number` |  |
| `linetoolriskrewardlong.labelBackgroundColor` | `string` |  |
| `linetoolriskrewardlong.linecolor` | `string` |  |
| `linetoolriskrewardlong.linewidth` | `number` |  |
| `linetoolriskrewardlong.lotSize` | `number` |  |
| `linetoolriskrewardlong.profitBackground` | `string` |  |
| `linetoolriskrewardlong.profitBackgroundTransparency` | `number` |  |
| `linetoolriskrewardlong.risk` | `number` |  |
| `linetoolriskrewardlong.riskDisplayMode` | `string` |  |
| `linetoolriskrewardlong.showPriceLabels` | `boolean` |  |
| `linetoolriskrewardlong.stopBackground` | `string` |  |
| `linetoolriskrewardlong.stopBackgroundTransparency` | `number` |  |
| `linetoolriskrewardlong.textcolor` | `string` |  |

## RiskrewardshortLineToolOverrides {#riskrewardshortlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolriskrewardshort.accountSize` | `number` |  |
| `linetoolriskrewardshort.alwaysShowStats` | `boolean` |  |
| `linetoolriskrewardshort.borderColor` | `string` |  |
| `linetoolriskrewardshort.compact` | `boolean` |  |
| `linetoolriskrewardshort.drawBorder` | `boolean` |  |
| `linetoolriskrewardshort.fillBackground` | `boolean` |  |
| `linetoolriskrewardshort.fillLabelBackground` | `boolean` |  |
| `linetoolriskrewardshort.fontsize` | `number` |  |
| `linetoolriskrewardshort.labelBackgroundColor` | `string` |  |
| `linetoolriskrewardshort.linecolor` | `string` |  |
| `linetoolriskrewardshort.linewidth` | `number` |  |
| `linetoolriskrewardshort.lotSize` | `number` |  |
| `linetoolriskrewardshort.profitBackground` | `string` |  |
| `linetoolriskrewardshort.profitBackgroundTransparency` | `number` |  |
| `linetoolriskrewardshort.risk` | `number` |  |
| `linetoolriskrewardshort.riskDisplayMode` | `string` |  |
| `linetoolriskrewardshort.showPriceLabels` | `boolean` |  |
| `linetoolriskrewardshort.stopBackground` | `string` |  |
| `linetoolriskrewardshort.stopBackgroundTransparency` | `number` |  |
| `linetoolriskrewardshort.textcolor` | `string` |  |

## RotatedrectangleLineToolOverrides {#rotatedrectanglelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolrotatedrectangle.backgroundColor` | `string` |  |
| `linetoolrotatedrectangle.color` | `string` |  |
| `linetoolrotatedrectangle.fillBackground` | `boolean` |  |
| `linetoolrotatedrectangle.linewidth` | `number` |  |
| `linetoolrotatedrectangle.transparency` | `number` |  |

## Schiffpitchfork2LineToolOverrides {#schiffpitchfork2linetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolschiffpitchfork2.extendLines` | `boolean` |  |
| `linetoolschiffpitchfork2.fillBackground` | `boolean` |  |
| `linetoolschiffpitchfork2.level0.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level0.color` | `string` |  |
| `linetoolschiffpitchfork2.level0.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level0.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level0.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level1.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level1.color` | `string` |  |
| `linetoolschiffpitchfork2.level1.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level1.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level1.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level2.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level2.color` | `string` |  |
| `linetoolschiffpitchfork2.level2.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level2.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level2.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level3.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level3.color` | `string` |  |
| `linetoolschiffpitchfork2.level3.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level3.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level3.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level4.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level4.color` | `string` |  |
| `linetoolschiffpitchfork2.level4.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level4.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level4.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level5.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level5.color` | `string` |  |
| `linetoolschiffpitchfork2.level5.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level5.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level5.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level6.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level6.color` | `string` |  |
| `linetoolschiffpitchfork2.level6.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level6.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level6.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level7.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level7.color` | `string` |  |
| `linetoolschiffpitchfork2.level7.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level7.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level7.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.level8.coeff` | `number` |  |
| `linetoolschiffpitchfork2.level8.color` | `string` |  |
| `linetoolschiffpitchfork2.level8.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.level8.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.level8.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.median.color` | `string` |  |
| `linetoolschiffpitchfork2.median.linestyle` | `number` |  |
| `linetoolschiffpitchfork2.median.linewidth` | `number` |  |
| `linetoolschiffpitchfork2.median.visible` | `boolean` |  |
| `linetoolschiffpitchfork2.style` | `number` |  |
| `linetoolschiffpitchfork2.transparency` | `number` |  |

## SchiffpitchforkLineToolOverrides {#schiffpitchforklinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolschiffpitchfork.extendLines` | `boolean` |  |
| `linetoolschiffpitchfork.fillBackground` | `boolean` |  |
| `linetoolschiffpitchfork.level0.coeff` | `number` |  |
| `linetoolschiffpitchfork.level0.color` | `string` |  |
| `linetoolschiffpitchfork.level0.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level0.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level0.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level1.coeff` | `number` |  |
| `linetoolschiffpitchfork.level1.color` | `string` |  |
| `linetoolschiffpitchfork.level1.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level1.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level1.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level2.coeff` | `number` |  |
| `linetoolschiffpitchfork.level2.color` | `string` |  |
| `linetoolschiffpitchfork.level2.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level2.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level2.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level3.coeff` | `number` |  |
| `linetoolschiffpitchfork.level3.color` | `string` |  |
| `linetoolschiffpitchfork.level3.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level3.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level3.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level4.coeff` | `number` |  |
| `linetoolschiffpitchfork.level4.color` | `string` |  |
| `linetoolschiffpitchfork.level4.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level4.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level4.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level5.coeff` | `number` |  |
| `linetoolschiffpitchfork.level5.color` | `string` |  |
| `linetoolschiffpitchfork.level5.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level5.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level5.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level6.coeff` | `number` |  |
| `linetoolschiffpitchfork.level6.color` | `string` |  |
| `linetoolschiffpitchfork.level6.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level6.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level6.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level7.coeff` | `number` |  |
| `linetoolschiffpitchfork.level7.color` | `string` |  |
| `linetoolschiffpitchfork.level7.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level7.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level7.visible` | `boolean` |  |
| `linetoolschiffpitchfork.level8.coeff` | `number` |  |
| `linetoolschiffpitchfork.level8.color` | `string` |  |
| `linetoolschiffpitchfork.level8.linestyle` | `number` |  |
| `linetoolschiffpitchfork.level8.linewidth` | `number` |  |
| `linetoolschiffpitchfork.level8.visible` | `boolean` |  |
| `linetoolschiffpitchfork.median.color` | `string` |  |
| `linetoolschiffpitchfork.median.linestyle` | `number` |  |
| `linetoolschiffpitchfork.median.linewidth` | `number` |  |
| `linetoolschiffpitchfork.median.visible` | `boolean` |  |
| `linetoolschiffpitchfork.style` | `number` |  |
| `linetoolschiffpitchfork.transparency` | `number` |  |

## SignpostLineToolOverrides {#signpostlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolsignpost.bold` | `boolean` |  |
| `linetoolsignpost.emoji` | `string` |  |
| `linetoolsignpost.fontSize` | `number` |  |
| `linetoolsignpost.italic` | `boolean` |  |
| `linetoolsignpost.itemType` | `number` |  |
| `linetoolsignpost.plateColor` | `string` |  |
| `linetoolsignpost.showImage` | `boolean` |  |

## SinelineLineToolOverrides {#sinelinelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolsineline.linecolor` | `string` |  |
| `linetoolsineline.linestyle` | `number` |  |
| `linetoolsineline.linewidth` | `number` |  |

## StickerLineToolOverrides {#stickerlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolsticker.angle` | `number` |  |
| `linetoolsticker.size` | `number` |  |
| `linetoolsticker.sticker` | `string` |  |

## TextLineToolOverrides {#textlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltext.backgroundColor` | `string` |  |
| `linetooltext.backgroundTransparency` | `number` |  |
| `linetooltext.bold` | `boolean` |  |
| `linetooltext.borderColor` | `string` |  |
| `linetooltext.color` | `string` |  |
| `linetooltext.drawBorder` | `boolean` |  |
| `linetooltext.fillBackground` | `boolean` |  |
| `linetooltext.fixedSize` | `boolean` |  |
| `linetooltext.fontsize` | `number` |  |
| `linetooltext.italic` | `boolean` |  |
| `linetooltext.wordWrap` | `boolean` |  |
| `linetooltext.wordWrapWidth` | `number` |  |

## TextabsoluteLineToolOverrides {#textabsolutelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltextabsolute.backgroundColor` | `string` |  |
| `linetooltextabsolute.backgroundTransparency` | `number` |  |
| `linetooltextabsolute.bold` | `boolean` |  |
| `linetooltextabsolute.borderColor` | `string` |  |
| `linetooltextabsolute.color` | `string` |  |
| `linetooltextabsolute.drawBorder` | `boolean` |  |
| `linetooltextabsolute.fillBackground` | `boolean` |  |
| `linetooltextabsolute.fixedSize` | `boolean` |  |
| `linetooltextabsolute.fontsize` | `number` |  |
| `linetooltextabsolute.italic` | `boolean` |  |
| `linetooltextabsolute.wordWrap` | `boolean` |  |
| `linetooltextabsolute.wordWrapWidth` | `number` |  |

## ThreedriversLineToolOverrides {#threedriverslinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolthreedrivers.backgroundColor` | `string` |  |
| `linetoolthreedrivers.bold` | `boolean` |  |
| `linetoolthreedrivers.color` | `string` |  |
| `linetoolthreedrivers.fillBackground` | `boolean` |  |
| `linetoolthreedrivers.fontsize` | `number` |  |
| `linetoolthreedrivers.italic` | `boolean` |  |
| `linetoolthreedrivers.linewidth` | `number` |  |
| `linetoolthreedrivers.textcolor` | `string` |  |
| `linetoolthreedrivers.transparency` | `number` |  |

## TimecyclesLineToolOverrides {#timecycleslinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltimecycles.backgroundColor` | `string` |  |
| `linetooltimecycles.fillBackground` | `boolean` |  |
| `linetooltimecycles.linecolor` | `string` |  |
| `linetooltimecycles.linestyle` | `number` |  |
| `linetooltimecycles.linewidth` | `number` |  |
| `linetooltimecycles.transparency` | `number` |  |

## TrendangleLineToolOverrides {#trendanglelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltrendangle.alwaysShowStats` | `boolean` |  |
| `linetooltrendangle.bold` | `boolean` |  |
| `linetooltrendangle.extendLeft` | `boolean` |  |
| `linetooltrendangle.extendRight` | `boolean` |  |
| `linetooltrendangle.fontsize` | `number` |  |
| `linetooltrendangle.italic` | `boolean` |  |
| `linetooltrendangle.linecolor` | `string` |  |
| `linetooltrendangle.linestyle` | `number` |  |
| `linetooltrendangle.linewidth` | `number` |  |
| `linetooltrendangle.showBarsRange` | `boolean` |  |
| `linetooltrendangle.showMiddlePoint` | `boolean` |  |
| `linetooltrendangle.showPercentPriceRange` | `boolean` |  |
| `linetooltrendangle.showPipsPriceRange` | `boolean` |  |
| `linetooltrendangle.showPriceLabels` | `boolean` |  |
| `linetooltrendangle.showPriceRange` | `boolean` |  |
| `linetooltrendangle.statsPosition` | `number` |  |
| `linetooltrendangle.textcolor` | `string` |  |

## TrendbasedfibextensionLineToolOverrides {#trendbasedfibextensionlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltrendbasedfibextension.coeffsAsPercents` | `boolean` |  |
| `linetooltrendbasedfibextension.extendLines` | `boolean` |  |
| `linetooltrendbasedfibextension.extendLinesLeft` | `boolean` |  |
| `linetooltrendbasedfibextension.fibLevelsBasedOnLogScale` | `boolean` |  |
| `linetooltrendbasedfibextension.fillBackground` | `boolean` |  |
| `linetooltrendbasedfibextension.horzLabelsAlign` | `string` |  |
| `linetooltrendbasedfibextension.labelFontSize` | `number` |  |
| `linetooltrendbasedfibextension.level1.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level1.color` | `string` |  |
| `linetooltrendbasedfibextension.level1.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level10.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level10.color` | `string` |  |
| `linetooltrendbasedfibextension.level10.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level11.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level11.color` | `string` |  |
| `linetooltrendbasedfibextension.level11.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level12.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level12.color` | `string` |  |
| `linetooltrendbasedfibextension.level12.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level13.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level13.color` | `string` |  |
| `linetooltrendbasedfibextension.level13.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level14.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level14.color` | `string` |  |
| `linetooltrendbasedfibextension.level14.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level15.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level15.color` | `string` |  |
| `linetooltrendbasedfibextension.level15.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level16.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level16.color` | `string` |  |
| `linetooltrendbasedfibextension.level16.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level17.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level17.color` | `string` |  |
| `linetooltrendbasedfibextension.level17.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level18.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level18.color` | `string` |  |
| `linetooltrendbasedfibextension.level18.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level19.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level19.color` | `string` |  |
| `linetooltrendbasedfibextension.level19.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level2.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level2.color` | `string` |  |
| `linetooltrendbasedfibextension.level2.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level20.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level20.color` | `string` |  |
| `linetooltrendbasedfibextension.level20.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level21.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level21.color` | `string` |  |
| `linetooltrendbasedfibextension.level21.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level22.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level22.color` | `string` |  |
| `linetooltrendbasedfibextension.level22.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level23.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level23.color` | `string` |  |
| `linetooltrendbasedfibextension.level23.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level24.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level24.color` | `string` |  |
| `linetooltrendbasedfibextension.level24.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level3.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level3.color` | `string` |  |
| `linetooltrendbasedfibextension.level3.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level4.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level4.color` | `string` |  |
| `linetooltrendbasedfibextension.level4.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level5.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level5.color` | `string` |  |
| `linetooltrendbasedfibextension.level5.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level6.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level6.color` | `string` |  |
| `linetooltrendbasedfibextension.level6.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level7.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level7.color` | `string` |  |
| `linetooltrendbasedfibextension.level7.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level8.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level8.color` | `string` |  |
| `linetooltrendbasedfibextension.level8.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.level9.coeff` | `number` |  |
| `linetooltrendbasedfibextension.level9.color` | `string` |  |
| `linetooltrendbasedfibextension.level9.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.levelsStyle.linestyle` | `number` |  |
| `linetooltrendbasedfibextension.levelsStyle.linewidth` | `number` |  |
| `linetooltrendbasedfibextension.reverse` | `boolean` |  |
| `linetooltrendbasedfibextension.showCoeffs` | `boolean` |  |
| `linetooltrendbasedfibextension.showPrices` | `boolean` |  |
| `linetooltrendbasedfibextension.transparency` | `number` |  |
| `linetooltrendbasedfibextension.trendline.color` | `string` |  |
| `linetooltrendbasedfibextension.trendline.linestyle` | `number` |  |
| `linetooltrendbasedfibextension.trendline.linewidth` | `number` |  |
| `linetooltrendbasedfibextension.trendline.visible` | `boolean` |  |
| `linetooltrendbasedfibextension.vertLabelsAlign` | `string` |  |

## TrendbasedfibtimeLineToolOverrides {#trendbasedfibtimelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltrendbasedfibtime.fillBackground` | `boolean` |  |
| `linetooltrendbasedfibtime.horzLabelsAlign` | `string` |  |
| `linetooltrendbasedfibtime.level1.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level1.color` | `string` |  |
| `linetooltrendbasedfibtime.level1.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level1.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level1.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level10.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level10.color` | `string` |  |
| `linetooltrendbasedfibtime.level10.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level10.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level10.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level11.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level11.color` | `string` |  |
| `linetooltrendbasedfibtime.level11.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level11.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level11.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level2.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level2.color` | `string` |  |
| `linetooltrendbasedfibtime.level2.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level2.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level2.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level3.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level3.color` | `string` |  |
| `linetooltrendbasedfibtime.level3.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level3.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level3.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level4.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level4.color` | `string` |  |
| `linetooltrendbasedfibtime.level4.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level4.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level4.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level5.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level5.color` | `string` |  |
| `linetooltrendbasedfibtime.level5.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level5.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level5.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level6.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level6.color` | `string` |  |
| `linetooltrendbasedfibtime.level6.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level6.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level6.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level7.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level7.color` | `string` |  |
| `linetooltrendbasedfibtime.level7.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level7.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level7.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level8.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level8.color` | `string` |  |
| `linetooltrendbasedfibtime.level8.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level8.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level8.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.level9.coeff` | `number` |  |
| `linetooltrendbasedfibtime.level9.color` | `string` |  |
| `linetooltrendbasedfibtime.level9.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.level9.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.level9.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.showCoeffs` | `boolean` |  |
| `linetooltrendbasedfibtime.transparency` | `number` |  |
| `linetooltrendbasedfibtime.trendline.color` | `string` |  |
| `linetooltrendbasedfibtime.trendline.linestyle` | `number` |  |
| `linetooltrendbasedfibtime.trendline.linewidth` | `number` |  |
| `linetooltrendbasedfibtime.trendline.visible` | `boolean` |  |
| `linetooltrendbasedfibtime.vertLabelsAlign` | `string` |  |

## TrendlineLineToolOverrides {#trendlinelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltrendline.alwaysShowStats` | `boolean` |  |
| `linetooltrendline.bold` | `boolean` |  |
| `linetooltrendline.extendLeft` | `boolean` |  |
| `linetooltrendline.extendRight` | `boolean` |  |
| `linetooltrendline.fontsize` | `number` |  |
| `linetooltrendline.horzLabelsAlign` | `string` |  |
| `linetooltrendline.italic` | `boolean` |  |
| `linetooltrendline.leftEnd` | `number` |  |
| `linetooltrendline.linecolor` | `string` |  |
| `linetooltrendline.linestyle` | `number` |  |
| `linetooltrendline.linewidth` | `number` |  |
| `linetooltrendline.rightEnd` | `number` |  |
| `linetooltrendline.showAngle` | `boolean` |  |
| `linetooltrendline.showBarsRange` | `boolean` |  |
| `linetooltrendline.showDateTimeRange` | `boolean` |  |
| `linetooltrendline.showDistance` | `boolean` |  |
| `linetooltrendline.showLabel` | `boolean` |  |
| `linetooltrendline.showMiddlePoint` | `boolean` |  |
| `linetooltrendline.showPercentPriceRange` | `boolean` |  |
| `linetooltrendline.showPipsPriceRange` | `boolean` |  |
| `linetooltrendline.showPriceLabels` | `boolean` |  |
| `linetooltrendline.showPriceRange` | `boolean` |  |
| `linetooltrendline.statsPosition` | `number` |  |
| `linetooltrendline.textcolor` | `string` |  |
| `linetooltrendline.vertLabelsAlign` | `string` |  |

## TriangleLineToolOverrides {#trianglelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltriangle.backgroundColor` | `string` |  |
| `linetooltriangle.color` | `string` |  |
| `linetooltriangle.fillBackground` | `boolean` |  |
| `linetooltriangle.linewidth` | `number` |  |
| `linetooltriangle.transparency` | `number` |  |

## TrianglepatternLineToolOverrides {#trianglepatternlinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetooltrianglepattern.backgroundColor` | `string` |  |
| `linetooltrianglepattern.bold` | `boolean` |  |
| `linetooltrianglepattern.color` | `string` |  |
| `linetooltrianglepattern.fillBackground` | `boolean` |  |
| `linetooltrianglepattern.fontsize` | `number` |  |
| `linetooltrianglepattern.italic` | `boolean` |  |
| `linetooltrianglepattern.linewidth` | `number` |  |
| `linetooltrianglepattern.textcolor` | `string` |  |
| `linetooltrianglepattern.transparency` | `number` |  |

## VertlineLineToolOverrides {#vertlinelinetooloverrides}

| Property | Type | Default |
| --- | --- | --- |
| `linetoolvertline.bold` | `boolean` |  |
| `linetoolvertline.extendLine` | `boolean` |  |
| `linetoolvertline.fontsize` | `number` |  |
| `linetoolvertline.horzLabelsAlign` | `string` |  |
| `linetoolvertline.italic` | `boolean` |  |
| `linetoolvertline.linecolor` | `string` |  |
| `linetoolvertline.linestyle` | `number` |  |
| `linetoolvertline.linewidth` | `number` |  |
| `linetoolvertline.showLabel` | `boolean` |  |
| `linetoolvertline.showTime` | `boolean` |  |
| `linetoolvertline.textcolor` | `string` |  |
| `linetoolvertline.textOrientation` | `string` |  |
| `linetoolvertline.vertLabelsAlign` | `string` |  |

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


---

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

[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.

```ts
export type DrawingEventType =
  | "click"
  | "move"
  | "remove"
  | "hide"
  | "show"
  | "create"
  | "properties_changed"
  | "points_changed";
```

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


---

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

[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.

```ts
export type DrawingOverrides =
  | FivepointspatternLineToolOverrides
  | AbcdLineToolOverrides
  | AnchoredvwapLineToolOverrides
  | ArcLineToolOverrides
  | ArrowLineToolOverrides
  | ArrowmarkdownLineToolOverrides
  | ArrowmarkerLineToolOverrides
  | ArrowmarkleftLineToolOverrides
  | ArrowmarkrightLineToolOverrides
  | ArrowmarkupLineToolOverrides
  | BalloonLineToolOverrides
  | BarspatternLineToolOverrides
  | BeziercubicLineToolOverrides
  | BezierquadroLineToolOverrides
  | BrushLineToolOverrides
  | CalloutLineToolOverrides
  | CircleLineToolOverrides
  | CommentLineToolOverrides
  | CrosslineLineToolOverrides
  | CypherpatternLineToolOverrides
  | DisjointangleLineToolOverrides
  | ElliottcorrectionLineToolOverrides
  | ElliottdoublecomboLineToolOverrides
  | ElliottimpulseLineToolOverrides
  | ElliotttriangleLineToolOverrides
  | ElliotttriplecomboLineToolOverrides
  | EllipseLineToolOverrides
  | EmojiLineToolOverrides
  | ExecutionLineToolOverrides
  | ExtendedLineToolOverrides
  | FibchannelLineToolOverrides
  | FibcirclesLineToolOverrides
  | FibretracementLineToolOverrides
  | FibspeedresistancearcsLineToolOverrides
  | FibspeedresistancefanLineToolOverrides
  | FibtimezoneLineToolOverrides
  | FibwedgeLineToolOverrides
  | FlagmarkLineToolOverrides
  | FlatbottomLineToolOverrides
  | GanncomplexLineToolOverrides
  | GannfanLineToolOverrides
  | GannfixedLineToolOverrides
  | GannsquareLineToolOverrides
  | GhostfeedLineToolOverrides
  | HeadandshouldersLineToolOverrides
  | HighlighterLineToolOverrides
  | HorzlineLineToolOverrides
  | HorzrayLineToolOverrides
  | IconLineToolOverrides
  | ImageLineToolOverrides
  | InfolineLineToolOverrides
  | InsidepitchforkLineToolOverrides
  | NoteLineToolOverrides
  | NoteabsoluteLineToolOverrides
  | OrderLineToolOverrides
  | ParallelchannelLineToolOverrides
  | PathLineToolOverrides
  | PitchfanLineToolOverrides
  | PitchforkLineToolOverrides
  | PolylineLineToolOverrides
  | PositionLineToolOverrides
  | PredictionLineToolOverrides
  | PricelabelLineToolOverrides
  | ProjectionLineToolOverrides
  | RayLineToolOverrides
  | RectangleLineToolOverrides
  | RegressiontrendLineToolOverrides
  | RiskrewardlongLineToolOverrides
  | RiskrewardshortLineToolOverrides
  | RotatedrectangleLineToolOverrides
  | SchiffpitchforkLineToolOverrides
  | Schiffpitchfork2LineToolOverrides
  | SignpostLineToolOverrides
  | SinelineLineToolOverrides
  | StickerLineToolOverrides
  | TextLineToolOverrides
  | TextabsoluteLineToolOverrides
  | ThreedriversLineToolOverrides
  | TimecyclesLineToolOverrides
  | TrendangleLineToolOverrides
  | TrendbasedfibextensionLineToolOverrides
  | TrendbasedfibtimeLineToolOverrides
  | TrendlineLineToolOverrides
  | TriangleLineToolOverrides
  | TrianglepatternLineToolOverrides
  | VertlineLineToolOverrides;
```

## Related types

- [FivepointspatternLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fivepointspatternlinetooloverrides)
- [AbcdLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#abcdlinetooloverrides)
- [AnchoredvwapLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#anchoredvwaplinetooloverrides)
- [ArcLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arclinetooloverrides)
- [ArrowLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowlinetooloverrides)
- [ArrowmarkdownLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkdownlinetooloverrides)
- [ArrowmarkerLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkerlinetooloverrides)
- [ArrowmarkleftLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkleftlinetooloverrides)
- [ArrowmarkrightLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkrightlinetooloverrides)
- [ArrowmarkupLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#arrowmarkuplinetooloverrides)
- [BalloonLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#balloonlinetooloverrides)
- [BarspatternLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#barspatternlinetooloverrides)
- [BeziercubicLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#beziercubiclinetooloverrides)
- [BezierquadroLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#bezierquadrolinetooloverrides)
- [BrushLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#brushlinetooloverrides)
- [CalloutLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#calloutlinetooloverrides)
- [CircleLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#circlelinetooloverrides)
- [CommentLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#commentlinetooloverrides)
- [CrosslineLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#crosslinelinetooloverrides)
- [CypherpatternLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#cypherpatternlinetooloverrides)
- [DisjointangleLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#disjointanglelinetooloverrides)
- [ElliottcorrectionLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliottcorrectionlinetooloverrides)
- [ElliottdoublecomboLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliottdoublecombolinetooloverrides)
- [ElliottimpulseLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliottimpulselinetooloverrides)
- [ElliotttriangleLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliotttrianglelinetooloverrides)
- [ElliotttriplecomboLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#elliotttriplecombolinetooloverrides)
- [EllipseLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#ellipselinetooloverrides)
- [EmojiLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#emojilinetooloverrides)
- [ExecutionLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#executionlinetooloverrides)
- [ExtendedLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#extendedlinetooloverrides)
- [FibchannelLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibchannellinetooloverrides)
- [FibcirclesLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibcircleslinetooloverrides)
- [FibretracementLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibretracementlinetooloverrides)
- [FibspeedresistancearcsLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibspeedresistancearcslinetooloverrides)
- [FibspeedresistancefanLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibspeedresistancefanlinetooloverrides)
- [FibtimezoneLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibtimezonelinetooloverrides)
- [FibwedgeLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#fibwedgelinetooloverrides)
- [FlagmarkLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#flagmarklinetooloverrides)
- [FlatbottomLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#flatbottomlinetooloverrides)
- [GanncomplexLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#ganncomplexlinetooloverrides)
- [GannfanLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#gannfanlinetooloverrides)
- [GannfixedLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#gannfixedlinetooloverrides)
- [GannsquareLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#gannsquarelinetooloverrides)
- [GhostfeedLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#ghostfeedlinetooloverrides)
- [HeadandshouldersLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#headandshoulderslinetooloverrides)
- [HighlighterLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#highlighterlinetooloverrides)
- [HorzlineLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#horzlinelinetooloverrides)
- [HorzrayLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#horzraylinetooloverrides)
- [IconLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#iconlinetooloverrides)
- [ImageLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#imagelinetooloverrides)
- [InfolineLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#infolinelinetooloverrides)
- [InsidepitchforkLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#insidepitchforklinetooloverrides)
- [NoteLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#notelinetooloverrides)
- [NoteabsoluteLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#noteabsolutelinetooloverrides)
- [OrderLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#orderlinetooloverrides)
- [ParallelchannelLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#parallelchannellinetooloverrides)
- [PathLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pathlinetooloverrides)
- [PitchfanLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pitchfanlinetooloverrides)
- [PitchforkLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pitchforklinetooloverrides)
- [PolylineLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#polylinelinetooloverrides)
- [PositionLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#positionlinetooloverrides)
- [PredictionLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#predictionlinetooloverrides)
- [PricelabelLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#pricelabellinetooloverrides)
- [ProjectionLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#projectionlinetooloverrides)
- [RayLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#raylinetooloverrides)
- [RectangleLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#rectanglelinetooloverrides)
- [RegressiontrendLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#regressiontrendlinetooloverrides)
- [RiskrewardlongLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#riskrewardlonglinetooloverrides)
- [RiskrewardshortLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#riskrewardshortlinetooloverrides)
- [RotatedrectangleLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#rotatedrectanglelinetooloverrides)
- [SchiffpitchforkLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#schiffpitchforklinetooloverrides)
- [Schiffpitchfork2LineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#schiffpitchfork2linetooloverrides)
- [SignpostLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#signpostlinetooloverrides)
- [SinelineLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#sinelinelinetooloverrides)
- [StickerLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#stickerlinetooloverrides)
- [TextLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#textlinetooloverrides)
- [TextabsoluteLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#textabsolutelinetooloverrides)
- [ThreedriversLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#threedriverslinetooloverrides)
- [TimecyclesLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#timecycleslinetooloverrides)
- [TrendangleLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendanglelinetooloverrides)
- [TrendbasedfibextensionLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendbasedfibextensionlinetooloverrides)
- [TrendbasedfibtimeLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendbasedfibtimelinetooloverrides)
- [TrendlineLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trendlinelinetooloverrides)
- [TriangleLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trianglelinetooloverrides)
- [TrianglepatternLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#trianglepatternlinetooloverrides)
- [VertlineLineToolOverrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides#vertlinelinetooloverrides)

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


---

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

[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.

```ts
export type DrawingToolIdentifier =
  | "arrow"
  | "cursor"
  | "dot"
  | "eraser"
  | "LineTool5PointsPattern"
  | "LineToolABCD"
  | "LineToolArc"
  | "LineToolArrow"
  | "LineToolArrowMarkDown"
  | "LineToolArrowMarker"
  | "LineToolArrowMarkLeft"
  | "LineToolArrowMarkRight"
  | "LineToolArrowMarkUp"
  | "LineToolBarsPattern"
  | "LineToolBezierCubic"
  | "LineToolBezierQuadro"
  | "LineToolBrush"
  | "LineToolCallout"
  | "LineToolCircle"
  | "LineToolCircleLines"
  | "LineToolComment"
  | "LineToolCrossLine"
  | "LineToolCypherPattern"
  | "LineToolDateAndPriceRange"
  | "LineToolDateRange"
  | "LineToolDisjointAngle"
  | "LineToolElliottCorrection"
  | "LineToolElliottDoubleCombo"
  | "LineToolElliottImpulse"
  | "LineToolElliottTriangle"
  | "LineToolElliottTripleCombo"
  | "LineToolEllipse"
  | "LineToolExtended"
  | "LineToolFibChannel"
  | "LineToolFibCircles"
  | "LineToolFibRetracement"
  | "LineToolFibSpeedResistanceArcs"
  | "LineToolFibSpeedResistanceFan"
  | "LineToolFibSpiral"
  | "LineToolFibTimeZone"
  | "LineToolFibWedge"
  | "LineToolFixedRangeVolumeProfile"
  | "LineToolFlagMark"
  | "LineToolFlatBottom"
  | "LineToolGannComplex"
  | "LineToolGannFan"
  | "LineToolGannFixed"
  | "LineToolGannSquare"
  | "LineToolGhostFeed"
  | "LineToolHeadAndShoulders"
  | "LineToolHighlighter"
  | "LineToolHorzLine"
  | "LineToolHorzRay"
  | "LineToolInfoLine"
  | "LineToolInsidePitchfork"
  | "LineToolNote"
  | "LineToolNoteAbsolute"
  | "LineToolParallelChannel"
  | "LineToolPath"
  | "LineToolPitchfan"
  | "LineToolPitchfork"
  | "LineToolPolyline"
  | "LineToolPrediction"
  | "LineToolPriceLabel"
  | "LineToolPriceNote"
  | "LineToolPriceRange"
  | "LineToolProjection"
  | "LineToolRay"
  | "LineToolRectangle"
  | "LineToolRegressionTrend"
  | "LineToolRiskRewardLong"
  | "LineToolRiskRewardShort"
  | "LineToolRotatedRectangle"
  | "LineToolSchiffPitchfork"
  | "LineToolSchiffPitchfork2"
  | "LineToolSignpost"
  | "LineToolSineLine"
  | "LineToolText"
  | "LineToolTextAbsolute"
  | "LineToolThreeDrivers"
  | "LineToolTimeCycles"
  | "LineToolTrendAngle"
  | "LineToolTrendBasedFibExtension"
  | "LineToolTrendBasedFibTime"
  | "LineToolTrendLine"
  | "LineToolTriangle"
  | "LineToolTrianglePattern"
  | "LineToolVertLine";
```

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


---

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

[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.

## title {#title}

```ts
title: string;
```

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

## onSelect {#onselect}

```ts
onSelect: () => void;
```

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

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


---

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

[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.

## title {#title}

```ts
title: string;
```

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

## items {#items}

```ts
items: DropdownItem[];
```

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

## tooltip {#tooltip}

```ts
tooltip?: string;
```

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

## icon {#icon}

```ts
icon?: string;
```

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

## align {#align}

```ts
align?: "right" | "left";
```

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

## Related types

- [DropdownItem](https://docs.lumencharts.com/charting-library/api/DropdownItem)

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


---

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

[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.

```ts
export type DropdownUpdateParams = Partial<Omit<DropdownParams, "align">>;
```

## Related types

- [DropdownParams](https://docs.lumencharts.com/charting-library/api/DropdownParams)

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


---

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

[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.

## objectType {#objecttype}

```ts
objectType: EditObjectDialogObjectType;
```

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

## scriptTitle {#scripttitle}

```ts
scriptTitle: string;
```

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

## Related types

- [EditObjectDialogObjectType](https://docs.lumencharts.com/charting-library/api/EditObjectDialogObjectType)

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


---

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

[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.

```ts
export type EditObjectDialogObjectType =
  "mainSeries" | "drawing" | "study" | "other";
```

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


---

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

[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.

## emoji {#emoji}

```ts
emoji: string;
```

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

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


---

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

[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.

```ts
export type EmptyCallback = () => void;
```

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


---

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

[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.

```ts
export type EntityId = Nominal<string, "EntityId">;
```

## Related types

- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)

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


---

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

[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.

## id {#id}

```ts
id: EntityId;
```

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

## name {#name}

```ts
name: string;
```

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

## Related types

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

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


---

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

[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.

```ts
export type ErrorCallback = (reason: string) => void;
```

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


---

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

[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.

## Extends

[FormatterParseResult](https://docs.lumencharts.com/charting-library/api/FormatterParseResult)

## error {#error}

```ts
error?: string;
```

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

## res {#res}

```ts
res: false;
```

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

## Related types

- [FormatterParseResult](https://docs.lumencharts.com/charting-library/api/FormatterParseResult)

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


---

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

[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.

## value {#value}

```ts
value: string;
```

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

## name {#name}

```ts
name: string;
```

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

## desc {#desc}

```ts
desc: string;
```

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

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


---

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

[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.

## from {#from}

```ts
from?: number;
```

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

## to {#to}

```ts
to?: number;
```

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

## includeTime {#includetime}

```ts
includeTime?: boolean;
```

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

## includeUserTime {#includeusertime}

```ts
includeUserTime?: boolean;
```

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

## includeSeries {#includeseries}

```ts
includeSeries?: boolean;
```

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

## includeDisplayedValues {#includedisplayedvalues}

```ts
includeDisplayedValues?: boolean;
```

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

## includedStudies {#includedstudies}

```ts
includedStudies: readonly string[] | "all";
```

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

## includeOffsetStudyValues {#includeoffsetstudyvalues}

```ts
includeOffsetStudyValues?: boolean;
```

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

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


---

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

[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.

## schema {#schema}

```ts
schema: FieldDescriptor[];
```

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

## data {#data}

```ts
data: Float64Array[];
```

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

## displayedData {#displayeddata}

```ts
displayedData: string[][];
```

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

## Related types

- [FieldDescriptor](https://docs.lumencharts.com/charting-library/api/FieldDescriptor)

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


---

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

[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.

## intervals {#intervals}

```ts
intervals?: ResolutionString[];
```

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

## indicators {#indicators}

```ts
indicators?: string[];
```

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

## chartTypes {#charttypes}

```ts
chartTypes?: TChartTypeFavorites[];
```

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

## drawingTools {#drawingtools}

```ts
drawingTools?: DrawingToolIdentifier[];
```

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

## Related types

- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [DrawingToolIdentifier](https://docs.lumencharts.com/charting-library/api/DrawingToolIdentifier)

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


---

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

[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.

```ts
export type FieldDescriptor =
  | TimeFieldDescriptor
  | UserTimeFieldDescriptor
  | SeriesFieldDescriptor
  | StudyFieldDescriptor;
```

## Related types

- [TimeFieldDescriptor](https://docs.lumencharts.com/charting-library/api/TimeFieldDescriptor)
- [UserTimeFieldDescriptor](https://docs.lumencharts.com/charting-library/api/UserTimeFieldDescriptor)
- [SeriesFieldDescriptor](https://docs.lumencharts.com/charting-library/api/SeriesFieldDescriptor)
- [StudyFieldDescriptor](https://docs.lumencharts.com/charting-library/api/StudyFieldDescriptor)

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


---

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

[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.

```ts
export declare const enum FilledAreaType {
  TypePlots = "plot_plot",
  TypeHlines = "hline_hline",
}
```

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


---

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

[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.

```ts
export type FinancialPeriod = "FY" | "FQ" | "FH" | "TTM";
```

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


---

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

[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.

## res {#res}

```ts
res: boolean;
```

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

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


---

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

[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.

```ts
export type GetMarksCallback<T> = (marks: T[]) => void;
```

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


---

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

[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.

```ts
export type GmtTimezoneId = `Etc/GMT${"+" | "-"}${number}${`:${number}` | ""}`;
```

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


---

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

[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.

## type {#type}

```ts
type: "drawing" | "study";
```

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

## name {#name}

```ts
name: string;
```

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

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


---

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

[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.

```ts
export type GroupLockState = "Locked" | "Unlocked" | "Partial";
```

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


---

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

[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.

```ts
export type GroupVisibilityState = "Visible" | "Invisible" | "Partial";
```

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


---

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

[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.

```ts
export type HeaderWidgetButtonsMode = "fullsize" | "compact" | "adaptive";
```

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


---

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

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

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

## downColor {#downcolor}

```ts
downColor: string;
```

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

## drawWick {#drawwick}

```ts
drawWick: boolean;
```

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

## drawBorder {#drawborder}

```ts
drawBorder: boolean;
```

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

## drawBody {#drawbody}

```ts
drawBody: boolean;
```

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

## borderColor {#bordercolor}

```ts
borderColor: string;
```

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

## borderUpColor {#borderupcolor}

```ts
borderUpColor: string;
```

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

## borderDownColor {#borderdowncolor}

```ts
borderDownColor: string;
```

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

## wickColor {#wickcolor}

```ts
wickColor: string;
```

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

## wickUpColor {#wickupcolor}

```ts
wickUpColor: string;
```

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

## wickDownColor {#wickdowncolor}

```ts
wickDownColor: string;
```

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

## showRealLastPrice {#showreallastprice}

```ts
showRealLastPrice: boolean;
```

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

## barColorsOnPrevClose {#barcolorsonprevclose}

```ts
barColorsOnPrevClose: boolean;
```

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

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


---

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

[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.

```ts
declare enum HHistDirection {
  LeftToRight = "left_to_right",
  RightToLeft = "right_to_left",
}
```

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


---

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

[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.

## colors {#colors}

```ts
colors: string[];
```

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

## transparencies {#transparencies}

```ts
transparencies: number[];
```

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

## visible {#visible}

```ts
visible: boolean;
```

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

## percentWidth {#percentwidth}

```ts
percentWidth: number;
```

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

## showValues {#showvalues}

```ts
showValues: boolean;
```

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

## valuesColor {#valuescolor}

```ts
valuesColor: string;
```

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

## direction {#direction}

```ts
direction: HHistDirection;
```

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

## Related types

- [HHistDirection](https://docs.lumencharts.com/charting-library/api/HHistDirection)

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


---

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

[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.

## color {#color}

```ts
color: string;
```

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

## showBorders {#showborders}

```ts
showBorders: boolean;
```

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

## borderColor {#bordercolor}

```ts
borderColor: string;
```

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

## showLabels {#showlabels}

```ts
showLabels: boolean;
```

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

## labelColor {#labelcolor}

```ts
labelColor: string;
```

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

## drawBody {#drawbody}

```ts
drawBody: boolean;
```

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

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


---

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

[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.

```ts
export type HistoryCallback = (bars: Bar[], meta?: HistoryMetadata) => void;
```

## Related types

- [Bar](https://docs.lumencharts.com/charting-library/api/Bar)
- [HistoryMetadata](https://docs.lumencharts.com/charting-library/api/HistoryMetadata)

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


---

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

[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.

## noData {#nodata}

```ts
noData?: boolean;
```

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

## nextTime {#nexttime}

```ts
nextTime?: number | null;
```

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

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


---

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

[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.

## highLineColor {#highlinecolor}

```ts
highLineColor: string;
```

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

## highLineStyle {#highlinestyle}

```ts
highLineStyle: number;
```

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

## highLineWidth {#highlinewidth}

```ts
highLineWidth: number;
```

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

## lowLineColor {#lowlinecolor}

```ts
lowLineColor: string;
```

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

## lowLineStyle {#lowlinestyle}

```ts
lowLineStyle: number;
```

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

## lowLineWidth {#lowlinewidth}

```ts
lowLineWidth: number;
```

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

## closeLineColor {#closelinecolor}

```ts
closeLineColor: string;
```

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

## closeLineStyle {#closelinestyle}

```ts
closeLineStyle: number;
```

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

## closeLineWidth {#closelinewidth}

```ts
closeLineWidth: number;
```

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

## highCloseFillColor {#highclosefillcolor}

```ts
highCloseFillColor: string;
```

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

## closeLowFillColor {#closelowfillcolor}

```ts
closeLowFillColor: string;
```

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

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


---

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

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

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

## downColor {#downcolor}

```ts
downColor: string;
```

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

## drawWick {#drawwick}

```ts
drawWick: boolean;
```

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

## drawBorder {#drawborder}

```ts
drawBorder: boolean;
```

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

## drawBody {#drawbody}

```ts
drawBody: boolean;
```

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

## borderColor {#bordercolor}

```ts
borderColor: string;
```

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

## borderUpColor {#borderupcolor}

```ts
borderUpColor: string;
```

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

## borderDownColor {#borderdowncolor}

```ts
borderDownColor: string;
```

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

## wickColor {#wickcolor}

```ts
wickColor: string;
```

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

## wickUpColor {#wickupcolor}

```ts
wickUpColor: string;
```

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

## wickDownColor {#wickdowncolor}

```ts
wickDownColor: string;
```

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

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


---

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

[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.

## visible {#visible}

```ts
visible: boolean;
```

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

## width {#width}

```ts
width: number;
```

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

## color {#color}

```ts
color: string;
```

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

## style {#style}

```ts
style: LineStyle;
```

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

## showPrice {#showprice}

```ts
showPrice?: boolean;
```

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

## Related types

- [LineStyle](https://docs.lumencharts.com/charting-library/api/LineStyle)

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


---

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

[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.

## Extends

[IMenuItem](https://docs.lumencharts.com/charting-library/api/IMenuItem)

## type {#type}

```ts
readonly type: MenuItemType.Action;
```

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

## execute {#execute}

```ts
execute(): void;
```

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

## getState {#getstate}

```ts
getState(): Readonly<ActionState>;
```

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

## onUpdate {#onupdate}

```ts
onUpdate(): ISubscription<OnActionUpdateHandler>;
```

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

## Related types

- [IMenuItem](https://docs.lumencharts.com/charting-library/api/IMenuItem)
- [ActionState](https://docs.lumencharts.com/charting-library/api/ActionState)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)
- [OnActionUpdateHandler](https://docs.lumencharts.com/charting-library/api/OnActionUpdateHandler)

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


---

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

[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.

```ts
export type IActionVariant = IAction | ISeparator;
```

## Related types

- [IAction](https://docs.lumencharts.com/charting-library/api/IAction)
- [ISeparator](https://docs.lumencharts.com/charting-library/api/ISeparator)

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


---

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

[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.

```ts
export type IBarArray = [number, number, number, number, number, number];
```

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


---

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

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

```ts
export type IBasicDataFeed = IDatafeedChartApi & IExternalDatafeed;
```

## Related types

- [IDatafeedChartApi](https://docs.lumencharts.com/charting-library/api/IDatafeedChartApi)
- [IExternalDatafeed](https://docs.lumencharts.com/charting-library/api/IExternalDatafeed)

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


---

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

[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.

## Extends

[IBoxedValueReadOnly](https://docs.lumencharts.com/charting-library/api/IBoxedValueReadOnly)

## setValue {#setvalue}

```ts
setValue(value: T): void;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `T` | Yes |

## Related types

- [IBoxedValueReadOnly](https://docs.lumencharts.com/charting-library/api/IBoxedValueReadOnly)

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


---

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

[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.

## value {#value}

```ts
value(): T;
```

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

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


---

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

[Integration guide](https://docs.lumencharts.com/charting-library/reference/events) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Runtime facade. Entries identify whether the current source exposes each member. Optional provider-dependent methods still require their configured capability.

Commands and events for one chart in the widget. Get it from `widget.activeChart()` or `widget.chart(index)` after `onChartReady`.

## automationAvailable {#automationavailable}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
automationAvailable(): boolean;
```

Whether the optional automation asset has been installed in this chart's iframe.

## openAutomation {#openautomation}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
openAutomation(options?: OpenChartAutomationOptions): Promise<ChartAutomation>;
```

Opens an automation session for this chart: loads the optional automation asset when needed,
installs the requested native command families and wires exact-chart PNG capture.
Close the session when done; removing the chart closes it.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `OpenChartAutomationOptions` | No |

## createDrawingDocument {#createdrawingdocument}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createDrawingDocument(binding: ChartBinding): ChartDrawingDocumentApi;
```

Native persistence remains available without the automation add-on.

| Parameter | Type | Required |
| --- | --- | --- |
| `binding` | `ChartBinding` | Yes |

## createStudyDocument {#createstudydocument}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createStudyDocument(binding: ChartBinding, options: { chartId: string; documentId: string; revision: number }): ChartStudyDocumentApi;
```

Creates a study-document owner bound to this chart that exports, restores and commits the chart's studies and pane layout as a versioned document identified by `chartId`, `documentId` and `revision`. You own its lifetime; it is destroyed when the chart is removed, and creating one on a removed chart throws.

| Parameter | Type | Required |
| --- | --- | --- |
| `binding` | `ChartBinding` | Yes |
| `options` | `{ chartId: string; documentId: string; revision: number }` | Yes |

## footprintStatus {#footprintstatus}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
footprintStatus(): FootprintStatus;
```

**Beta.** Status of the volume footprint data for this chart.

## onFootprintStatusChanged {#onfootprintstatuschanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onFootprintStatusChanged(): ISubscription<(status: FootprintStatus) => void>;
```

**Beta.** Fires when the volume footprint status changes.

## onDataChanged {#ondatachanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onDataChanged(): ISubscription<() => void>;
```

Committed main-series data changes, including realtime updates.

## onRemoved {#onremoved}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onRemoved(listener: () => void): () => void;
```

Fires once on chart removal; returns an unsubscribe function.

| Parameter | Type | Required |
| --- | --- | --- |
| `listener` | `() => void` | Yes |

## readLoadedBars {#readloadedbars}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
readLoadedBars(input: { from: number; to: number; limit?: number }): {
    bars: Array<{ time: number; open: number; high: number; low: number; close: number; volume?: number }>;
    coverage: { from: number | null; to: number | null; complete: boolean };
  };
```

Bounded raw loaded candles. All times are UTC epoch milliseconds. No add-on required.

| Parameter | Type | Required |
| --- | --- | --- |
| `input` | `{ from: number; to: number; limit?: number }` | Yes |

## onDataLoaded {#ondataloaded}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

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

Returns a subscription that fires each time the main series finishes loading without an error.

## dataStatus {#datastatus}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
dataStatus(): ChartDataStatus;
```

Whether the main series has data to show, with a plain-language reason when loading failed.
Hosts that disable the `series_data_error_overlay` feature use this to present data errors themselves.

## onDataStatusChanged {#ondatastatuschanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onDataStatusChanged(): ISubscription<(status: ChartDataStatus) => void>;
```

Returns a subscription that fires with the new `dataStatus()` value whenever its state or message changes.

## datafeedStatus {#datafeedstatus}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
datafeedStatus(): ChartDatafeedConnectionStatus;
```

Realtime connection state of this chart's datafeed. `idle` until a datafeed session starts.
Hosts can show a short "Reconnecting" notice for `reconnecting` and clear it on `live`.

## onDatafeedStatusChanged {#ondatafeedstatuschanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onDatafeedStatusChanged(): ISubscription<(status: ChartDatafeedConnectionStatus) => void>;
```

Returns a subscription that fires with the new datafeed connection status whenever its state or retry attempt changes.

## onSymbolChanged {#onsymbolchanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onSymbolChanged(): ISubscription<() => void>;
```

Returns a subscription that fires, with no arguments, whenever the chart's symbol changes.

## onIntervalChanged {#onintervalchanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onIntervalChanged(): ISubscription<
    (
      interval: ResolutionString,
      timeFrameParameters: {
        timeframe?: TimeFrameValue;
      },
    ) => void
  >;
```

Returns a subscription that fires with the new resolution whenever the chart's interval changes. The second argument's `timeframe` is always `undefined`.

## onVisibleRangeChanged {#onvisiblerangechanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onVisibleRangeChanged(): ISubscription<(range: VisibleTimeRange) => void>;
```

Returns a subscription that fires with the new visible time range whenever the chart scrolls or zooms.

## onChartTypeChanged {#oncharttypechanged}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onChartTypeChanged(): ISubscription<(chartType: SeriesType) => void>;
```

Returns a subscription that fires with the new series type whenever the chart type changes.

## dataReady {#dataready}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
dataReady(callback?: () => void): boolean;
```

Returns `true` when the main series is neither loading nor in error. If `callback` is given, calls it immediately when ready, otherwise after the current load completes.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | No |

## crossHairMoved {#crosshairmoved}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
crossHairMoved(): ISubscription<(params: CrossHairMovedEventParams) => void>;
```

Returns a subscription that fires with the crosshair position each time the user moves it over the chart; programmatic moves from `setExternalCrosshair` do not fire it.

## setExternalCrosshair {#setexternalcrosshair}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setExternalCrosshair(point: { time: number; price: number } | null): void;
```

Position the chart crosshair at a time and price, or clear a previously positioned crosshair.

**point:** The time and price to focus, or `null` to clear the crosshair.

| Parameter | Type | Required |
| --- | --- | --- |
| `point` | `{ time: number; price: number } &#124; null` | Yes |

**Failure conditions:** `Crosshair point must contain finite time and price values`.

## onHoveredSourceChanged {#onhoveredsourcechanged}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
onHoveredSourceChanged(): ISubscription<(sourceId: EntityId) => void>;
```

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

## setVisibleRange {#setvisiblerange}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setVisibleRange(
    range: SetVisibleTimeRange,
    options?: SetVisibleRangeOptions,
  ): Promise<void>;
```

Scrolls and zooms the time scale to show the given range and resolves once it is applied. `percentRightMargin` adds empty space on the right, and `loadedOnly` keeps the range within loaded bars without requesting more history.

| Parameter | Type | Required |
| --- | --- | --- |
| `range` | `SetVisibleTimeRange` | Yes |
| `options` | `SetVisibleRangeOptions` | No |

## setSymbol {#setsymbol}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setSymbol(symbol: string, options?: SetSymbolOptions | (() => void)): void;
```

Changes the chart's symbol and activates the chart unless `doNotActivateChart` is set. A callback runs after the new data finishes loading, or on the next microtask when the symbol is unchanged.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbol` | `string` | Yes |
| `options` | `SetSymbolOptions &#124; (() => void)` | No |

## setResolution {#setresolution}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setResolution(
    resolution: ResolutionString,
    options?: SetResolutionOptions | (() => void),
  ): Promise<boolean>;
```

Changes the chart's interval, or every chart's interval when the interval lock is on, and activates the chart unless `doNotActivateChart` is set. Resolves `true` immediately for an unsupported or unchanged resolution, otherwise whether any chart changed; `dataReady` runs after the main series finishes loading.

| Parameter | Type | Required |
| --- | --- | --- |
| `resolution` | `ResolutionString` | Yes |
| `options` | `SetResolutionOptions &#124; (() => void)` | No |

## setChartType {#setcharttype}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setChartType(type: SeriesType, callback?: () => void): void;
```

Changes the main series style and calls `callback` after the series data finishes loading. Throws for an unsupported style, and for volume footprint unless the `chart_style_volume_footprint` feature is enabled.

| Parameter | Type | Required |
| --- | --- | --- |
| `type` | `SeriesType` | Yes |
| `callback` | `() => void` | No |

**Failure conditions:** `Volume footprint requires the chart_style_volume_footprint feature`.

## resetCache {#resetcache}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
resetCache(): void;
```

Reset cached bar data for this chart's active datafeed session.

## resetData {#resetdata}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
resetData(): void;
```

Purges the cached history for this chart and reloads it from the datafeed, keeping the visible range.

## executeActionById {#executeactionbyid}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
executeActionById(actionId: ChartActionId): void;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `actionId` | `ChartActionId` | Yes |

## getCheckableActionState {#getcheckableactionstate}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
getCheckableActionState(actionId: ChartActionId): boolean;
```

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

| Parameter | Type | Required |
| --- | --- | --- |
| `actionId` | `ChartActionId` | Yes |

## refreshMarks {#refreshmarks}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
refreshMarks(): void;
```

Discards the loaded bar and timescale marks and requests them again from the datafeed for the current range.

## clearMarks {#clearmarks}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
clearMarks(marksToClear?: ClearMarksMode): void;
```

Removes bar marks, timescale marks or both (the default) without requesting them again for the current range. Throws a `RangeError` for an unknown mode.

| Parameter | Type | Required |
| --- | --- | --- |
| `marksToClear` | `ClearMarksMode` | No |

## getAllShapes {#getallshapes}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getAllShapes(): EntityInfo[];
```

Returns the id and name of every drawing on the chart.

## getAllStudies {#getallstudies}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getAllStudies(): EntityInfo[];
```

Returns the id and name of every study on the chart.

## getPriceToBarRatio {#getpricetobarratio}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getPriceToBarRatio(): number | null;
```

Returns the current price-to-bar ratio of the main price scale, or `null` when it cannot be computed.

## setPriceToBarRatio {#setpricetobarratio}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setPriceToBarRatio(ratio: number, options?: UndoOptions): void;
```

Sets the price-to-bar ratio of the main price scale, recording an Undo step unless `disableUndo` is set.

| Parameter | Type | Required |
| --- | --- | --- |
| `ratio` | `number` | Yes |
| `options` | `UndoOptions` | No |

## isPriceToBarRatioLocked {#ispricetobarratiolocked}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
isPriceToBarRatioLocked(): boolean;
```

Returns whether the main price scale's price-to-bar ratio is locked.

## setPriceToBarRatioLocked {#setpricetobarratiolocked}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setPriceToBarRatioLocked(value: boolean, options?: UndoOptions): void;
```

Locks or unlocks the price-to-bar ratio, recording an Undo step unless `disableUndo` is set. Locking switches the price scale to regular mode and keeps the current ratio.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `boolean` | Yes |
| `options` | `UndoOptions` | No |

## getAllPanesHeight {#getallpanesheight}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
getAllPanesHeight(): number[];
```

Use the type signature above and the integration guide for the owning capability.

## setAllPanesHeight {#setallpanesheight}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
setAllPanesHeight(heights: readonly number[]): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `heights` | `readonly number[]` | Yes |

## maximizeChart {#maximizechart}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
maximizeChart(): void;
```

Activates this chart and maximizes it within a multi-chart layout; has no effect when the chart is not visible in the layout.

## isMaximized {#ismaximized}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
isMaximized(): boolean;
```

Returns whether this chart is currently maximized in the layout.

## restoreChart {#restorechart}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
restoreChart(): void;
```

Restores the layout from a maximized chart so all charts are shown again.

## availableZOrderOperations {#availablezorderoperations}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
availableZOrderOperations(
    sources: readonly EntityId[],
  ): AvailableZOrderOperations;
```

Returns which z-order operations can be applied to the given drawings, with every operation disabled when none apply.

| Parameter | Type | Required |
| --- | --- | --- |
| `sources` | `readonly EntityId[]` | Yes |

## sendToBack {#sendtoback}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
sendToBack(entities: readonly EntityId[]): void;
```

Moves the given drawings beneath all other drawings.

| Parameter | Type | Required |
| --- | --- | --- |
| `entities` | `readonly EntityId[]` | Yes |

## bringToFront {#bringtofront}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
bringToFront(sources: readonly EntityId[]): void;
```

Moves the given drawings above all other drawings.

| Parameter | Type | Required |
| --- | --- | --- |
| `sources` | `readonly EntityId[]` | Yes |

## bringForward {#bringforward}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
bringForward(sources: readonly EntityId[]): void;
```

Moves the given drawings one step up in the drawing order.

| Parameter | Type | Required |
| --- | --- | --- |
| `sources` | `readonly EntityId[]` | Yes |

## sendBackward {#sendbackward}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
sendBackward(sources: readonly EntityId[]): void;
```

Moves the given drawings one step down in the drawing order.

| Parameter | Type | Required |
| --- | --- | --- |
| `sources` | `readonly EntityId[]` | Yes |

## createStudy {#createstudy}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createStudy<TOverrides extends Partial<SingleIndicatorOverrides>>(
    name: string,
    forceOverlay?: boolean,
    lock?: boolean,
    inputs?: Record<string, StudyInputValue>,
    overrides?: TOverrides,
    options?: CreateStudyOptions,
  ): Promise<EntityId | null>;
```

Adds the built-in study whose display name matches `name` (case-insensitive), merged with saved defaults, and resolves to its entity id or `null` when it could not be added. Throws when no study has that name; with `checkLimit`, resolves `null` once the study limit is reached.

| Parameter | Type | Required |
| --- | --- | --- |
| `name` | `string` | Yes |
| `forceOverlay` | `boolean` | No |
| `lock` | `boolean` | No |
| `inputs` | `Record<string, StudyInputValue>` | No |
| `overrides` | `TOverrides` | No |
| `options` | `CreateStudyOptions` | No |

**Failure conditions:** `Study '${studyName}' is unavailable`.

## compilePineScript {#compilepinescript}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
compilePineScript(
    source: string,
    options?: PineScriptRunOptions,
  ): Promise<PineScriptCompileResult>;
```

Compiles Pine Script source against the chart's current bars without adding a study and resolves with the compile result. Rejects unless Pine Script is enabled in the `pine_script` widget option.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `string` | Yes |
| `options` | `PineScriptRunOptions` | No |

## createPineStudy {#createpinestudy}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
createPineStudy(
    source: string,
    options?: PineScriptStudyOptions,
  ): Promise<EntityId | null>;
```

Compiles the source and adds it to the chart as a Pine study, resolving to its entity id or `null` when it could not be added. Rejects on compile errors or when Pine Script is disabled.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `string` | Yes |
| `options` | `PineScriptStudyOptions` | No |

## updatePineStudy {#updatepinestudy}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
updatePineStudy(
    entityId: EntityId,
    source: string,
    options?: PineScriptStudyOptions,
  ): Promise<void>;
```

Recompiles an existing Pine study with new source, carrying over compatible inputs and overrides. Rejects when the entity is missing or not a Pine study, on compile errors, or when a newer update supersedes this one.

| Parameter | Type | Required |
| --- | --- | --- |
| `entityId` | `EntityId` | Yes |
| `source` | `string` | Yes |
| `options` | `PineScriptStudyOptions` | No |

## getPineStudy {#getpinestudy}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineStudy(entityId: EntityId): PineScriptStudyState | null;
```

Returns a copy of a Pine study's descriptor, inputs, overrides, pane, status, error and alert conditions, or `null` when the entity is not a Pine study.

| Parameter | Type | Required |
| --- | --- | --- |
| `entityId` | `EntityId` | Yes |

## createPineAlertRule {#createpinealertrule}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
createPineAlertRule(input: PineAlertRuleInput): PineAlertRule;
```

Creates an alert rule on one of a Pine study's alert conditions and returns it with its generated id. Throws when Pine alerts are disabled (`pine_script.alerts`) or the study does not declare that condition.

| Parameter | Type | Required |
| --- | --- | --- |
| `input` | `PineAlertRuleInput` | Yes |

**Failure conditions:** `Pine alerts are unavailable`.

## updatePineAlertRule {#updatepinealertrule}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
updatePineAlertRule(
    id: string,
    patch: Partial<PineAlertRuleInput>,
  ): PineAlertRule;
```

Applies `patch` to an existing Pine alert rule and returns the updated rule. Throws when alerts are disabled, the rule does not exist, or the target condition is missing.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | Yes |
| `patch` | `Partial<PineAlertRuleInput>` | Yes |

**Failure conditions:** `Pine alerts are unavailable`.

## removePineAlertRule {#removepinealertrule}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
removePineAlertRule(id: string): boolean;
```

Removes a Pine alert rule and returns whether one was removed. Throws when Pine alerts are disabled.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | Yes |

## getPineAlertRules {#getpinealertrules}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineAlertRules(): PineAlertRule[];
```

Returns copies of all Pine alert rules on this chart.

## getPineAlertHistory {#getpinealerthistory}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineAlertHistory(): PineAlertEvent[];
```

Returns copies of the Pine alert events fired so far, keeping at most `pine_script.max_alert_events` (500 by default).

## subscribePineAlertEvents {#subscribepinealertevents}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
subscribePineAlertEvents(
    listener: (event: PineAlertEvent) => void,
  ): () => void;
```

Calls `listener` with each Pine alert event as it fires and returns a function that unsubscribes. Throws a `TypeError` when `listener` is not a function.

| Parameter | Type | Required |
| --- | --- | --- |
| `listener` | `(event: PineAlertEvent) => void` | Yes |

**Failure conditions:** `Pine alert listener must be a function`.

## getPineStrategyReport {#getpinestrategyreport}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineStrategyReport(studyId: EntityId): PineStrategyReport | null;
```

Returns a frozen copy of a Pine strategy's latest backtest report, or `null` before one is available. Throws when the study does not exist, is not a Pine study, or is not a strategy.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |

**Failure conditions:** `Pine strategies are unavailable`.

## getPineStudyObject {#getpinestudyobject}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineStudyObject(
    studyId: EntityId,
    objectId: string,
  ): PineStudyObjectSnapshot | null;
```

Returns a frozen snapshot of one drawing object (such as a line, label or box) produced by a Pine study, or null when the study has no object with that id. Throws when the entity is not a Pine study.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `objectId` | `string` | Yes |

**Failure conditions:** `Pine object inspection is unavailable`.

## getPineStudyObjects {#getpinestudyobjects}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineStudyObjects(studyId: EntityId): readonly PineStudyObjectSnapshot[];
```

Returns frozen snapshots of all drawing objects the Pine study produced in its latest run. Throws when the entity is missing or is not a Pine study.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |

**Failure conditions:** `Pine object inspection is unavailable`.

## listPineWorkspaceDocuments {#listpineworkspacedocuments}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
listPineWorkspaceDocuments(
    request?: PineWorkspaceListRequest,
    options?: PineScriptRunOptions,
  ): Promise<PineWorkspacePage>;
```

Lists one page of Pine documents from the configured `pine_script.workspace_provider`, up to 50 per page by default. Rejects when no workspace provider is configured or the provider returns an invalid page; pass `options.signal` to abort.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceListRequest` | No |
| `options` | `PineScriptRunOptions` | No |

## loadPineWorkspaceDocument {#loadpineworkspacedocument}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
loadPineWorkspaceDocument(
    id: string,
    options?: PineScriptRunOptions,
  ): Promise<PineWorkspaceDocument>;
```

Loads a Pine document, including its source, from the configured workspace provider. Rejects when no provider is configured, the id is empty, or the provider returns a different document.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | Yes |
| `options` | `PineScriptRunOptions` | No |

## createPineWorkspaceDocument {#createpineworkspacedocument}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
createPineWorkspaceDocument(
    request: PineWorkspaceCreateRequest,
    options?: PineScriptRunOptions,
  ): Promise<PineWorkspaceDocument>;
```

Creates a Pine document through the configured workspace provider and resolves with the stored document. Rejects when no provider is configured or the source is empty or larger than 256 KB.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceCreateRequest` | Yes |
| `options` | `PineScriptRunOptions` | No |

## updatePineWorkspaceDocument {#updatepineworkspacedocument}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
updatePineWorkspaceDocument(
    request: PineWorkspaceUpdateRequest,
    options?: PineScriptRunOptions,
  ): Promise<PineWorkspaceDocument>;
```

Saves new source to an existing Pine document through the configured workspace provider and resolves with the updated document. The request must include `expectedRevision`, which the provider can use to reject conflicting writes.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceUpdateRequest` | Yes |
| `options` | `PineScriptRunOptions` | No |

## deletePineWorkspaceDocument {#deletepineworkspacedocument}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
deletePineWorkspaceDocument(
    id: string,
    expectedRevision: string,
    options?: PineScriptRunOptions,
  ): Promise<void>;
```

Deletes a Pine document through the configured workspace provider, passing `expectedRevision` so the provider can refuse a stale delete. Rejects when no provider is configured or either argument is empty.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | Yes |
| `expectedRevision` | `string` | Yes |
| `options` | `PineScriptRunOptions` | No |

## listPineWorkspaceRevisions {#listpineworkspacerevisions}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
listPineWorkspaceRevisions(
    request: PineWorkspaceRevisionListRequest,
    options?: PineScriptRunOptions,
  ): Promise<PineWorkspaceRevisionPage>;
```

Lists one page of saved revisions for a Pine document, up to 50 per page by default. Rejects when no workspace provider is configured or the provider does not support revision history.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceRevisionListRequest` | Yes |
| `options` | `PineScriptRunOptions` | No |

## loadPineWorkspaceRevision {#loadpineworkspacerevision}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
loadPineWorkspaceRevision(
    id: string,
    revision: string,
    options?: PineScriptRunOptions,
  ): Promise<PineWorkspaceRevision>;
```

Loads the source of one saved revision of a Pine document. Rejects when no workspace provider is configured, the provider has no revision history, or it returns a different revision.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | Yes |
| `revision` | `string` | Yes |
| `options` | `PineScriptRunOptions` | No |

## linkPineStudyToWorkspace {#linkpinestudytoworkspace}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
linkPineStudyToWorkspace(
    studyId: EntityId,
    document: { id: string; revision: string },
  ): void;
```

Records on a Pine study which workspace document and revision its source came from, so the link is saved with the chart. Throws when the entity is not a Pine study.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `document` | `{ id: string; revision: string }` | Yes |

**Failure conditions:** `Pine workspace is unavailable`.

## publishPineStudy {#publishpinestudy}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
publishPineStudy(
    studyId: EntityId,
    identity: PinePublicationIdentity & {
      visibility: "private" | "unlisted" | "public";
    },
    options?: PineScriptRunOptions,
  ): Promise<PinePublication>;
```

Compiles the Pine study's current source and publishes it through the configured `pine_script.publication_provider`, then records the publication on the study. Rejects when the declared script kind differs from `identity.kind`, no provider is configured, or the provider's result does not match the request.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `identity` | `PinePublicationIdentity & {       visibility: "private" &#124; "unlisted" &#124; "public";     }` | Yes |
| `options` | `PineScriptRunOptions` | No |

## setPineAlertDeliveryChannel {#setpinealertdeliverychannel}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
setPineAlertDeliveryChannel(ruleId: string, channelId: string | null): void;
```

Routes future events of a Pine alert rule to a delivery channel, or stops delivery for that rule when `channelId` is null or blank. Delivery happens only when `pine_script.alert_delivery_provider` is configured.

| Parameter | Type | Required |
| --- | --- | --- |
| `ruleId` | `string` | Yes |
| `channelId` | `string &#124; null` | Yes |

**Failure conditions:** `Pine alert delivery is unavailable`.

## getPineAlertDeliveryStatuses {#getpinealertdeliverystatuses}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineAlertDeliveryStatuses(): readonly PineAlertDeliveryStatus[];
```

Returns frozen snapshots of Pine alert deliveries attempted by this chart, each in the `pending`, `delivered`, `failed` or `cancelled` state. Returns an empty array when nothing has been delivered.

## getPineObjectOverrides {#getpineobjectoverrides}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
getPineObjectOverrides(
    studyId: EntityId,
  ): readonly PineObjectOverrideSnapshot[];
```

Returns the user edits currently stored on a Pine study's drawing objects. Throws when the entity is not a Pine study.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |

**Failure conditions:** `Pine object interaction is unavailable`.

## updatePineObjectOverride {#updatepineobjectoverride}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
updatePineObjectOverride(
    studyId: EntityId,
    objectId: string,
    patch: PineObjectOverridePatch,
  ): PineObjectOverrideSnapshot;
```

Validates and merges a patch into the stored override for one Pine drawing object, saves it on the study with undo support, and returns the resulting override. Throws when `pine_script.object_interaction` is disabled, the object no longer exists, the object is locked, or the override limit is exceeded.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `objectId` | `string` | Yes |
| `patch` | `PineObjectOverridePatch` | Yes |

**Failure conditions:** `Pine object interaction is unavailable`.

## resetPineObjectOverride {#resetpineobjectoverride}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
resetPineObjectOverride(
    studyId: EntityId,
    objectId: string,
    paths?: readonly PineObjectOverridePath[],
  ): void;
```

Removes the given override paths from a Pine drawing object, or its whole override when `paths` is omitted; does nothing if the object has no override. Throws when object interaction is disabled or the object is locked and `paths` does not include `locked`.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `objectId` | `string` | Yes |
| `paths` | `readonly PineObjectOverridePath[]` | No |

**Failure conditions:** `Pine object interaction is unavailable`.

## subscribePineStrategyReport {#subscribepinestrategyreport}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
subscribePineStrategyReport(
    studyId: EntityId,
    listener: (change: PineStrategyReportChange) => void,
  ): () => void;
```

Calls the listener with a frozen strategy report each time the Pine strategy produces a new one, and returns an unsubscribe function. Throws when the study is not a Pine strategy; returns a no-op unsubscribe when the chart has no Pine support.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `listener` | `(change: PineStrategyReportChange) => void` | Yes |

**Failure conditions:** `Pine strategy listener must be a function`.

## subscribePineStudyObjects {#subscribepinestudyobjects}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
subscribePineStudyObjects(
    studyId: EntityId,
    listener: (change: PineStudyObjectChange) => void,
  ): () => void;
```

Calls the listener with frozen snapshots whenever a Pine study's drawing objects change, and returns an unsubscribe function. Throws when the entity is not a Pine study or the listener is not a function.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `listener` | `(change: PineStudyObjectChange) => void` | Yes |

**Failure conditions:** `Pine object listener must be a function`.

## subscribePineAlertDeliveryStatuses {#subscribepinealertdeliverystatuses}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
subscribePineAlertDeliveryStatuses(
    listener: (status: PineAlertDeliveryStatus) => void,
  ): () => void;
```

Calls the listener with a frozen status each time a Pine alert delivery changes state, and returns an unsubscribe function. Throws when the listener is not a function.

| Parameter | Type | Required |
| --- | --- | --- |
| `listener` | `(status: PineAlertDeliveryStatus) => void` | Yes |

**Failure conditions:** `Pine alert delivery listener must be a function`.

## subscribePineObjectOverrides {#subscribepineobjectoverrides}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
subscribePineObjectOverrides(
    studyId: EntityId,
    listener: (change: PineObjectOverrideChange) => void,
  ): () => void;
```

Calls the listener whenever the stored overrides on a Pine study's drawing objects change, and returns an unsubscribe function. Throws when the entity is not a Pine study or the listener is not a function.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |
| `listener` | `(change: PineObjectOverrideChange) => void` | Yes |

**Failure conditions:** `Pine object override listener must be a function`.

## subscribePineStudyMigrations {#subscribepinestudymigrations}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
subscribePineStudyMigrations(
    listener: (studyId: EntityId, report: PineStudyMigrationReport) => void,
  ): () => void;
```

Calls the listener with a report when a Pine study's source changes and its inputs, style overrides and alert rules are carried over to the new script, listing what was kept, reset or removed. Returns an unsubscribe function.

| Parameter | Type | Required |
| --- | --- | --- |
| `listener` | `(studyId: EntityId, report: PineStudyMigrationReport) => void` | Yes |

**Failure conditions:** `Pine migration listener must be a function`.

## getStudyById {#getstudybyid}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getStudyById(entityId: EntityId): IStudyApi;
```

Returns an API object for reading and changing an existing study, including its inputs, styles, visibility, z-order and pane placement. Throws when no study has that id.

| Parameter | Type | Required |
| --- | --- | --- |
| `entityId` | `EntityId` | Yes |

**Failure conditions:** `There is no such study`.

## getSeries {#getseries}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
getSeries(): ISeriesApi;
```

Use the type signature above and the integration guide for the owning capability.

## createShape {#createshape}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createShape<TOverrides extends object>(
    point: ShapePoint,
    options: CreateShapeOptions<TOverrides>,
  ): EntityId | null;
```

Creates a single-point drawing of the type named in `options.shape` and returns its id, or null when the chart did not create it. Throws when the point or options fail validation.

| Parameter | Type | Required |
| --- | --- | --- |
| `point` | `ShapePoint` | Yes |
| `options` | `CreateShapeOptions<TOverrides>` | Yes |

## createMultipointShape {#createmultipointshape}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createMultipointShape<TOverrides extends object>(
    points: ShapePoint[],
    options: CreateMultipointShapeOptions<TOverrides>,
  ): EntityId | null;
```

Creates a drawing from several points, using the tool named in `options.shape`, and returns its id, or null when the chart did not create it. Throws when the points do not fit the tool or fail validation.

| Parameter | Type | Required |
| --- | --- | --- |
| `points` | `ShapePoint[]` | Yes |
| `options` | `CreateMultipointShapeOptions<TOverrides>` | Yes |

## createAnchoredShape {#createanchoredshape}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createAnchoredShape<TOverrides extends object>(
    position: PositionPercents,
    options: CreateAnchoredShapeOptions<TOverrides>,
  ): EntityId | null;
```

Creates a drawing positioned by a percentage of the pane rather than by time and price, and returns its id or null. Behaves like `createShape` with the anchored flag set.

| Parameter | Type | Required |
| --- | --- | --- |
| `position` | `PositionPercents` | Yes |
| `options` | `CreateAnchoredShapeOptions<TOverrides>` | Yes |

## getShapeById {#getshapebyid}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getShapeById(entityId: EntityId): ILineDataSourceApi;
```

Returns an API object for reading and editing the drawing with the given id, such as its points and properties.

| Parameter | Type | Required |
| --- | --- | --- |
| `entityId` | `EntityId` | Yes |

## removeEntity {#removeentity}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
removeEntity(entityId: EntityId, options?: UndoOptions): void;
```

Removes the drawing or study with the given id. Logs a warning when no drawing or study has that id.

| Parameter | Type | Required |
| --- | --- | --- |
| `entityId` | `EntityId` | Yes |
| `options` | `UndoOptions` | No |

## removeAllShapes {#removeallshapes}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
removeAllShapes(): void;
```

Removes every drawing from the chart and clears its drawing groups.

## removeAllStudies {#removeallstudies}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
removeAllStudies(): void;
```

Removes every study from the chart, along with drawings attached to those studies, as one undoable step.

## selection {#selection}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
selection(): ISelectionApi;
```

Returns an API object for reading and changing which drawings and studies are selected, and for subscribing to selection changes.

## showPropertiesDialog {#showpropertiesdialog}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
showPropertiesDialog(studyId: EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `EntityId` | Yes |

## createStudyTemplate {#createstudytemplate}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createStudyTemplate(options: CreateStudyTemplateOptions): object;
```

Returns a plain-object template of the chart's studies and pane layout, optionally including the symbol (`saveSymbol`) and interval (`saveInterval`). Throws when study templates are unavailable.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `CreateStudyTemplateOptions` | Yes |

## applyStudyTemplate {#applystudytemplate}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
applyStudyTemplate(template: object): void;
```

Replaces the chart's studies and pane layout with those in a template, switching symbol or interval only when the template includes them; the change is recorded as one undo step. Throws a `TypeError` when the template is not a plain object.

| Parameter | Type | Required |
| --- | --- | --- |
| `template` | `object` | Yes |

## createOrderLine {#createorderline}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createOrderLine(options?: UndoOptions): IOrderLineAdapter;
```

Adds an order line at the latest price and returns an adapter for configuring it, with order-line defaults from the trading customization applied. Pass `disableUndo: true` to keep the creation out of undo history.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `UndoOptions` | No |

**Failure conditions:** `Order lines are not supported by this chart`.

## createPositionLine {#createpositionline}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createPositionLine(options?: UndoOptions): IPositionLineAdapter;
```

Adds a position line at the latest price and returns an adapter for configuring it, with position-line defaults from the trading customization applied. Pass `disableUndo: true` to keep the creation out of undo history.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `UndoOptions` | No |

**Failure conditions:** `Position lines are not supported by this chart`.

## createExecutionShape {#createexecutionshape}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createExecutionShape(options?: UndoOptions): IExecutionLineAdapter;
```

Adds an execution marker at the latest price and time and returns an adapter for configuring it. Pass `disableUndo: true` to keep the creation out of undo history.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `UndoOptions` | No |

**Failure conditions:** `Execution shapes are not supported by this chart`.

## symbol {#symbol}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
symbol(): string;
```

Returns the chart's current symbol, or an empty string when none is set.

## symbolExt {#symbolext}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
symbolExt(): SymbolExt | null;
```

Returns the resolved symbol information for the main series, or null while the symbol has not resolved.

## resolution {#resolution}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
resolution(): ResolutionString;
```

Returns the chart's current resolution.

## getVisibleRange {#getvisiblerange}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getVisibleRange(): VisibleTimeRange;
```

Returns the time range currently visible on the chart; returns `{ from: 0, to: 0 }` before the chart surface is ready.

## priceFormatter {#priceformatter}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
priceFormatter(): INumberFormatter;
```

Use the type signature above and the integration guide for the owning capability.

## chartType {#charttype}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
chartType(): SeriesType;
```

Returns the current chart style of the main series.

## getTimezoneApi {#gettimezoneapi}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
getTimezoneApi(): ITimezoneApi;
```

Use the type signature above and the integration guide for the owning capability.

## getPanes {#getpanes}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getPanes(): IPaneApi[];
```

Returns an API object for each pane, top to bottom, giving access to its height, price scales and the studies it contains. The first pane holds the main series.

## exportData {#exportdata}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
exportData(options?: Partial<ExportDataOptions>): Promise<ExportedData>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `Partial<ExportDataOptions>` | No |

## canZoomOut {#canzoomout}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
canZoomOut(): boolean;
```

Returns true when the bar spacing is greater than 3 pixels, so `zoomOut` can still shrink the bars.

## zoomOut {#zoomout}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
zoomOut(): void;
```

Zooms out by dividing the current bar spacing by 1.2.

## setZoomEnabled {#setzoomenabled}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setZoomEnabled(enabled: boolean): void;
```

Enables or disables zooming the chart through user interaction.

| Parameter | Type | Required |
| --- | --- | --- |
| `enabled` | `boolean` | Yes |

## setScrollEnabled {#setscrollenabled}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setScrollEnabled(enabled: boolean): void;
```

Enables or disables scrolling the chart through user interaction.

| Parameter | Type | Required |
| --- | --- | --- |
| `enabled` | `boolean` | Yes |

## shapesGroupController {#shapesgroupcontroller}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
shapesGroupController(): IShapesGroupControllerApi;
```

Returns an API object for creating, naming, hiding, locking and reordering groups of drawings.

## barTimeToEndOfPeriod {#bartimetoendofperiod}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
barTimeToEndOfPeriod(unixTime: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `unixTime` | `number` | Yes |

## endOfPeriodToBarTime {#endofperiodtobartime}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
endOfPeriodToBarTime(unixTime: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `unixTime` | `number` | Yes |

## getTimeScale {#gettimescale}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getTimeScale(): ITimeScaleApi;
```

Returns an API object for the chart's time scale, with bar spacing, right offset, width and coordinate-to-time conversion.

## isSelectBarRequested {#isselectbarrequested}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
isSelectBarRequested(): boolean;
```

Returns true while a `requestSelectBar` request is waiting for the user to pick a bar.

## requestSelectBar {#requestselectbar}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
requestSelectBar(options?: SelectBarRequestOptions): Promise<number>;
```

Puts the chart into bar-selection mode and resolves with the time of the bar the user clicks. Rejects when a request is already pending, the main series has no data yet, or the selection is cancelled.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `SelectBarRequestOptions` | No |

## cancelSelectBar {#cancelselectbar}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
cancelSelectBar(): void;
```

Cancels a pending `requestSelectBar` request, which rejects its promise. Does nothing when no request is pending.

## resetView {#resetview}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
resetView(): void;
```

Restores the default time viewport and automatic price scale.

## loadChartTemplate {#loadcharttemplate}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
loadChartTemplate(templateName: string): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `templateName` | `string` | Yes |

## marketStatus {#marketstatus}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
marketStatus(): IWatchedValueReadonly<MarketStatus | null>;
```

Use the type signature above and the integration guide for the owning capability.

## setTimeFrame {#settimeframe}

**Compatibility declaration only.** This member is not exposed by the current source facade. Do not rely on it in this release.

```ts
setTimeFrame(timeFrame: RangeOptions): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `timeFrame` | `RangeOptions` | Yes |

## getLineToolsState {#getlinetoolsstate}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getLineToolsState(): LineToolsAndGroupsState;
```

Returns a serializable snapshot of the chart's drawings and drawing groups for saving to separate drawing storage. Throws when the `saveload_separate_drawings_storage` feature is disabled.

## applyLineToolsState {#applylinetoolsstate}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
applyLineToolsState(state: LineToolsAndGroupsState): Promise<void>;
```

Replaces the chart's drawings and drawing groups with those in a saved snapshot in one step. Rejects when the `saveload_separate_drawings_storage` feature is disabled.

| Parameter | Type | Required |
| --- | --- | --- |
| `state` | `LineToolsAndGroupsState` | Yes |

## reloadLineToolsFromServer {#reloadlinetoolsfromserver}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
reloadLineToolsFromServer(): void;
```

Re-reads the chart's drawings from separate drawing storage when one is attached; otherwise re-applies the current drawings without recording an undo step.

## Related types

- [OpenChartAutomationOptions](https://docs.lumencharts.com/charting-library/api/OpenChartAutomationOptions)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)
- [ChartDataStatus](https://docs.lumencharts.com/charting-library/api/ChartDataStatus)
- [ChartDatafeedConnectionStatus](https://docs.lumencharts.com/charting-library/api/ChartDatafeedConnectionStatus)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [TimeFrameValue](https://docs.lumencharts.com/charting-library/api/TimeFrameValue)
- [VisibleTimeRange](https://docs.lumencharts.com/charting-library/api/VisibleTimeRange)
- [SeriesType](https://docs.lumencharts.com/charting-library/api/SeriesType)
- [CrossHairMovedEventParams](https://docs.lumencharts.com/charting-library/api/CrossHairMovedEventParams)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [SetVisibleTimeRange](https://docs.lumencharts.com/charting-library/api/SetVisibleTimeRange)
- [SetVisibleRangeOptions](https://docs.lumencharts.com/charting-library/api/SetVisibleRangeOptions)
- [SetSymbolOptions](https://docs.lumencharts.com/charting-library/api/SetSymbolOptions)
- [SetResolutionOptions](https://docs.lumencharts.com/charting-library/api/SetResolutionOptions)
- [ChartActionId](https://docs.lumencharts.com/charting-library/api/ChartActionId)
- [ClearMarksMode](https://docs.lumencharts.com/charting-library/api/ClearMarksMode)
- [EntityInfo](https://docs.lumencharts.com/charting-library/api/EntityInfo)
- [UndoOptions](https://docs.lumencharts.com/charting-library/api/UndoOptions)
- [AvailableZOrderOperations](https://docs.lumencharts.com/charting-library/api/AvailableZOrderOperations)
- [SingleIndicatorOverrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#singleindicatoroverrides)
- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)
- [CreateStudyOptions](https://docs.lumencharts.com/charting-library/api/CreateStudyOptions)
- [PineScriptRunOptions](https://docs.lumencharts.com/charting-library/api/PineScriptRunOptions)
- [PineScriptCompileResult](https://docs.lumencharts.com/charting-library/api/PineScriptCompileResult)
- [PineScriptStudyOptions](https://docs.lumencharts.com/charting-library/api/PineScriptStudyOptions)
- [PineScriptStudyState](https://docs.lumencharts.com/charting-library/api/PineScriptStudyState)
- [PineAlertRuleInput](https://docs.lumencharts.com/charting-library/api/PineAlertRuleInput)
- [PineAlertRule](https://docs.lumencharts.com/charting-library/api/PineAlertRule)
- [PineAlertEvent](https://docs.lumencharts.com/charting-library/api/PineAlertEvent)
- [PineStrategyReport](https://docs.lumencharts.com/charting-library/api/PineStrategyReport)
- [PineStudyObjectSnapshot](https://docs.lumencharts.com/charting-library/api/PineStudyObjectSnapshot)
- [PineWorkspaceListRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceListRequest)
- [PineWorkspacePage](https://docs.lumencharts.com/charting-library/api/PineWorkspacePage)
- [PineWorkspaceDocument](https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocument)
- [PineWorkspaceCreateRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceCreateRequest)
- [PineWorkspaceUpdateRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceUpdateRequest)
- [PineWorkspaceRevisionListRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionListRequest)
- [PineWorkspaceRevisionPage](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionPage)
- [PineWorkspaceRevision](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevision)
- [PinePublicationIdentity](https://docs.lumencharts.com/charting-library/api/PinePublicationIdentity)
- [PinePublication](https://docs.lumencharts.com/charting-library/api/PinePublication)
- [PineAlertDeliveryStatus](https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryStatus)
- [PineObjectOverrideSnapshot](https://docs.lumencharts.com/charting-library/api/PineObjectOverrideSnapshot)
- [PineObjectOverridePatch](https://docs.lumencharts.com/charting-library/api/PineObjectOverridePatch)
- [PineObjectOverridePath](https://docs.lumencharts.com/charting-library/api/PineObjectOverridePath)
- [PineStrategyReportChange](https://docs.lumencharts.com/charting-library/api/PineStrategyReportChange)
- [PineStudyObjectChange](https://docs.lumencharts.com/charting-library/api/PineStudyObjectChange)
- [PineObjectOverrideChange](https://docs.lumencharts.com/charting-library/api/PineObjectOverrideChange)
- [PineStudyMigrationReport](https://docs.lumencharts.com/charting-library/api/PineStudyMigrationReport)
- [IStudyApi](https://docs.lumencharts.com/charting-library/api/IStudyApi)
- [ISeriesApi](https://docs.lumencharts.com/charting-library/api/ISeriesApi)
- [ShapePoint](https://docs.lumencharts.com/charting-library/api/ShapePoint)
- [CreateShapeOptions](https://docs.lumencharts.com/charting-library/api/CreateShapeOptions)
- [CreateMultipointShapeOptions](https://docs.lumencharts.com/charting-library/api/CreateMultipointShapeOptions)
- [PositionPercents](https://docs.lumencharts.com/charting-library/api/PositionPercents)
- [CreateAnchoredShapeOptions](https://docs.lumencharts.com/charting-library/api/CreateAnchoredShapeOptions)
- [ILineDataSourceApi](https://docs.lumencharts.com/charting-library/api/ILineDataSourceApi)
- [ISelectionApi](https://docs.lumencharts.com/charting-library/api/ISelectionApi)
- [CreateStudyTemplateOptions](https://docs.lumencharts.com/charting-library/api/CreateStudyTemplateOptions)
- [IOrderLineAdapter](https://docs.lumencharts.com/charting-library/api/IOrderLineAdapter)
- [IPositionLineAdapter](https://docs.lumencharts.com/charting-library/api/IPositionLineAdapter)
- [IExecutionLineAdapter](https://docs.lumencharts.com/charting-library/api/IExecutionLineAdapter)
- [SymbolExt](https://docs.lumencharts.com/charting-library/api/SymbolExt)
- [INumberFormatter](https://docs.lumencharts.com/charting-library/api/INumberFormatter)
- [ITimezoneApi](https://docs.lumencharts.com/charting-library/api/ITimezoneApi)
- [IPaneApi](https://docs.lumencharts.com/charting-library/api/IPaneApi)
- [ExportDataOptions](https://docs.lumencharts.com/charting-library/api/ExportDataOptions)
- [ExportedData](https://docs.lumencharts.com/charting-library/api/ExportedData)
- [IShapesGroupControllerApi](https://docs.lumencharts.com/charting-library/api/IShapesGroupControllerApi)
- [ITimeScaleApi](https://docs.lumencharts.com/charting-library/api/ITimeScaleApi)
- [SelectBarRequestOptions](https://docs.lumencharts.com/charting-library/api/SelectBarRequestOptions)
- [IWatchedValueReadonly](https://docs.lumencharts.com/charting-library/api/IWatchedValueReadonly)
- [MarketStatus](https://docs.lumencharts.com/charting-library/api/MarketStatus)
- [RangeOptions](https://docs.lumencharts.com/charting-library/api/RangeOptions)
- [LineToolsAndGroupsState](https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsState)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IChartWidgetApi


---

<!-- Public documentation export; not library implementation source. -->
# IconOptions

[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.

## icon {#icon}

```ts
icon: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IconOptions


---

<!-- Public documentation export; not library implementation source. -->
# IContext

[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.

## symbol {#symbol}

```ts
symbol: ISymbolInstrument;
```

Use the type signature above and the integration guide for the owning capability.

## new_sym {#new_sym}

```ts
new_sym(
    tickerid: string,
    period: string,
    currencyCode?: string,
    unitId?: string,
    subsessionId?: string,
  ): ISymbolInstrument;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `tickerid` | `string` | Yes |
| `period` | `string` | Yes |
| `currencyCode` | `string` | No |
| `unitId` | `string` | No |
| `subsessionId` | `string` | No |

## select_sym {#select_sym}

```ts
select_sym(i: number): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `i` | `number` | Yes |

## new_var {#new_var}

```ts
new_var(value?: number): IPineSeries;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | No |

## new_unlimited_var {#new_unlimited_var}

```ts
new_unlimited_var(value?: number): IPineSeries;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | No |

## new_ctx {#new_ctx}

```ts
new_ctx(): IContext;
```

Use the type signature above and the integration guide for the owning capability.

## is_main_symbol {#is_main_symbol}

```ts
is_main_symbol(symbol: ISymbolInstrument | undefined): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbol` | `ISymbolInstrument &#124; undefined` | Yes |

## Related types

- [ISymbolInstrument](https://docs.lumencharts.com/charting-library/api/ISymbolInstrument)
- [IPineSeries](https://docs.lumencharts.com/charting-library/api/IPineSeries)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IContext


---

<!-- Public documentation export; not library implementation source. -->
# IContextMenuRenderer

[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.

## show {#show}

```ts
show(pos: ContextMenuPosition): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `pos` | `ContextMenuPosition` | Yes |

## hide {#hide}

```ts
hide(): void;
```

Use the type signature above and the integration guide for the owning capability.

## isShown {#isshown}

```ts
isShown(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ContextMenuPosition](https://docs.lumencharts.com/charting-library/api/ContextMenuPosition)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IContextMenuRenderer


---

<!-- Public documentation export; not library implementation source. -->
# ICustomSymbolStatusAdapter

[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.

## getVisible {#getvisible}

```ts
getVisible(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setVisible {#setvisible}

```ts
setVisible(visible: boolean): ICustomSymbolStatusAdapter;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `visible` | `boolean` | Yes |

## getIcon {#geticon}

```ts
getIcon(): string | null;
```

Use the type signature above and the integration guide for the owning capability.

## setIcon {#seticon}

```ts
setIcon(icon: string | null): ICustomSymbolStatusAdapter;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `icon` | `string &#124; null` | Yes |

## getColor {#getcolor}

```ts
getColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setColor {#setcolor}

```ts
setColor(color: string): ICustomSymbolStatusAdapter;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `color` | `string` | Yes |

## getTooltip {#gettooltip}

```ts
getTooltip(): string | null;
```

Use the type signature above and the integration guide for the owning capability.

## setTooltip {#settooltip}

```ts
setTooltip(tooltip: string | null): ICustomSymbolStatusAdapter;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `tooltip` | `string &#124; null` | Yes |

## getDropDownContent {#getdropdowncontent}

```ts
getDropDownContent(): CustomStatusDropDownContent[] | null;
```

Use the type signature above and the integration guide for the owning capability.

## setDropDownContent {#setdropdowncontent}

```ts
setDropDownContent(
    content: CustomStatusDropDownContent[] | null,
  ): ICustomSymbolStatusAdapter;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `content` | `CustomStatusDropDownContent[] &#124; null` | Yes |

## Related types

- [CustomStatusDropDownContent](https://docs.lumencharts.com/charting-library/api/CustomStatusDropDownContent)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ICustomSymbolStatusAdapter


---

<!-- Public documentation export; not library implementation source. -->
# ICustomSymbolStatusApi

[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.

## symbol {#symbol}

```ts
symbol(symbolId: string): ICustomSymbolStatusAdapter;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbolId` | `string` | Yes |

## hideAll {#hideall}

```ts
hideAll(): void;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ICustomSymbolStatusAdapter](https://docs.lumencharts.com/charting-library/api/ICustomSymbolStatusAdapter)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ICustomSymbolStatusApi


---

<!-- Public documentation export; not library implementation source. -->
# IDatafeedChartApi

[Integration guide](https://docs.lumencharts.com/charting-library/datafeed/) · [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.

## footprint {#footprint}

```ts
footprint?: FootprintProvider;
```

Optional rebuild volume footprint source.
**Beta.** This may change in a later release.

## getMarks {#getmarks}

```ts
getMarks?(
    symbolInfo: LibrarySymbolInfo,
    from: number,
    to: number,
    onDataCallback: GetMarksCallback<Mark>,
    resolution: ResolutionString,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbolInfo` | `LibrarySymbolInfo` | Yes |
| `from` | `number` | Yes |
| `to` | `number` | Yes |
| `onDataCallback` | `GetMarksCallback<Mark>` | Yes |
| `resolution` | `ResolutionString` | Yes |

## getTimescaleMarks {#gettimescalemarks}

```ts
getTimescaleMarks?(
    symbolInfo: LibrarySymbolInfo,
    from: number,
    to: number,
    onDataCallback: GetMarksCallback<TimescaleMark>,
    resolution: ResolutionString,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbolInfo` | `LibrarySymbolInfo` | Yes |
| `from` | `number` | Yes |
| `to` | `number` | Yes |
| `onDataCallback` | `GetMarksCallback<TimescaleMark>` | Yes |
| `resolution` | `ResolutionString` | Yes |

## getServerTime {#getservertime}

```ts
getServerTime?(callback: ServerTimeCallback): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `ServerTimeCallback` | Yes |

## searchSymbols {#searchsymbols}

```ts
searchSymbols(
    userInput: string,
    exchange: string,
    symbolType: string,
    onResult: SearchSymbolsCallback,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `userInput` | `string` | Yes |
| `exchange` | `string` | Yes |
| `symbolType` | `string` | Yes |
| `onResult` | `SearchSymbolsCallback` | Yes |

## resolveSymbol {#resolvesymbol}

```ts
resolveSymbol(
    symbolName: string,
    onResolve: ResolveCallback,
    onError: ErrorCallback,
    extension?: SymbolResolveExtension,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbolName` | `string` | Yes |
| `onResolve` | `ResolveCallback` | Yes |
| `onError` | `ErrorCallback` | Yes |
| `extension` | `SymbolResolveExtension` | No |

## getBars {#getbars}

```ts
getBars(
    symbolInfo: LibrarySymbolInfo,
    resolution: ResolutionString,
    periodParams: PeriodParams,
    onResult: HistoryCallback,
    onError: ErrorCallback,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbolInfo` | `LibrarySymbolInfo` | Yes |
| `resolution` | `ResolutionString` | Yes |
| `periodParams` | `PeriodParams` | Yes |
| `onResult` | `HistoryCallback` | Yes |
| `onError` | `ErrorCallback` | Yes |

## subscribeBars {#subscribebars}

```ts
subscribeBars(
    symbolInfo: LibrarySymbolInfo,
    resolution: ResolutionString,
    onTick: SubscribeBarsCallback,
    listenerGuid: string,
    onResetCacheNeededCallback: () => void,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbolInfo` | `LibrarySymbolInfo` | Yes |
| `resolution` | `ResolutionString` | Yes |
| `onTick` | `SubscribeBarsCallback` | Yes |
| `listenerGuid` | `string` | Yes |
| `onResetCacheNeededCallback` | `() => void` | Yes |

## unsubscribeBars {#unsubscribebars}

```ts
unsubscribeBars(listenerGuid: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listenerGuid` | `string` | Yes |

## subscribeDepth {#subscribedepth}

```ts
subscribeDepth?(symbol: string, callback: DOMCallback): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbol` | `string` | Yes |
| `callback` | `DOMCallback` | Yes |

## unsubscribeDepth {#unsubscribedepth}

```ts
unsubscribeDepth?(subscriberUID: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `subscriberUID` | `string` | Yes |

## getVolumeProfileResolutionForPeriod {#getvolumeprofileresolutionforperiod}

```ts
getVolumeProfileResolutionForPeriod?(
    currentResolution: ResolutionString,
    from: number,
    to: number,
    symbolInfo: LibrarySymbolInfo,
  ): ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `currentResolution` | `ResolutionString` | Yes |
| `from` | `number` | Yes |
| `to` | `number` | Yes |
| `symbolInfo` | `LibrarySymbolInfo` | Yes |

## Related types

- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)
- [GetMarksCallback](https://docs.lumencharts.com/charting-library/api/GetMarksCallback)
- [Mark](https://docs.lumencharts.com/charting-library/api/Mark)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [TimescaleMark](https://docs.lumencharts.com/charting-library/api/TimescaleMark)
- [ServerTimeCallback](https://docs.lumencharts.com/charting-library/api/ServerTimeCallback)
- [SearchSymbolsCallback](https://docs.lumencharts.com/charting-library/api/SearchSymbolsCallback)
- [ResolveCallback](https://docs.lumencharts.com/charting-library/api/ResolveCallback)
- [ErrorCallback](https://docs.lumencharts.com/charting-library/api/ErrorCallback)
- [SymbolResolveExtension](https://docs.lumencharts.com/charting-library/api/SymbolResolveExtension)
- [PeriodParams](https://docs.lumencharts.com/charting-library/api/PeriodParams)
- [HistoryCallback](https://docs.lumencharts.com/charting-library/api/HistoryCallback)
- [SubscribeBarsCallback](https://docs.lumencharts.com/charting-library/api/SubscribeBarsCallback)
- [DOMCallback](https://docs.lumencharts.com/charting-library/api/DOMCallback)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IDatafeedChartApi


---

<!-- Public documentation export; not library implementation source. -->
# IDatafeedQuotesApi

[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.

## getQuotes {#getquotes}

```ts
getQuotes(
    symbols: string[],
    onDataCallback: QuotesCallback,
    onErrorCallback: QuotesErrorCallback,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbols` | `string[]` | Yes |
| `onDataCallback` | `QuotesCallback` | Yes |
| `onErrorCallback` | `QuotesErrorCallback` | Yes |

## subscribeQuotes {#subscribequotes}

```ts
subscribeQuotes(
    symbols: string[],
    fastSymbols: string[],
    onRealtimeCallback: QuotesCallback,
    listenerGUID: string,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbols` | `string[]` | Yes |
| `fastSymbols` | `string[]` | Yes |
| `onRealtimeCallback` | `QuotesCallback` | Yes |
| `listenerGUID` | `string` | Yes |

## unsubscribeQuotes {#unsubscribequotes}

```ts
unsubscribeQuotes(listenerGUID: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listenerGUID` | `string` | Yes |

## Related types

- [QuotesCallback](https://docs.lumencharts.com/charting-library/api/QuotesCallback)
- [QuotesErrorCallback](https://docs.lumencharts.com/charting-library/api/QuotesErrorCallback)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IDatafeedQuotesApi


---

<!-- Public documentation export; not library implementation source. -->
# IDestroyable

[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.

## destroy {#destroy}

```ts
destroy(): void;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IDestroyable


---

<!-- Public documentation export; not library implementation source. -->
# IDropdownApi

[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.

## applyOptions {#applyoptions}

```ts
applyOptions(options: DropdownUpdateParams): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `DropdownUpdateParams` | Yes |

## remove {#remove}

```ts
remove(): void;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [DropdownUpdateParams](https://docs.lumencharts.com/charting-library/api/DropdownUpdateParams)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IDropdownApi


---

<!-- Public documentation export; not library implementation source. -->
# IExecutionLineAdapter

[Integration guide](https://docs.lumencharts.com/charting-library/drawings#host-trading-overlays) · [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.

## remove {#remove}

```ts
remove(): void;
```

Use the type signature above and the integration guide for the owning capability.

## getPrice {#getprice}

```ts
getPrice(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setPrice {#setprice}

```ts
setPrice(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getTime {#gettime}

```ts
getTime(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setTime {#settime}

```ts
setTime(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getDirection {#getdirection}

```ts
getDirection(): Direction;
```

Use the type signature above and the integration guide for the owning capability.

## setDirection {#setdirection}

```ts
setDirection(value: Direction): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `Direction` | Yes |

## getText {#gettext}

```ts
getText(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setText {#settext}

```ts
setText(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getTooltip {#gettooltip}

```ts
getTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setTooltip {#settooltip}

```ts
setTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getArrowHeight {#getarrowheight}

```ts
getArrowHeight(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setArrowHeight {#setarrowheight}

```ts
setArrowHeight(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getArrowSpacing {#getarrowspacing}

```ts
getArrowSpacing(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setArrowSpacing {#setarrowspacing}

```ts
setArrowSpacing(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getFont {#getfont}

```ts
getFont(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setFont {#setfont}

```ts
setFont(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getTextColor {#gettextcolor}

```ts
getTextColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setTextColor {#settextcolor}

```ts
setTextColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getArrowColor {#getarrowcolor}

```ts
getArrowColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setArrowColor {#setarrowcolor}

```ts
setArrowColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## Related types

- [Direction](https://docs.lumencharts.com/charting-library/api/Direction)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IExecutionLineAdapter


---

<!-- Public documentation export; not library implementation source. -->
# IExternalDatafeed

[Integration guide](https://docs.lumencharts.com/charting-library/datafeed/) · [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.

## onReady {#onready}

```ts
onReady(callback: OnReadyCallback): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `OnReadyCallback` | Yes |

## Related types

- [OnReadyCallback](https://docs.lumencharts.com/charting-library/api/OnReadyCallback)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IExternalDatafeed


---

<!-- Public documentation export; not library implementation source. -->
# IExternalSaveLoadAdapter

[Integration guide](https://docs.lumencharts.com/charting-library/persistence#saveload-adapter) · [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.

## getAllCharts {#getallcharts}

```ts
getAllCharts(): Promise<ChartMetaInfo[]>;
```

Use the type signature above and the integration guide for the owning capability.

## removeChart {#removechart}

```ts
removeChart<T extends number | string>(id: T): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `T` | Yes |

## saveChart {#savechart}

```ts
saveChart(chartData: ChartData): Promise<string>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `chartData` | `ChartData` | Yes |

## getChartContent {#getchartcontent}

```ts
getChartContent(chartId: number): Promise<string>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `chartId` | `number` | Yes |

## getAllStudyTemplates {#getallstudytemplates}

```ts
getAllStudyTemplates(): Promise<StudyTemplateMetaInfo[]>;
```

Use the type signature above and the integration guide for the owning capability.

## removeStudyTemplate {#removestudytemplate}

```ts
removeStudyTemplate(studyTemplateInfo: StudyTemplateMetaInfo): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyTemplateInfo` | `StudyTemplateMetaInfo` | Yes |

## saveStudyTemplate {#savestudytemplate}

```ts
saveStudyTemplate(studyTemplateData: StudyTemplateData): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyTemplateData` | `StudyTemplateData` | Yes |

## getStudyTemplateContent {#getstudytemplatecontent}

```ts
getStudyTemplateContent(
    studyTemplateInfo: StudyTemplateMetaInfo,
  ): Promise<string>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyTemplateInfo` | `StudyTemplateMetaInfo` | Yes |

## getDrawingTemplates {#getdrawingtemplates}

```ts
getDrawingTemplates(toolName: string): Promise<string[]>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `toolName` | `string` | Yes |

## loadDrawingTemplate {#loaddrawingtemplate}

```ts
loadDrawingTemplate(toolName: string, templateName: string): Promise<string>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `toolName` | `string` | Yes |
| `templateName` | `string` | Yes |

## removeDrawingTemplate {#removedrawingtemplate}

```ts
removeDrawingTemplate(toolName: string, templateName: string): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `toolName` | `string` | Yes |
| `templateName` | `string` | Yes |

## saveDrawingTemplate {#savedrawingtemplate}

```ts
saveDrawingTemplate(
    toolName: string,
    templateName: string,
    content: string,
  ): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `toolName` | `string` | Yes |
| `templateName` | `string` | Yes |
| `content` | `string` | Yes |

## getChartTemplateContent {#getcharttemplatecontent}

```ts
getChartTemplateContent(templateName: string): Promise<ChartTemplate>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `templateName` | `string` | Yes |

## getAllChartTemplates {#getallcharttemplates}

```ts
getAllChartTemplates(): Promise<string[]>;
```

Use the type signature above and the integration guide for the owning capability.

## saveChartTemplate {#savecharttemplate}

```ts
saveChartTemplate(
    newName: string,
    theme: ChartTemplateContent,
  ): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `newName` | `string` | Yes |
| `theme` | `ChartTemplateContent` | Yes |

## removeChartTemplate {#removecharttemplate}

```ts
removeChartTemplate(templateName: string): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `templateName` | `string` | Yes |

## saveLineToolsAndGroups {#savelinetoolsandgroups}

```ts
saveLineToolsAndGroups(
    layoutId: string | undefined,
    chartId: string | number,
    state: LineToolsAndGroupsState,
  ): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `layoutId` | `string &#124; undefined` | Yes |
| `chartId` | `string &#124; number` | Yes |
| `state` | `LineToolsAndGroupsState` | Yes |

## loadLineToolsAndGroups {#loadlinetoolsandgroups}

```ts
loadLineToolsAndGroups(
    layoutId: string | undefined,
    chartId: string | number,
    requestType: LineToolsAndGroupsLoadRequestType,
    requestContext: LineToolsAndGroupsLoadRequestContext,
  ): Promise<Partial<LineToolsAndGroupsState> | null>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `layoutId` | `string &#124; undefined` | Yes |
| `chartId` | `string &#124; number` | Yes |
| `requestType` | `LineToolsAndGroupsLoadRequestType` | Yes |
| `requestContext` | `LineToolsAndGroupsLoadRequestContext` | Yes |

## Related types

- [ChartMetaInfo](https://docs.lumencharts.com/charting-library/api/ChartMetaInfo)
- [ChartData](https://docs.lumencharts.com/charting-library/api/ChartData)
- [StudyTemplateMetaInfo](https://docs.lumencharts.com/charting-library/api/StudyTemplateMetaInfo)
- [StudyTemplateData](https://docs.lumencharts.com/charting-library/api/StudyTemplateData)
- [ChartTemplate](https://docs.lumencharts.com/charting-library/api/ChartTemplate)
- [ChartTemplateContent](https://docs.lumencharts.com/charting-library/api/ChartTemplateContent)
- [LineToolsAndGroupsState](https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsState)
- [LineToolsAndGroupsLoadRequestType](https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsLoadRequestType)
- [LineToolsAndGroupsLoadRequestContext](https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsLoadRequestContext)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IExternalSaveLoadAdapter


---

<!-- Public documentation export; not library implementation source. -->
# IFormatter

[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.

## format {#format}

```ts
format(value?: T): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `T` | No |

## parse {#parse}

```ts
parse?(
    value: string,
  ): ErrorFormatterParseResult | SuccessFormatterParseResult<T>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## Related types

- [ErrorFormatterParseResult](https://docs.lumencharts.com/charting-library/api/ErrorFormatterParseResult)
- [SuccessFormatterParseResult](https://docs.lumencharts.com/charting-library/api/SuccessFormatterParseResult)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IFormatter


---

<!-- Public documentation export; not library implementation source. -->
# ILineDataSourceApi

[Integration guide](https://docs.lumencharts.com/charting-library/drawings/) · [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.

## isSelectionEnabled {#isselectionenabled}

```ts
isSelectionEnabled(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setSelectionEnabled {#setselectionenabled}

```ts
setSelectionEnabled(enable: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `enable` | `boolean` | Yes |

## isSavingEnabled {#issavingenabled}

```ts
isSavingEnabled(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setSavingEnabled {#setsavingenabled}

```ts
setSavingEnabled(enable: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `enable` | `boolean` | Yes |

## isShowInObjectsTreeEnabled {#isshowinobjectstreeenabled}

```ts
isShowInObjectsTreeEnabled(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setShowInObjectsTreeEnabled {#setshowinobjectstreeenabled}

```ts
setShowInObjectsTreeEnabled(enabled: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `enabled` | `boolean` | Yes |

## 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 |

## 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.

## getProperties {#getproperties}

```ts
getProperties(): Record<string, any>;
```

Use the type signature above and the integration guide for the owning capability.

## setProperties {#setproperties}

```ts
setProperties(newProperties: object): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `newProperties` | `object` | Yes |

## getPoints {#getpoints}

```ts
getPoints(): PricedPoint[];
```

Use the type signature above and the integration guide for the owning capability.

## setPoints {#setpoints}

```ts
setPoints(points: ShapePoint[]): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `points` | `ShapePoint[]` | Yes |

## getAnchoredPosition {#getanchoredposition}

```ts
getAnchoredPosition(): PositionPercents | undefined;
```

Use the type signature above and the integration guide for the owning capability.

## setAnchoredPosition {#setanchoredposition}

```ts
setAnchoredPosition(positionPercents: PositionPercents): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `positionPercents` | `PositionPercents` | Yes |

## Related types

- [PricedPoint](https://docs.lumencharts.com/charting-library/api/PricedPoint)
- [ShapePoint](https://docs.lumencharts.com/charting-library/api/ShapePoint)
- [PositionPercents](https://docs.lumencharts.com/charting-library/api/PositionPercents)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ILineDataSourceApi


---

<!-- Public documentation export; not library implementation source. -->
# ILumenChartingLibraryWidget

[Integration guide](https://docs.lumencharts.com/charting-library/getting-started/lifecycle) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Runtime facade. Entries identify whether the current source exposes each member. Optional provider-dependent methods still require their configured capability.

The widget returned by `new LumenChartingLibrary.widget(options)`. It owns the chart iframe, its charts and layout, and is disposed with `remove()`.

## loadAutomation {#loadautomation}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
loadAutomation(): Promise<void>;
```

Explicitly load the optional automation asset before creating command adapters.

## loadTrading {#loadtrading}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
loadTrading(): Promise<void>;
```

Install optional trading assets for this widget collection; broker hydration is independent.

## headerReady {#headerready}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
headerReady(): Promise<void>;
```

Returns a promise that resolves once the chart frame has loaded and the header toolbar is ready to accept custom buttons and dropdowns. Rejects when the header is disabled.

## onChartReady {#onchartready}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onChartReady(callback: EmptyCallback): void;
```

Registers a callback that runs once the chart API is ready, or runs it immediately if the chart is already ready. Errors thrown by the callback are logged and do not stop other ready callbacks.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `EmptyCallback` | Yes |

## onGrayedObjectClicked {#ongrayedobjectclicked}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onGrayedObjectClicked(callback: (obj: GrayedObject) => void): void;
```

Accepted for compatibility; has no effect.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `(obj: GrayedObject) => void` | Yes |

## onShortcut {#onshortcut}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onShortcut(
    shortCut: string | number | (string | number)[],
    callback: EmptyCallback,
  ): void;
```

Registers a keyboard shortcut inside the chart frame and calls `callback` with the keyboard event when it is pressed. The shortcut is registered after the chart frame loads.

| Parameter | Type | Required |
| --- | --- | --- |
| `shortCut` | `string &#124; number &#124; (string &#124; number)[]` | Yes |
| `callback` | `EmptyCallback` | Yes |

## subscribe {#subscribe}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
subscribe<EventName extends keyof SubscribeEventsMap>(
    event: EventName,
    callback: SubscribeEventsMap[EventName],
  ): void;
```

Subscribes `callback` to a widget event once the chart API is ready. Keep the same callback reference to remove it later with `unsubscribe`.

| Parameter | Type | Required |
| --- | --- | --- |
| `event` | `EventName` | Yes |
| `callback` | `SubscribeEventsMap[EventName]` | Yes |

## unsubscribe {#unsubscribe}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
unsubscribe<EventName extends keyof SubscribeEventsMap>(
    event: EventName,
    callback: SubscribeEventsMap[EventName],
  ): void;
```

Removes a callback previously added with `subscribe`. Subscriptions are matched by callback reference.

| Parameter | Type | Required |
| --- | --- | --- |
| `event` | `EventName` | Yes |
| `callback` | `SubscribeEventsMap[EventName]` | Yes |

## chart {#chart}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
chart(index?: number): IChartWidgetApi;
```

Returns the API for the visible chart at `index` in the layout, defaulting to the first chart. Throws a `RangeError` when the index is outside the visible charts.

| Parameter | Type | Required |
| --- | --- | --- |
| `index` | `number` | No |

## getLanguage {#getlanguage}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getLanguage(): LanguageCode;
```

Returns the locale the widget resolved at construction; unsupported locales fall back to `en`.

## setSymbol {#setsymbol}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setSymbol(
    symbol: string,
    interval: ResolutionString,
    callback: EmptyCallback,
  ): void;
```

Changes the symbol of the active chart, or of all linked charts when symbol lock is on, and sets the interval when one is given. `callback` runs once data for the new interval is ready, or immediately when no interval is passed.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbol` | `string` | Yes |
| `interval` | `ResolutionString` | Yes |
| `callback` | `EmptyCallback` | Yes |

## remove {#remove}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
remove(): void;
```

Removes the chart frame from the page, detaches the window resize listener, and drops any pending `onChartReady` callbacks.

## closePopupsAndDialogs {#closepopupsanddialogs}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
closePopupsAndDialogs(): void;
```

Closes the open chart dialog, or any open menus and popups, once the chart API is ready.

## selectLineTool {#selectlinetool}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
selectLineTool(linetool: "icon", options?: IconOptions): void;
```

Selects the icon drawing tool on the active chart, using `options` to choose the icon.

| Parameter | Type | Required |
| --- | --- | --- |
| `linetool` | `"icon"` | Yes |
| `options` | `IconOptions` | No |

## selectLineTool (overload 2) {#selectlinetool-1}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
selectLineTool(linetool: "emoji", options?: EmojiOptions): void;
```

Selects the emoji drawing tool on the active chart, using `options` to choose the emoji.

| Parameter | Type | Required |
| --- | --- | --- |
| `linetool` | `"emoji"` | Yes |
| `options` | `EmojiOptions` | No |

## selectLineTool (overload 3) {#selectlinetool-2}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
selectLineTool(
    linetool: SupportedLineTools,
    options?: IconOptions | EmojiOptions,
  ): void;
```

Selects a drawing tool on the active chart so the next pointer action draws it, applying any creation options. `cursor` clears the selection, `measure` starts a temporary measurement, and tools that are only selectable are ignored.

| Parameter | Type | Required |
| --- | --- | --- |
| `linetool` | `SupportedLineTools` | Yes |
| `options` | `IconOptions &#124; EmojiOptions` | No |

## selectedLineTool {#selectedlinetool}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
selectedLineTool(): SupportedLineTools;
```

Returns the drawing tool currently selected on the active chart, or `cursor` when none is selected.

## save {#save}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
save(callback: (state: object) => void, options?: SaveChartOptions): void;
```

Serializes the current layout and passes the state object to `callback` synchronously. Throws in an analysis workspace, where each chart is saved automatically.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `(state: object) => void` | Yes |
| `options` | `SaveChartOptions` | No |

## load {#load}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
load(state: object, extendedData?: SavedStateMetaInfo): void;
```

Replaces the current layout with a saved state, discarding charts the state does not use; `extendedData` sets the layout's id and name. Throws when the state cannot be restored or in an analysis workspace.

| Parameter | Type | Required |
| --- | --- | --- |
| `state` | `object` | Yes |
| `extendedData` | `SavedStateMetaInfo` | No |

## getSavedCharts {#getsavedcharts}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getSavedCharts(callback: (chartRecords: SaveLoadChartRecord[]) => void): void;
```

Fetches the list of saved layouts from the configured chart storage and passes the records to `callback`.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `(chartRecords: SaveLoadChartRecord[]) => void` | Yes |

## loadChartFromServer {#loadchartfromserver}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
loadChartFromServer(chartRecord: SaveLoadChartRecord): void;
```

Loads a saved layout from the configured chart storage and applies it to the widget. Records that are not valid storage records are ignored, and a load replaced by a later load does not apply.

| Parameter | Type | Required |
| --- | --- | --- |
| `chartRecord` | `SaveLoadChartRecord` | Yes |

## saveChartToServer {#savecharttoserver}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
saveChartToServer(
    onComplete?: EmptyCallback,
    onFail?: EmptyCallback,
    options?: SaveChartToServerOptions,
  ): void;
```

Saves the current layout to the configured chart storage, updating the current layout or creating a new one, and calls `onComplete` with the saved id and content. Calls `onFail` when the save fails or the layout has no name; saves run one at a time.

| Parameter | Type | Required |
| --- | --- | --- |
| `onComplete` | `EmptyCallback` | No |
| `onFail` | `EmptyCallback` | No |
| `options` | `SaveChartToServerOptions` | No |

## removeChartFromServer {#removechartfromserver}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
removeChartFromServer(
    chartId: string,
    onCompleteCallback: EmptyCallback,
  ): void;
```

Deletes the saved layout with `chartId` from the configured chart storage and calls `onCompleteCallback` when it finishes.

| Parameter | Type | Required |
| --- | --- | --- |
| `chartId` | `string` | Yes |
| `onCompleteCallback` | `EmptyCallback` | Yes |

## onContextMenu {#oncontextmenu}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
onContextMenu(
    callback: (unixTime: number, price: number) => ContextMenuItem[],
  ): void;
```

Adds a callback whose items are merged into the chart pane's context menu, called with the time and price under the pointer when the menu opens.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `(unixTime: number, price: number) => ContextMenuItem[]` | Yes |

## createButton {#createbutton}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createButton(options?: CreateHTMLButtonOptions): HTMLElement;
```

Adds a custom HTML button to the chart header and returns its element for you to fill and style. Throws if the header is not ready; wait for `headerReady()` first.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `CreateHTMLButtonOptions` | No |

## createButton (overload 2) {#createbutton-1}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createButton(options?: CreateChartUiStyledButtonOptions): void;
```

Adds a button styled like the built-in header controls, using the given label and click handler, and returns nothing. Throws if the header is not ready; wait for `headerReady()` first.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `CreateChartUiStyledButtonOptions` | No |

## createButton (overload 3) {#createbutton-2}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createButton(options?: CreateButtonOptions): HTMLElement | undefined;
```

Adds a custom button to the chart header and returns its element, or `undefined` for a chart-UI-styled button. Throws if the header is not ready; wait for `headerReady()` first.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `CreateButtonOptions` | No |

## createDropdown {#createdropdown}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
createDropdown(params: DropdownParams): Promise<IDropdownApi>;
```

Adds a dropdown to the chart header and resolves with an API to update or remove it once the header is ready. Throws when called without parameters and rejects when the header is disabled.

| Parameter | Type | Required |
| --- | --- | --- |
| `params` | `DropdownParams` | Yes |

## showNoticeDialog {#shownoticedialog}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
showNoticeDialog(params: DialogParams<() => void>): void;
```

Shows a message dialog with `title`, `body` and one OK button, then calls `callback` when it is dismissed. Waits for the chart UI to mount, or calls the callback if the UI is unavailable.

| Parameter | Type | Required |
| --- | --- | --- |
| `params` | `DialogParams<() => void>` | Yes |

## showConfirmDialog {#showconfirmdialog}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
showConfirmDialog(params: DialogParams<(confirmed: boolean) => void>): void;
```

Shows a dialog with `title`, `body`, OK and Cancel, then calls `callback` with `true` for OK and `false` for Cancel or dismissal. Waits for the chart UI to mount, or reports `false` if the UI is unavailable.

| Parameter | Type | Required |
| --- | --- | --- |
| `params` | `DialogParams<(confirmed: boolean) => void>` | Yes |

## showSymbolSearchDialog {#showsymbolsearchdialog}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
showSymbolSearchDialog(): void;
```

Open symbol search for the active chart.

## showLoadChartDialog {#showloadchartdialog}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
showLoadChartDialog(): void;
```

Opens the dialog for loading a saved layout.

## showSaveAsChartDialog {#showsaveaschartdialog}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
showSaveAsChartDialog(): void;
```

Opens the dialog for saving the current layout under a new name.

## symbolInterval {#symbolinterval}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
symbolInterval(): SymbolIntervalResult;
```

Returns the active chart's symbol and interval, along with its display symbol when one is resolved.

## mainSeriesPriceFormatter {#mainseriespriceformatter}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
mainSeriesPriceFormatter(): INumberFormatter;
```

Returns the price formatter for the active chart's main series, which uses the series precision and symbol information.

## getIntervals {#getintervals}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getIntervals(): string[];
```

Returns the intervals the active chart offers: the datafeed's supported resolutions, or the current interval when the datafeed declares none.

## getStudiesList {#getstudieslist}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getStudiesList(): string[];
```

Returns the names of all indicators in the study library, excluding hidden ones.

## getStudyInputs {#getstudyinputs}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getStudyInputs(studyName: string): StudyInputInformation[];
```

Returns the inputs of the indicator whose name matches `studyName`, ignoring case. Throws when no indicator matches.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyName` | `string` | Yes |

## getStudyStyles {#getstudystyles}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getStudyStyles(studyName: string): StudyStyleInfo;
```

Returns the plot and style metadata of the indicator whose name matches `studyName`, ignoring case. Throws when no indicator matches.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyName` | `string` | Yes |

## addCustomCSSFile {#addcustomcssfile}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
addCustomCSSFile(url: string): void;
```

Adds a stylesheet link to the chart frame. Call it after the chart frame has loaded.

| Parameter | Type | Required |
| --- | --- | --- |
| `url` | `string` | Yes |

## applyOverrides {#applyoverrides}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
applyOverrides<TOverrides extends Partial<ChartPropertiesOverrides>>(
    overrides: TOverrides,
  ): void;
```

Applies chart property overrides to every chart in the layout once the chart frame loads and keeps them in the widget options. Throws when the overrides select the volume footprint style without the `chart_style_volume_footprint` feature.

| Parameter | Type | Required |
| --- | --- | --- |
| `overrides` | `TOverrides` | Yes |

**Failure conditions:** `Volume footprint requires the chart_style_volume_footprint feature`.

## applyStudiesOverrides {#applystudiesoverrides}

**Limited.** The overrides are stored but not yet applied to indicators.

```ts
applyStudiesOverrides(overrides: object): void;
```

Records indicator default overrides on every chart. The current runtime stores them but does not apply them to existing or new indicators yet.

| Parameter | Type | Required |
| --- | --- | --- |
| `overrides` | `object` | Yes |

## watchList {#watchlist}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
watchList(): Promise<IWatchListApi>;
```

Resolves with the watchlist API, or with `null` when `widgetbar.watchlist` is not enabled.

## news {#news}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
news(): Promise<INewsApi>;
```

Returns a promise for the news panel API, which refreshes headlines for the active symbol from the configured news provider or RSS feeds. Resolves to `null` unless `widgetbar.news` is enabled in the widget options.

## widgetbar {#widgetbar}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
widgetbar(): Promise<IWidgetbarApi>;
```

Returns a promise for the widget bar API, which shows and hides right-toolbar pages such as the data window. When the `right_toolbar` feature is disabled, requests to open a page are ignored.

## activeChart {#activechart}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
activeChart(): IChartWidgetApi;
```

Returns the API of the chart that is currently active in the layout. Throws if the chart frame has not loaded yet.

## pineWorkspace {#pineworkspace}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
pineWorkspace(): Promise<PineEditorWorkspaceApi | null>;
```

Returns the host-facing Pine editor facade when Pine is enabled for this widget.

## pineRuntime {#pineruntime}

**Capability-dependent.** Requires the matching optional feature/provider and valid chart binding.

```ts
pineRuntime(): Promise<PineChartRuntimeApi | null>;
```

Returns a promise for the Pine chart runtime API once the chart frame has loaded. Resolves to `null` when `pine_script.enabled` is not set.

## activeChartIndex {#activechartindex}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
activeChartIndex(): number;
```

Returns the zero-based index of the active chart in the current layout.

## setActiveChart {#setactivechart}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setActiveChart(index: number): void;
```

Makes the chart at the given zero-based index active. Indices outside the visible charts are ignored, and a maximized layout stays maximized on the newly active chart.

| Parameter | Type | Required |
| --- | --- | --- |
| `index` | `number` | Yes |

## chartsCount {#chartscount}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
chartsCount(): number;
```

Returns the number of charts visible in the current layout.

## unloadUnusedCharts {#unloadunusedcharts}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
unloadUnusedCharts(): void;
```

Destroys charts kept in memory beyond the current layout's visible count, such as those left over after switching to a layout with fewer charts.

## layout {#layout}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
layout(): LayoutType;
```

Returns the current multi-chart layout type, falling back to the single-chart layout when the stored value is not a public layout.

## setLayout {#setlayout}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setLayout(layout: LayoutType): void;
```

Switches the widget to the given multi-chart layout, adding or hiding charts to match and emitting `layout_about_to_be_changed` and `layout_changed`. Unknown layout types are ignored; it throws when the layout needs more charts than allowed or when an analysis workspace manages the layout.

| Parameter | Type | Required |
| --- | --- | --- |
| `layout` | `LayoutType` | Yes |

## layoutName {#layoutname}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
layoutName(): string;
```

Returns the current layout type; this is the same value as `layout()`.

## resetCache {#resetcache}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
resetCache(): void;
```

Reset cached bar data for all chart sessions owned by this widget.

## resetLayoutSizes {#resetlayoutsizes}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
resetLayoutSizes(disableUndo?: boolean): void;
```

Restores the default split sizes of the charts in a multi-chart layout. The `disableUndo` argument is accepted but ignored.

| Parameter | Type | Required |
| --- | --- | --- |
| `disableUndo` | `boolean` | No |

## changeTheme {#changetheme}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
changeTheme(
    themeName: ThemeName,
    options?: ChangeThemeOptions,
  ): Promise<void>;
```

Switches every chart to the `dark` or `light` theme (any other name selects light), reapplies the user's saved chart defaults for that theme, and emits `theme_changed`. The `options` argument is ignored and the promise resolves once the theme is applied.

| Parameter | Type | Required |
| --- | --- | --- |
| `themeName` | `ThemeName` | Yes |
| `options` | `ChangeThemeOptions` | No |

## getTheme {#gettheme}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getTheme(): ThemeName;
```

Returns the current theme name, either `light` or `dark`.

## takeScreenshot {#takescreenshot}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
takeScreenshot(): void;
```

Captures an image of the visible charts once the chart API is ready and emits `onScreenshotReady` with the resulting image data URL.

## takeClientScreenshot {#takeclientscreenshot}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
takeClientScreenshot(
    options?: Partial<ClientSnapshotOptions> & { onlyActiveChart?: boolean; chartIndex?: number },
  ): Promise<string>;
```

Captures the visible charts in the browser and resolves with an image data URL (PNG or SVG), also emitting `onScreenshotReady`. Options can limit the capture to the active chart or one chart index; it rejects when the requested chart is unavailable.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `Partial<ClientSnapshotOptions> & { onlyActiveChart?: boolean; chartIndex?: number }` | No |

**Failure conditions:** `Chart capture is unavailable`.

## lockAllDrawingTools {#lockalldrawingtools}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
lockAllDrawingTools(): IWatchedValue<boolean>;
```

Returns a watched value of whether the active chart's drawings are locked against moving and editing. `setValue(true)` locks them; it follows the active chart.

## hideAllDrawingTools {#hidealldrawingtools}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
hideAllDrawingTools(): IWatchedValue<boolean>;
```

Returns a watched value of whether the active chart's drawings are hidden. `setValue(true)` hides them and drops them from the selection; it follows the active chart.

## magnetEnabled {#magnetenabled}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
magnetEnabled(): IWatchedValue<boolean>;
```

Returns a watched value that turns the drawing magnet on or off. It starts from the saved preference or the `magnet` widget option, defaults to `false`, and saves each change to settings storage.

## magnetMode {#magnetmode}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
magnetMode(): IWatchedValue<number>;
```

Returns a watched value holding the drawing magnet mode, `0` or `1`. It starts from the saved preference or the `magnetMode` widget option and saves each change to settings storage.

## symbolSync {#symbolsync}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
symbolSync(): IWatchedValue<boolean>;
```

Returns a watched value that controls whether charts in a multi-chart layout share the same symbol.

## intervalSync {#intervalsync}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
intervalSync(): IWatchedValue<boolean>;
```

Returns a watched value that controls whether charts in a multi-chart layout share the same interval.

## crosshairSync {#crosshairsync}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
crosshairSync(): IWatchedValue<boolean>;
```

Returns a watched value that controls whether the crosshair position is mirrored across charts in a multi-chart layout.

## timeSync {#timesync}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
timeSync(): IWatchedValue<boolean>;
```

Returns a watched value that controls whether charts in a multi-chart layout follow the same time position.

## dateRangeSync {#daterangesync}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
dateRangeSync(): IWatchedValue<boolean>;
```

Returns a watched value that controls whether charts in a multi-chart layout share the same visible date range.

## startFullscreen {#startfullscreen}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
startFullscreen(): void;
```

Requests browser fullscreen for the active chart's root element and emits `fullscreen_changed` with `true`.

## exitFullscreen {#exitfullscreen}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
exitFullscreen(): void;
```

Leaves browser fullscreen and emits `fullscreen_changed` with `false`.

## undoRedoState {#undoredostate}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
undoRedoState(): UndoRedoState;
```

Returns whether the active chart currently has an action to undo and an action to redo.

## navigationButtonsVisibility {#navigationbuttonsvisibility}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
navigationButtonsVisibility(): IWatchedValue<VisibilityType>;
```

Returns a watched value of the active chart's navigation button visibility (default `visibleOnMouseOver`). Setting it changes the active chart.

## paneButtonsVisibility {#panebuttonsvisibility}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
paneButtonsVisibility(): IWatchedValue<VisibilityType>;
```

Returns a watched value of the active chart's pane button visibility (default `visibleOnMouseOver`). Setting it changes the active chart.

## dateFormat {#dateformat}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
dateFormat(): IWatchedValue<DateFormat>;
```

Returns a watched value of the active chart's date format (default `dd MMM 'yy`). Setting it changes the active chart.

## timeHoursFormat {#timehoursformat}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
timeHoursFormat(): IWatchedValue<TimeHoursFormat>;
```

Returns a watched value of the active chart's time format (default `24-hours`). Setting it changes the active chart.

## currencyAndUnitVisibility {#currencyandunitvisibility}

**Limited.** The chart shows no currency or unit label, so the value stays `alwaysOff`.

```ts
currencyAndUnitVisibility(): IWatchedValue<VisibilityType>;
```

Returns a watched value fixed at `alwaysOff`: the chart shows no currency or unit label, so setting it has no effect.

## setDebugMode {#setdebugmode}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setDebugMode(enabled: boolean): void;
```

Stores the debug flag in the chart frame's options. The runtime does not read it after startup, so it has no visible effect.

| Parameter | Type | Required |
| --- | --- | --- |
| `enabled` | `boolean` | Yes |

## drawOnAllChartsEnabled {#drawonallchartsenabled}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
drawOnAllChartsEnabled(): IWatchedValue<boolean>;
```

Returns a watched value, `false` by default, that controls whether new drawings are synced to every chart in a multi-chart layout.

## clearUndoHistory {#clearundohistory}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
clearUndoHistory(): void;
```

Clears the undo and redo history of the active chart.

## setSaveStatus {#setsavestatus}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setSaveStatus(status: "saving" | "saved" | "failed" | "load-failed" | null): void;
```

Shows how the host's autosave is going in the header's save/load slot.
Requires the `header_save_status` featureset; `null` hides it. Clicking a
failed status raises `save_status_retry_requested`.

| Parameter | Type | Required |
| --- | --- | --- |
| `status` | `"saving" &#124; "saved" &#124; "failed" &#124; "load-failed" &#124; null` | Yes |

## supportedChartTypes {#supportedcharttypes}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
supportedChartTypes(): IWatchedValueReadonly<ChartStyle[]>;
```

Returns a read-only watched value listing the chart styles the runtime supports. It updates when the high-low style feature is turned on or off.

## watermark {#watermark}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
watermark(): IWatermarkApi;
```

Returns the watermark API for the active chart, which controls the watermark's color, visibility and text content.

## customSymbolStatus {#customsymbolstatus}

**Limited.** Statuses are stored but not yet drawn on the chart.

```ts
customSymbolStatus(): ICustomSymbolStatusApi;
```

Returns the store for custom symbol statuses: `symbol(id)` returns a chainable adapter for visibility, icon, colour, tooltip and drop-down content, and `hideAll()` hides every status. The chart keeps these values but does not draw them yet.

## setCSSCustomProperty {#setcsscustomproperty}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
setCSSCustomProperty(customPropertyName: string, value: string): void;
```

Sets a CSS custom property on the chart frame's body element. Throws when the name does not start with `--`.

| Parameter | Type | Required |
| --- | --- | --- |
| `customPropertyName` | `string` | Yes |
| `value` | `string` | Yes |

**Failure conditions:** `customPropertyName should begin with a double hyphen`.

## getCSSCustomPropertyValue {#getcsscustompropertyvalue}

**Runtime-backed.** Use after chart readiness unless this is a readiness or disposal method.

```ts
getCSSCustomPropertyValue(customPropertyName: string): string;
```

Returns the value of a CSS custom property from the chart frame's body, preferring an inline value over the computed style. Throws when the name does not start with `--`.

| Parameter | Type | Required |
| --- | --- | --- |
| `customPropertyName` | `string` | Yes |

**Failure conditions:** `customPropertyName should begin with a double hyphen`.

## Related types

- [EmptyCallback](https://docs.lumencharts.com/charting-library/api/EmptyCallback)
- [GrayedObject](https://docs.lumencharts.com/charting-library/api/GrayedObject)
- [SubscribeEventsMap](https://docs.lumencharts.com/charting-library/api/SubscribeEventsMap)
- [IChartWidgetApi](https://docs.lumencharts.com/charting-library/api/IChartWidgetApi)
- [LanguageCode](https://docs.lumencharts.com/charting-library/api/LanguageCode)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [IconOptions](https://docs.lumencharts.com/charting-library/api/IconOptions)
- [EmojiOptions](https://docs.lumencharts.com/charting-library/api/EmojiOptions)
- [SupportedLineTools](https://docs.lumencharts.com/charting-library/api/SupportedLineTools)
- [SaveChartOptions](https://docs.lumencharts.com/charting-library/api/SaveChartOptions)
- [SavedStateMetaInfo](https://docs.lumencharts.com/charting-library/api/SavedStateMetaInfo)
- [SaveLoadChartRecord](https://docs.lumencharts.com/charting-library/api/SaveLoadChartRecord)
- [SaveChartToServerOptions](https://docs.lumencharts.com/charting-library/api/SaveChartToServerOptions)
- [ContextMenuItem](https://docs.lumencharts.com/charting-library/api/ContextMenuItem)
- [CreateHTMLButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateHTMLButtonOptions)
- [CreateChartUiStyledButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateChartUiStyledButtonOptions)
- [CreateButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateButtonOptions)
- [DropdownParams](https://docs.lumencharts.com/charting-library/api/DropdownParams)
- [IDropdownApi](https://docs.lumencharts.com/charting-library/api/IDropdownApi)
- [DialogParams](https://docs.lumencharts.com/charting-library/api/DialogParams)
- [SymbolIntervalResult](https://docs.lumencharts.com/charting-library/api/SymbolIntervalResult)
- [INumberFormatter](https://docs.lumencharts.com/charting-library/api/INumberFormatter)
- [StudyInputInformation](https://docs.lumencharts.com/charting-library/api/StudyInputInformation)
- [StudyStyleInfo](https://docs.lumencharts.com/charting-library/api/StudyStyleInfo)
- [ChartPropertiesOverrides](https://docs.lumencharts.com/charting-library/api/ChartPropertiesOverrides)
- [IWatchListApi](https://docs.lumencharts.com/charting-library/api/IWatchListApi)
- [INewsApi](https://docs.lumencharts.com/charting-library/api/INewsApi)
- [IWidgetbarApi](https://docs.lumencharts.com/charting-library/api/IWidgetbarApi)
- [PineEditorWorkspaceApi](https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceApi)
- [PineChartRuntimeApi](https://docs.lumencharts.com/charting-library/api/PineChartRuntimeApi)
- [LayoutType](https://docs.lumencharts.com/charting-library/api/LayoutType)
- [ThemeName](https://docs.lumencharts.com/charting-library/api/ThemeName)
- [ChangeThemeOptions](https://docs.lumencharts.com/charting-library/api/ChangeThemeOptions)
- [ClientSnapshotOptions](https://docs.lumencharts.com/charting-library/api/ClientSnapshotOptions)
- [IWatchedValue](https://docs.lumencharts.com/charting-library/api/IWatchedValue)
- [UndoRedoState](https://docs.lumencharts.com/charting-library/api/UndoRedoState)
- [VisibilityType](https://docs.lumencharts.com/charting-library/api/VisibilityType)
- [DateFormat](https://docs.lumencharts.com/charting-library/api/DateFormat)
- [TimeHoursFormat](https://docs.lumencharts.com/charting-library/api/TimeHoursFormat)
- [IWatchedValueReadonly](https://docs.lumencharts.com/charting-library/api/IWatchedValueReadonly)
- [ChartStyle](https://docs.lumencharts.com/charting-library/api/ChartStyle)
- [IWatermarkApi](https://docs.lumencharts.com/charting-library/api/IWatermarkApi)
- [ICustomSymbolStatusApi](https://docs.lumencharts.com/charting-library/api/ICustomSymbolStatusApi)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ILumenChartingLibraryWidget


---

<!-- Public documentation export; not library implementation source. -->
# IMenuItem

[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.

## type {#type}

```ts
readonly type: MenuItemType;
```

Use the type signature above and the integration guide for the owning capability.

## id {#id}

```ts
readonly id: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [MenuItemType](https://docs.lumencharts.com/charting-library/api/MenuItemType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IMenuItem


---

<!-- Public documentation export; not library implementation source. -->
# API reference

Public integration contracts for this runtime. Runtime-backed facade members are identified separately from legacy declaration-only entries. The [compatibility policy](https://docs.lumencharts.com/charting-library/reference/compatibility) remains part of every API contract.

## Main interfaces

- [LumenChartingLibraryWidgetOptions](https://docs.lumencharts.com/charting-library/api/LumenChartingLibraryWidgetOptions)
- [ILumenChartingLibraryWidget](https://docs.lumencharts.com/charting-library/api/ILumenChartingLibraryWidget)
- [IChartWidgetApi](https://docs.lumencharts.com/charting-library/api/IChartWidgetApi)
- [IBasicDataFeed](https://docs.lumencharts.com/charting-library/api/IBasicDataFeed)
- [IExternalDatafeed](https://docs.lumencharts.com/charting-library/api/IExternalDatafeed)
- [IDatafeedChartApi](https://docs.lumencharts.com/charting-library/api/IDatafeedChartApi)
- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)
- [Bar](https://docs.lumencharts.com/charting-library/api/Bar)
- [PeriodParams](https://docs.lumencharts.com/charting-library/api/PeriodParams)
- [DatafeedConfiguration](https://docs.lumencharts.com/charting-library/api/DatafeedConfiguration)
- [IExternalSaveLoadAdapter](https://docs.lumencharts.com/charting-library/api/IExternalSaveLoadAdapter)
- [ILineDataSourceApi](https://docs.lumencharts.com/charting-library/api/ILineDataSourceApi)
- [IStudyApi](https://docs.lumencharts.com/charting-library/api/IStudyApi)
- [ISelectionApi](https://docs.lumencharts.com/charting-library/api/ISelectionApi)
- [IShapesGroupControllerApi](https://docs.lumencharts.com/charting-library/api/IShapesGroupControllerApi)
- [IOrderLineAdapter](https://docs.lumencharts.com/charting-library/api/IOrderLineAdapter)
- [IPositionLineAdapter](https://docs.lumencharts.com/charting-library/api/IPositionLineAdapter)
- [IExecutionLineAdapter](https://docs.lumencharts.com/charting-library/api/IExecutionLineAdapter)
- [IPaneApi](https://docs.lumencharts.com/charting-library/api/IPaneApi)
- [IPriceScaleApi](https://docs.lumencharts.com/charting-library/api/IPriceScaleApi)
- [ITimeScaleApi](https://docs.lumencharts.com/charting-library/api/ITimeScaleApi)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)
- [ChartData](https://docs.lumencharts.com/charting-library/api/ChartData)
- [ChartMetaInfo](https://docs.lumencharts.com/charting-library/api/ChartMetaInfo)
- [ChartStyle](https://docs.lumencharts.com/charting-library/api/ChartStyle)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [CreateShapeOptions](https://docs.lumencharts.com/charting-library/api/CreateShapeOptions)
- [CreateMultipointShapeOptions](https://docs.lumencharts.com/charting-library/api/CreateMultipointShapeOptions)

## Style overrides

- [Drawing tool overrides](https://docs.lumencharts.com/charting-library/api/drawing-overrides): one section per drawing tool
- [Indicator overrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides): one section per indicator

## Supporting types

- [AccessList](https://docs.lumencharts.com/charting-library/api/AccessList)
- [AccessListItem](https://docs.lumencharts.com/charting-library/api/AccessListItem)
- [ActionId](https://docs.lumencharts.com/charting-library/api/ActionId)
- [ActionOptions](https://docs.lumencharts.com/charting-library/api/ActionOptions)
- [ActionState](https://docs.lumencharts.com/charting-library/api/ActionState)
- [ActionsFactory](https://docs.lumencharts.com/charting-library/api/ActionsFactory)
- [AdditionalSymbolInfoField](https://docs.lumencharts.com/charting-library/api/AdditionalSymbolInfoField)
- [AreaStylePreferences](https://docs.lumencharts.com/charting-library/api/AreaStylePreferences)
- [AvailableSaveloadVersions](https://docs.lumencharts.com/charting-library/api/AvailableSaveloadVersions)
- [AvailableZOrderOperations](https://docs.lumencharts.com/charting-library/api/AvailableZOrderOperations)
- [BarDetailizationMode](https://docs.lumencharts.com/charting-library/api/BarDetailizationMode)
- [BarStylePreferences](https://docs.lumencharts.com/charting-library/api/BarStylePreferences)
- [BaselineStylePreferences](https://docs.lumencharts.com/charting-library/api/BaselineStylePreferences)
- [CandleStylePreferences](https://docs.lumencharts.com/charting-library/api/CandleStylePreferences)
- [ChangeThemeOptions](https://docs.lumencharts.com/charting-library/api/ChangeThemeOptions)
- [ChartActionId](https://docs.lumencharts.com/charting-library/api/ChartActionId)
- [ChartAutomationFamily](https://docs.lumencharts.com/charting-library/api/ChartAutomationFamily)
- [ChartAutomationOwners](https://docs.lumencharts.com/charting-library/api/ChartAutomationOwners)
- [ChartDataStatus](https://docs.lumencharts.com/charting-library/api/ChartDataStatus)
- [ChartDatafeedConnectionStatus](https://docs.lumencharts.com/charting-library/api/ChartDatafeedConnectionStatus)
- [ChartDatafeedState](https://docs.lumencharts.com/charting-library/api/ChartDatafeedState)
- [ChartDescriptionContext](https://docs.lumencharts.com/charting-library/api/ChartDescriptionContext)
- [ChartDescriptorFunction](https://docs.lumencharts.com/charting-library/api/ChartDescriptorFunction)
- [ChartPropertiesOverrides](https://docs.lumencharts.com/charting-library/api/ChartPropertiesOverrides)
- [ChartTemplate](https://docs.lumencharts.com/charting-library/api/ChartTemplate)
- [ChartTemplateContent](https://docs.lumencharts.com/charting-library/api/ChartTemplateContent)
- [ChartTypeFavorites](https://docs.lumencharts.com/charting-library/api/ChartTypeFavorites)
- [ClearMarksMode](https://docs.lumencharts.com/charting-library/api/ClearMarksMode)
- [ClientSnapshotOptions](https://docs.lumencharts.com/charting-library/api/ClientSnapshotOptions)
- [ColorTypes](https://docs.lumencharts.com/charting-library/api/ColorTypes)
- [ColumnStylePreferences](https://docs.lumencharts.com/charting-library/api/ColumnStylePreferences)
- [CompareSymbol](https://docs.lumencharts.com/charting-library/api/CompareSymbol)
- [ContextMenuItem](https://docs.lumencharts.com/charting-library/api/ContextMenuItem)
- [ContextMenuItemsProcessor](https://docs.lumencharts.com/charting-library/api/ContextMenuItemsProcessor)
- [ContextMenuOptions](https://docs.lumencharts.com/charting-library/api/ContextMenuOptions)
- [ContextMenuPosition](https://docs.lumencharts.com/charting-library/api/ContextMenuPosition)
- [ContextMenuRendererFactory](https://docs.lumencharts.com/charting-library/api/ContextMenuRendererFactory)
- [CreateAnchoredShapeOptions](https://docs.lumencharts.com/charting-library/api/CreateAnchoredShapeOptions)
- [CreateButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateButtonOptions)
- [CreateChartUiStyledButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateChartUiStyledButtonOptions)
- [CreateContextMenuParams](https://docs.lumencharts.com/charting-library/api/CreateContextMenuParams)
- [CreateHTMLButtonOptions](https://docs.lumencharts.com/charting-library/api/CreateHTMLButtonOptions)
- [CreateShapeOptionsBase](https://docs.lumencharts.com/charting-library/api/CreateShapeOptionsBase)
- [CreateStudyOptions](https://docs.lumencharts.com/charting-library/api/CreateStudyOptions)
- [CreateStudyTemplateOptions](https://docs.lumencharts.com/charting-library/api/CreateStudyTemplateOptions)
- [CrossHairMovedEventParams](https://docs.lumencharts.com/charting-library/api/CrossHairMovedEventParams)
- [CrossHairMovedEventSource](https://docs.lumencharts.com/charting-library/api/CrossHairMovedEventSource)
- [CrossHairMovedEventSourceValue](https://docs.lumencharts.com/charting-library/api/CrossHairMovedEventSourceValue)
- [CurrencyInfo](https://docs.lumencharts.com/charting-library/api/CurrencyInfo)
- [CurrencyItem](https://docs.lumencharts.com/charting-library/api/CurrencyItem)
- [CustomAliasedTimezone](https://docs.lumencharts.com/charting-library/api/CustomAliasedTimezone)
- [CustomFormatter](https://docs.lumencharts.com/charting-library/api/CustomFormatter)
- [CustomFormatters](https://docs.lumencharts.com/charting-library/api/CustomFormatters)
- [CustomIndicator](https://docs.lumencharts.com/charting-library/api/CustomIndicator)
- [CustomStatusDropDownAction](https://docs.lumencharts.com/charting-library/api/CustomStatusDropDownAction)
- [CustomStatusDropDownContent](https://docs.lumencharts.com/charting-library/api/CustomStatusDropDownContent)
- [CustomStudyFormatter](https://docs.lumencharts.com/charting-library/api/CustomStudyFormatter)
- [CustomStudyFormatterFactory](https://docs.lumencharts.com/charting-library/api/CustomStudyFormatterFactory)
- [CustomStudyFormatterFormat](https://docs.lumencharts.com/charting-library/api/CustomStudyFormatterFormat)
- [CustomTimezoneId](https://docs.lumencharts.com/charting-library/api/CustomTimezoneId)
- [CustomTimezoneInfo](https://docs.lumencharts.com/charting-library/api/CustomTimezoneInfo)
- [CustomTimezones](https://docs.lumencharts.com/charting-library/api/CustomTimezones)
- [CustomTranslateFunction](https://docs.lumencharts.com/charting-library/api/CustomTranslateFunction)
- [CustomTranslateOptions](https://docs.lumencharts.com/charting-library/api/CustomTranslateOptions)
- [DOMCallback](https://docs.lumencharts.com/charting-library/api/DOMCallback)
- [DOMData](https://docs.lumencharts.com/charting-library/api/DOMData)
- [DOMLevel](https://docs.lumencharts.com/charting-library/api/DOMLevel)
- [DatafeedQuoteValues](https://docs.lumencharts.com/charting-library/api/DatafeedQuoteValues)
- [DatafeedSymbolType](https://docs.lumencharts.com/charting-library/api/DatafeedSymbolType)
- [DateFormat](https://docs.lumencharts.com/charting-library/api/DateFormat)
- [DeepPartial](https://docs.lumencharts.com/charting-library/api/DeepPartial)
- [DeepWriteable](https://docs.lumencharts.com/charting-library/api/DeepWriteable)
- [DialogParams](https://docs.lumencharts.com/charting-library/api/DialogParams)
- [Direction](https://docs.lumencharts.com/charting-library/api/Direction)
- [DrawingEventType](https://docs.lumencharts.com/charting-library/api/DrawingEventType)
- [DrawingOverrides](https://docs.lumencharts.com/charting-library/api/DrawingOverrides)
- [DrawingToolIdentifier](https://docs.lumencharts.com/charting-library/api/DrawingToolIdentifier)
- [DropdownItem](https://docs.lumencharts.com/charting-library/api/DropdownItem)
- [DropdownParams](https://docs.lumencharts.com/charting-library/api/DropdownParams)
- [DropdownUpdateParams](https://docs.lumencharts.com/charting-library/api/DropdownUpdateParams)
- [EditObjectDialogEventParams](https://docs.lumencharts.com/charting-library/api/EditObjectDialogEventParams)
- [EditObjectDialogObjectType](https://docs.lumencharts.com/charting-library/api/EditObjectDialogObjectType)
- [EmojiOptions](https://docs.lumencharts.com/charting-library/api/EmojiOptions)
- [EmptyCallback](https://docs.lumencharts.com/charting-library/api/EmptyCallback)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [EntityInfo](https://docs.lumencharts.com/charting-library/api/EntityInfo)
- [ErrorCallback](https://docs.lumencharts.com/charting-library/api/ErrorCallback)
- [ErrorFormatterParseResult](https://docs.lumencharts.com/charting-library/api/ErrorFormatterParseResult)
- [Exchange](https://docs.lumencharts.com/charting-library/api/Exchange)
- [ExportDataOptions](https://docs.lumencharts.com/charting-library/api/ExportDataOptions)
- [ExportedData](https://docs.lumencharts.com/charting-library/api/ExportedData)
- [Favorites](https://docs.lumencharts.com/charting-library/api/Favorites)
- [FieldDescriptor](https://docs.lumencharts.com/charting-library/api/FieldDescriptor)
- [FilledAreaType](https://docs.lumencharts.com/charting-library/api/FilledAreaType)
- [FinancialPeriod](https://docs.lumencharts.com/charting-library/api/FinancialPeriod)
- [FormatterParseResult](https://docs.lumencharts.com/charting-library/api/FormatterParseResult)
- [GetMarksCallback](https://docs.lumencharts.com/charting-library/api/GetMarksCallback)
- [GmtTimezoneId](https://docs.lumencharts.com/charting-library/api/GmtTimezoneId)
- [GrayedObject](https://docs.lumencharts.com/charting-library/api/GrayedObject)
- [GroupLockState](https://docs.lumencharts.com/charting-library/api/GroupLockState)
- [GroupVisibilityState](https://docs.lumencharts.com/charting-library/api/GroupVisibilityState)
- [HHistDirection](https://docs.lumencharts.com/charting-library/api/HHistDirection)
- [HHistPreferences](https://docs.lumencharts.com/charting-library/api/HHistPreferences)
- [HLCAreaStylePreferences](https://docs.lumencharts.com/charting-library/api/HLCAreaStylePreferences)
- [HeaderWidgetButtonsMode](https://docs.lumencharts.com/charting-library/api/HeaderWidgetButtonsMode)
- [HeikinAshiStylePreferences](https://docs.lumencharts.com/charting-library/api/HeikinAshiStylePreferences)
- [HiLoStylePreferences](https://docs.lumencharts.com/charting-library/api/HiLoStylePreferences)
- [HistoryCallback](https://docs.lumencharts.com/charting-library/api/HistoryCallback)
- [HistoryMetadata](https://docs.lumencharts.com/charting-library/api/HistoryMetadata)
- [HollowCandleStylePreferences](https://docs.lumencharts.com/charting-library/api/HollowCandleStylePreferences)
- [HorizLinePreferences](https://docs.lumencharts.com/charting-library/api/HorizLinePreferences)
- [IAction](https://docs.lumencharts.com/charting-library/api/IAction)
- [IActionVariant](https://docs.lumencharts.com/charting-library/api/IActionVariant)
- [IBarArray](https://docs.lumencharts.com/charting-library/api/IBarArray)
- [IBoxedValue](https://docs.lumencharts.com/charting-library/api/IBoxedValue)
- [IBoxedValueReadOnly](https://docs.lumencharts.com/charting-library/api/IBoxedValueReadOnly)
- [IContext](https://docs.lumencharts.com/charting-library/api/IContext)
- [IContextMenuRenderer](https://docs.lumencharts.com/charting-library/api/IContextMenuRenderer)
- [ICustomSymbolStatusAdapter](https://docs.lumencharts.com/charting-library/api/ICustomSymbolStatusAdapter)
- [ICustomSymbolStatusApi](https://docs.lumencharts.com/charting-library/api/ICustomSymbolStatusApi)
- [IDatafeedQuotesApi](https://docs.lumencharts.com/charting-library/api/IDatafeedQuotesApi)
- [IDestroyable](https://docs.lumencharts.com/charting-library/api/IDestroyable)
- [IDropdownApi](https://docs.lumencharts.com/charting-library/api/IDropdownApi)
- [IFormatter](https://docs.lumencharts.com/charting-library/api/IFormatter)
- [IMenuItem](https://docs.lumencharts.com/charting-library/api/IMenuItem)
- [INewsApi](https://docs.lumencharts.com/charting-library/api/INewsApi)
- [INonSeriesStudyBarsResult](https://docs.lumencharts.com/charting-library/api/INonSeriesStudyBarsResult)
- [INonSeriesStudyResult](https://docs.lumencharts.com/charting-library/api/INonSeriesStudyResult)
- [INumberFormatter](https://docs.lumencharts.com/charting-library/api/INumberFormatter)
- [IObservable](https://docs.lumencharts.com/charting-library/api/IObservable)
- [IObservableValue](https://docs.lumencharts.com/charting-library/api/IObservableValue)
- [IObservableValueReadOnly](https://docs.lumencharts.com/charting-library/api/IObservableValueReadOnly)
- [IPineSeries](https://docs.lumencharts.com/charting-library/api/IPineSeries)
- [IPineStudyResult](https://docs.lumencharts.com/charting-library/api/IPineStudyResult)
- [IPineStudyResultSimple](https://docs.lumencharts.com/charting-library/api/IPineStudyResultSimple)
- [IPineStudyResultTypes](https://docs.lumencharts.com/charting-library/api/IPineStudyResultTypes)
- [IProjectionBar](https://docs.lumencharts.com/charting-library/api/IProjectionBar)
- [IProjectionStudyResult](https://docs.lumencharts.com/charting-library/api/IProjectionStudyResult)
- [ISeparator](https://docs.lumencharts.com/charting-library/api/ISeparator)
- [ISeriesApi](https://docs.lumencharts.com/charting-library/api/ISeriesApi)
- [ISeriesStudyResult](https://docs.lumencharts.com/charting-library/api/ISeriesStudyResult)
- [ISettingsAdapter](https://docs.lumencharts.com/charting-library/api/ISettingsAdapter)
- [ISymbolInstrument](https://docs.lumencharts.com/charting-library/api/ISymbolInstrument)
- [ISymbolValueFormatter](https://docs.lumencharts.com/charting-library/api/ISymbolValueFormatter)
- [ITimezoneApi](https://docs.lumencharts.com/charting-library/api/ITimezoneApi)
- [IUpdatableAction](https://docs.lumencharts.com/charting-library/api/IUpdatableAction)
- [IWatchListApi](https://docs.lumencharts.com/charting-library/api/IWatchListApi)
- [IWatchedValue](https://docs.lumencharts.com/charting-library/api/IWatchedValue)
- [IWatchedValueReadonly](https://docs.lumencharts.com/charting-library/api/IWatchedValueReadonly)
- [IWatermarkApi](https://docs.lumencharts.com/charting-library/api/IWatermarkApi)
- [IWidgetbarApi](https://docs.lumencharts.com/charting-library/api/IWidgetbarApi)
- [IconOptions](https://docs.lumencharts.com/charting-library/api/IconOptions)
- [InitialSettingsMap](https://docs.lumencharts.com/charting-library/api/InitialSettingsMap)
- [IntrabarCoverage](https://docs.lumencharts.com/charting-library/api/IntrabarCoverage)
- [IntrabarCoverageStatus](https://docs.lumencharts.com/charting-library/api/IntrabarCoverageStatus)
- [KagiStylePreferences](https://docs.lumencharts.com/charting-library/api/KagiStylePreferences)
- [LanguageCode](https://docs.lumencharts.com/charting-library/api/LanguageCode)
- [LayoutType](https://docs.lumencharts.com/charting-library/api/LayoutType)
- [LegendMode](https://docs.lumencharts.com/charting-library/api/LegendMode)
- [LibraryPineStudy](https://docs.lumencharts.com/charting-library/api/LibraryPineStudy)
- [LibraryPineStudyConstructor](https://docs.lumencharts.com/charting-library/api/LibraryPineStudyConstructor)
- [LibrarySessionId](https://docs.lumencharts.com/charting-library/api/LibrarySessionId)
- [LibrarySubsessionInfo](https://docs.lumencharts.com/charting-library/api/LibrarySubsessionInfo)
- [LineBreakStylePreferences](https://docs.lumencharts.com/charting-library/api/LineBreakStylePreferences)
- [LineStudyPlotStyle](https://docs.lumencharts.com/charting-library/api/LineStudyPlotStyle)
- [LineStudyPlotStyleName](https://docs.lumencharts.com/charting-library/api/LineStudyPlotStyleName)
- [LineStyle](https://docs.lumencharts.com/charting-library/api/LineStyle)
- [LineStylePreferences](https://docs.lumencharts.com/charting-library/api/LineStylePreferences)
- [LineToolState](https://docs.lumencharts.com/charting-library/api/LineToolState)
- [LineToolsAndGroupsLoadRequestContext](https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsLoadRequestContext)
- [LineToolsAndGroupsLoadRequestType](https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsLoadRequestType)
- [LineToolsAndGroupsState](https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsState)
- [LineToolsGroupState](https://docs.lumencharts.com/charting-library/api/LineToolsGroupState)
- [LoadingScreenOptions](https://docs.lumencharts.com/charting-library/api/LoadingScreenOptions)
- [LumenChartingLibraryFeatureset](https://docs.lumencharts.com/charting-library/api/LumenChartingLibraryFeatureset)
- [MappedObject](https://docs.lumencharts.com/charting-library/api/MappedObject)
- [Mark](https://docs.lumencharts.com/charting-library/api/Mark)
- [MarkConstColors](https://docs.lumencharts.com/charting-library/api/MarkConstColors)
- [MarkCustomColor](https://docs.lumencharts.com/charting-library/api/MarkCustomColor)
- [MarkLocation](https://docs.lumencharts.com/charting-library/api/MarkLocation)
- [MarketStatus](https://docs.lumencharts.com/charting-library/api/MarketStatus)
- [MenuItemType](https://docs.lumencharts.com/charting-library/api/MenuItemType)
- [MouseEventParams](https://docs.lumencharts.com/charting-library/api/MouseEventParams)
- [MultipleChartsLayoutType](https://docs.lumencharts.com/charting-library/api/MultipleChartsLayoutType)
- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)
- [NumericFormattingParams](https://docs.lumencharts.com/charting-library/api/NumericFormattingParams)
- [OmitActionId](https://docs.lumencharts.com/charting-library/api/OmitActionId)
- [OnActionExecuteHandler](https://docs.lumencharts.com/charting-library/api/OnActionExecuteHandler)
- [OnActionUpdateHandler](https://docs.lumencharts.com/charting-library/api/OnActionUpdateHandler)
- [OnReadyCallback](https://docs.lumencharts.com/charting-library/api/OnReadyCallback)
- [OpenChartAutomationOptions](https://docs.lumencharts.com/charting-library/api/OpenChartAutomationOptions)
- [OrderLineLengthUnit](https://docs.lumencharts.com/charting-library/api/OrderLineLengthUnit)
- [OverrideLineStyle](https://docs.lumencharts.com/charting-library/api/OverrideLineStyle)
- [OverridePriceAxisLastValueMode](https://docs.lumencharts.com/charting-library/api/OverridePriceAxisLastValueMode)
- [Overrides](https://docs.lumencharts.com/charting-library/api/Overrides)
- [PageName](https://docs.lumencharts.com/charting-library/api/PageName)
- [PineAlertConditionMeta](https://docs.lumencharts.com/charting-library/api/PineAlertConditionMeta)
- [PineAlertDeliveryProvider](https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryProvider)
- [PineAlertDeliveryReceipt](https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryReceipt)
- [PineAlertDeliveryStatus](https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryStatus)
- [PineAlertEvent](https://docs.lumencharts.com/charting-library/api/PineAlertEvent)
- [PineAlertFrequency](https://docs.lumencharts.com/charting-library/api/PineAlertFrequency)
- [PineAlertRule](https://docs.lumencharts.com/charting-library/api/PineAlertRule)
- [PineAlertRuleInput](https://docs.lumencharts.com/charting-library/api/PineAlertRuleInput)
- [PineChartQualifiedSource](https://docs.lumencharts.com/charting-library/api/PineChartQualifiedSource)
- [PineChartRuntimeApi](https://docs.lumencharts.com/charting-library/api/PineChartRuntimeApi)
- [PineDocumentKind](https://docs.lumencharts.com/charting-library/api/PineDocumentKind)
- [PineEditorActionOptions](https://docs.lumencharts.com/charting-library/api/PineEditorActionOptions)
- [PineEditorLayoutRequest](https://docs.lumencharts.com/charting-library/api/PineEditorLayoutRequest)
- [PineEditorUiOptions](https://docs.lumencharts.com/charting-library/api/PineEditorUiOptions)
- [PineEditorUiPreset](https://docs.lumencharts.com/charting-library/api/PineEditorUiPreset)
- [PineEditorWorkspaceApi](https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceApi)
- [PineEditorWorkspaceChange](https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceChange)
- [PineEditorWorkspaceSnapshot](https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceSnapshot)
- [PineJS](https://docs.lumencharts.com/charting-library/api/PineJS)
- [PineJSStd](https://docs.lumencharts.com/charting-library/api/PineJSStd)
- [PineLibraryDependencyAnalysis](https://docs.lumencharts.com/charting-library/api/PineLibraryDependencyAnalysis)
- [PineLibraryLockEntry](https://docs.lumencharts.com/charting-library/api/PineLibraryLockEntry)
- [PineLibraryProvider](https://docs.lumencharts.com/charting-library/api/PineLibraryProvider)
- [PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)
- [PineLogCursor](https://docs.lumencharts.com/charting-library/api/PineLogCursor)
- [PineLogEvent](https://docs.lumencharts.com/charting-library/api/PineLogEvent)
- [PineLogPage](https://docs.lumencharts.com/charting-library/api/PineLogPage)
- [PineObjectOverrideChange](https://docs.lumencharts.com/charting-library/api/PineObjectOverrideChange)
- [PineObjectOverridePatch](https://docs.lumencharts.com/charting-library/api/PineObjectOverridePatch)
- [PineObjectOverridePath](https://docs.lumencharts.com/charting-library/api/PineObjectOverridePath)
- [PineObjectOverrideSnapshot](https://docs.lumencharts.com/charting-library/api/PineObjectOverrideSnapshot)
- [PinePublication](https://docs.lumencharts.com/charting-library/api/PinePublication)
- [PinePublicationIdentity](https://docs.lumencharts.com/charting-library/api/PinePublicationIdentity)
- [PinePublicationProvider](https://docs.lumencharts.com/charting-library/api/PinePublicationProvider)
- [PineResolvedLibrary](https://docs.lumencharts.com/charting-library/api/PineResolvedLibrary)
- [PineScriptCapability](https://docs.lumencharts.com/charting-library/api/PineScriptCapability)
- [PineScriptCompileResult](https://docs.lumencharts.com/charting-library/api/PineScriptCompileResult)
- [PineScriptDiagnostic](https://docs.lumencharts.com/charting-library/api/PineScriptDiagnostic)
- [PineScriptRunOptions](https://docs.lumencharts.com/charting-library/api/PineScriptRunOptions)
- [PineScriptStudyOptions](https://docs.lumencharts.com/charting-library/api/PineScriptStudyOptions)
- [PineScriptStudyState](https://docs.lumencharts.com/charting-library/api/PineScriptStudyState)
- [PineScriptWidgetOptions](https://docs.lumencharts.com/charting-library/api/PineScriptWidgetOptions)
- [PineStrategyConfig](https://docs.lumencharts.com/charting-library/api/PineStrategyConfig)
- [PineStrategyOrder](https://docs.lumencharts.com/charting-library/api/PineStrategyOrder)
- [PineStrategyReport](https://docs.lumencharts.com/charting-library/api/PineStrategyReport)
- [PineStrategyReportChange](https://docs.lumencharts.com/charting-library/api/PineStrategyReportChange)
- [PineStrategyRunIdentity](https://docs.lumencharts.com/charting-library/api/PineStrategyRunIdentity)
- [PineStrategyRunSettings](https://docs.lumencharts.com/charting-library/api/PineStrategyRunSettings)
- [PineStrategySettingsApplyRequest](https://docs.lumencharts.com/charting-library/api/PineStrategySettingsApplyRequest)
- [PineStrategySettingsHost](https://docs.lumencharts.com/charting-library/api/PineStrategySettingsHost)
- [PineStrategySummary](https://docs.lumencharts.com/charting-library/api/PineStrategySummary)
- [PineStrategyTimelinePoint](https://docs.lumencharts.com/charting-library/api/PineStrategyTimelinePoint)
- [PineStrategyTrade](https://docs.lumencharts.com/charting-library/api/PineStrategyTrade)
- [PineStudyMigrationReport](https://docs.lumencharts.com/charting-library/api/PineStudyMigrationReport)
- [PineStudyObjectBase](https://docs.lumencharts.com/charting-library/api/PineStudyObjectBase)
- [PineStudyObjectChange](https://docs.lumencharts.com/charting-library/api/PineStudyObjectChange)
- [PineStudyObjectSnapshot](https://docs.lumencharts.com/charting-library/api/PineStudyObjectSnapshot)
- [PineStudyResultComposite](https://docs.lumencharts.com/charting-library/api/PineStudyResultComposite)
- [PineWorkspaceCreateRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceCreateRequest)
- [PineWorkspaceDocument](https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocument)
- [PineWorkspaceDocumentSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocumentSummary)
- [PineWorkspaceListRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceListRequest)
- [PineWorkspacePage](https://docs.lumencharts.com/charting-library/api/PineWorkspacePage)
- [PineWorkspacePermissions](https://docs.lumencharts.com/charting-library/api/PineWorkspacePermissions)
- [PineWorkspaceProvider](https://docs.lumencharts.com/charting-library/api/PineWorkspaceProvider)
- [PineWorkspaceRevision](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevision)
- [PineWorkspaceRevisionListRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionListRequest)
- [PineWorkspaceRevisionPage](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionPage)
- [PineWorkspaceRevisionSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionSummary)
- [PineWorkspaceUpdateRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceUpdateRequest)
- [PlDisplay](https://docs.lumencharts.com/charting-library/api/PlDisplay)
- [PlotShapeId](https://docs.lumencharts.com/charting-library/api/PlotShapeId)
- [PlotSymbolSize](https://docs.lumencharts.com/charting-library/api/PlotSymbolSize)
- [PlusClickParams](https://docs.lumencharts.com/charting-library/api/PlusClickParams)
- [PnFStylePreferences](https://docs.lumencharts.com/charting-library/api/PnFStylePreferences)
- [PolygonPreferences](https://docs.lumencharts.com/charting-library/api/PolygonPreferences)
- [PositionLineLengthUnit](https://docs.lumencharts.com/charting-library/api/PositionLineLengthUnit)
- [PositionPercents](https://docs.lumencharts.com/charting-library/api/PositionPercents)
- [PriceScaleMode](https://docs.lumencharts.com/charting-library/api/PriceScaleMode)
- [PriceScaleSelectedCurrency](https://docs.lumencharts.com/charting-library/api/PriceScaleSelectedCurrency)
- [PriceSource](https://docs.lumencharts.com/charting-library/api/PriceSource)
- [PricedPoint](https://docs.lumencharts.com/charting-library/api/PricedPoint)
- [QuoteData](https://docs.lumencharts.com/charting-library/api/QuoteData)
- [QuoteDataResponse](https://docs.lumencharts.com/charting-library/api/QuoteDataResponse)
- [QuoteErrorData](https://docs.lumencharts.com/charting-library/api/QuoteErrorData)
- [QuoteOkData](https://docs.lumencharts.com/charting-library/api/QuoteOkData)
- [QuotesCallback](https://docs.lumencharts.com/charting-library/api/QuotesCallback)
- [QuotesErrorCallback](https://docs.lumencharts.com/charting-library/api/QuotesErrorCallback)
- [RangeOptions](https://docs.lumencharts.com/charting-library/api/RangeOptions)
- [RawStudyMetaInfo](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfo)
- [RawStudyMetaInfoBase](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfoBase)
- [RawStudyMetaInfoId](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfoId)
- [RawStudyMetaInformation](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInformation)
- [RenkoStylePreferences](https://docs.lumencharts.com/charting-library/api/RenkoStylePreferences)
- [ResolveCallback](https://docs.lumencharts.com/charting-library/api/ResolveCallback)
- [SaveChartOptions](https://docs.lumencharts.com/charting-library/api/SaveChartOptions)
- [SaveChartToServerOptions](https://docs.lumencharts.com/charting-library/api/SaveChartToServerOptions)
- [SaveLoadChartRecord](https://docs.lumencharts.com/charting-library/api/SaveLoadChartRecord)
- [SavedStateMetaInfo](https://docs.lumencharts.com/charting-library/api/SavedStateMetaInfo)
- [SearchSymbolResultItem](https://docs.lumencharts.com/charting-library/api/SearchSymbolResultItem)
- [SearchSymbolsCallback](https://docs.lumencharts.com/charting-library/api/SearchSymbolsCallback)
- [SelectBarRequestOptions](https://docs.lumencharts.com/charting-library/api/SelectBarRequestOptions)
- [SeriesEventType](https://docs.lumencharts.com/charting-library/api/SeriesEventType)
- [SeriesFieldDescriptor](https://docs.lumencharts.com/charting-library/api/SeriesFieldDescriptor)
- [SeriesFormat](https://docs.lumencharts.com/charting-library/api/SeriesFormat)
- [SeriesFormatterFactory](https://docs.lumencharts.com/charting-library/api/SeriesFormatterFactory)
- [SeriesPreferencesMap](https://docs.lumencharts.com/charting-library/api/SeriesPreferencesMap)
- [SeriesPriceScale](https://docs.lumencharts.com/charting-library/api/SeriesPriceScale)
- [SeriesStatusViewSymbolTextSource](https://docs.lumencharts.com/charting-library/api/SeriesStatusViewSymbolTextSource)
- [SeriesType](https://docs.lumencharts.com/charting-library/api/SeriesType)
- [ServerTimeCallback](https://docs.lumencharts.com/charting-library/api/ServerTimeCallback)
- [SetResolutionOptions](https://docs.lumencharts.com/charting-library/api/SetResolutionOptions)
- [SetSymbolOptions](https://docs.lumencharts.com/charting-library/api/SetSymbolOptions)
- [SetVisibleRangeOptions](https://docs.lumencharts.com/charting-library/api/SetVisibleRangeOptions)
- [SetVisibleTimeRange](https://docs.lumencharts.com/charting-library/api/SetVisibleTimeRange)
- [ShapePoint](https://docs.lumencharts.com/charting-library/api/ShapePoint)
- [ShapesGroupId](https://docs.lumencharts.com/charting-library/api/ShapesGroupId)
- [SingleChartLayoutType](https://docs.lumencharts.com/charting-library/api/SingleChartLayoutType)
- [StickedPoint](https://docs.lumencharts.com/charting-library/api/StickedPoint)
- [StudyArrowsPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyArrowsPlotInfo)
- [StudyArrowsPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyArrowsPlotPreferences)
- [StudyAvailableConstSources](https://docs.lumencharts.com/charting-library/api/StudyAvailableConstSources)
- [StudyBandBackgroundPreferences](https://docs.lumencharts.com/charting-library/api/StudyBandBackgroundPreferences)
- [StudyBandInfo](https://docs.lumencharts.com/charting-library/api/StudyBandInfo)
- [StudyBandPreferences](https://docs.lumencharts.com/charting-library/api/StudyBandPreferences)
- [StudyBandStyle](https://docs.lumencharts.com/charting-library/api/StudyBandStyle)
- [StudyBarColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyBarColorerPlotInfo)
- [StudyBarTimeInputInfo](https://docs.lumencharts.com/charting-library/api/StudyBarTimeInputInfo)
- [StudyBgColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyBgColorerPlotInfo)
- [StudyBooleanInputInfo](https://docs.lumencharts.com/charting-library/api/StudyBooleanInputInfo)
- [StudyCandleBorderColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyCandleBorderColorerPlotInfo)
- [StudyCandleWickColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyCandleWickColorerPlotInfo)
- [StudyCharsPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyCharsPlotInfo)
- [StudyCharsPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyCharsPlotPreferences)
- [StudyColorInputInfo](https://docs.lumencharts.com/charting-library/api/StudyColorInputInfo)
- [StudyColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyColorerPlotInfo)
- [StudyDataOffsetPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyDataOffsetPlotInfo)
- [StudyDataPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyDataPlotInfo)
- [StudyDefaults](https://docs.lumencharts.com/charting-library/api/StudyDefaults)
- [StudyDownColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyDownColorerPlotInfo)
- [StudyEventType](https://docs.lumencharts.com/charting-library/api/StudyEventType)
- [StudyFieldDescriptor](https://docs.lumencharts.com/charting-library/api/StudyFieldDescriptor)
- [StudyFilledAreaGradientColorStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaGradientColorStyle)
- [StudyFilledAreaInfo](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaInfo)
- [StudyFilledAreaSolidColorStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaSolidColorStyle)
- [StudyFilledAreaStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyle)
- [StudyFilledAreaStyleBase](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyleBase)
- [StudyGraphicsDefaults](https://docs.lumencharts.com/charting-library/api/StudyGraphicsDefaults)
- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)
- [StudyInputId](https://docs.lumencharts.com/charting-library/api/StudyInputId)
- [StudyInputInfo](https://docs.lumencharts.com/charting-library/api/StudyInputInfo)
- [StudyInputInfoList](https://docs.lumencharts.com/charting-library/api/StudyInputInfoList)
- [StudyInputInformation](https://docs.lumencharts.com/charting-library/api/StudyInputInformation)
- [StudyInputOptionsTitles](https://docs.lumencharts.com/charting-library/api/StudyInputOptionsTitles)
- [StudyInputType](https://docs.lumencharts.com/charting-library/api/StudyInputType)
- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)
- [StudyInputValueItem](https://docs.lumencharts.com/charting-library/api/StudyInputValueItem)
- [StudyInputsSimple](https://docs.lumencharts.com/charting-library/api/StudyInputsSimple)
- [StudyLinePlotInfo](https://docs.lumencharts.com/charting-library/api/StudyLinePlotInfo)
- [StudyLinePlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyLinePlotPreferences)
- [StudyMetaInfo](https://docs.lumencharts.com/charting-library/api/StudyMetaInfo)
- [StudyNumericInputInfo](https://docs.lumencharts.com/charting-library/api/StudyNumericInputInfo)
- [StudyOhlcColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyOhlcColorerPlotInfo)
- [StudyOhlcPlotBarsStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBarsStylePreferences)
- [StudyOhlcPlotBaseStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBaseStylePreferences)
- [StudyOhlcPlotCandlesStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotCandlesStylePreferences)
- [StudyOhlcPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotInfo)
- [StudyOhlcPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotPreferences)
- [StudyOhlcStylesInfo](https://docs.lumencharts.com/charting-library/api/StudyOhlcStylesInfo)
- [StudyOrDrawingAddedToChartEventParams](https://docs.lumencharts.com/charting-library/api/StudyOrDrawingAddedToChartEventParams)
- [StudyOverrideValueType](https://docs.lumencharts.com/charting-library/api/StudyOverrideValueType)
- [StudyOverrides](https://docs.lumencharts.com/charting-library/api/StudyOverrides)
- [StudyPaletteColor](https://docs.lumencharts.com/charting-library/api/StudyPaletteColor)
- [StudyPaletteColorPreferences](https://docs.lumencharts.com/charting-library/api/StudyPaletteColorPreferences)
- [StudyPaletteInfo](https://docs.lumencharts.com/charting-library/api/StudyPaletteInfo)
- [StudyPalettePreferences](https://docs.lumencharts.com/charting-library/api/StudyPalettePreferences)
- [StudyPaletteStyle](https://docs.lumencharts.com/charting-library/api/StudyPaletteStyle)
- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyPalettesInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettesInfo)
- [StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)
- [StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)
- [StudyPlotDisplayMode](https://docs.lumencharts.com/charting-library/api/StudyPlotDisplayMode)
- [StudyPlotDisplayTarget](https://docs.lumencharts.com/charting-library/api/StudyPlotDisplayTarget)
- [StudyPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotInfo)
- [StudyPlotInformation](https://docs.lumencharts.com/charting-library/api/StudyPlotInformation)
- [StudyPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotPreferences)
- [StudyPlotValueFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValueFormat)
- [StudyPlotValueInheritFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValueInheritFormat)
- [StudyPlotValuePrecisionFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValuePrecisionFormat)
- [StudyPriceInputInfo](https://docs.lumencharts.com/charting-library/api/StudyPriceInputInfo)
- [StudyPriceScale](https://docs.lumencharts.com/charting-library/api/StudyPriceScale)
- [StudyPrimitiveResult](https://docs.lumencharts.com/charting-library/api/StudyPrimitiveResult)
- [StudyResolutionInputInfo](https://docs.lumencharts.com/charting-library/api/StudyResolutionInputInfo)
- [StudyResultValueWithOffset](https://docs.lumencharts.com/charting-library/api/StudyResultValueWithOffset)
- [StudyRgbaColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyRgbaColorerPlotInfo)
- [StudySessionInputInfo](https://docs.lumencharts.com/charting-library/api/StudySessionInputInfo)
- [StudyShapesPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyShapesPlotInfo)
- [StudyShapesPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyShapesPlotPreferences)
- [StudySourceInputInfo](https://docs.lumencharts.com/charting-library/api/StudySourceInputInfo)
- [StudyStyleInfo](https://docs.lumencharts.com/charting-library/api/StudyStyleInfo)
- [StudyStyleInfoDefaults](https://docs.lumencharts.com/charting-library/api/StudyStyleInfoDefaults)
- [StudyStyleValues](https://docs.lumencharts.com/charting-library/api/StudyStyleValues)
- [StudyStylesInfo](https://docs.lumencharts.com/charting-library/api/StudyStylesInfo)
- [StudySymbolInputInfo](https://docs.lumencharts.com/charting-library/api/StudySymbolInputInfo)
- [StudyTargetPriceScale](https://docs.lumencharts.com/charting-library/api/StudyTargetPriceScale)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)
- [StudyTemplateData](https://docs.lumencharts.com/charting-library/api/StudyTemplateData)
- [StudyTemplateMetaInfo](https://docs.lumencharts.com/charting-library/api/StudyTemplateMetaInfo)
- [StudyTextColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTextColorerPlotInfo)
- [StudyTextInputInfo](https://docs.lumencharts.com/charting-library/api/StudyTextInputInfo)
- [StudyTextareaInputInfo](https://docs.lumencharts.com/charting-library/api/StudyTextareaInputInfo)
- [StudyTimeInputInfo](https://docs.lumencharts.com/charting-library/api/StudyTimeInputInfo)
- [StudyUpColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyUpColorerPlotInfo)
- [StyledText](https://docs.lumencharts.com/charting-library/api/StyledText)
- [SubscribeBarsCallback](https://docs.lumencharts.com/charting-library/api/SubscribeBarsCallback)
- [SubscribeEventsMap](https://docs.lumencharts.com/charting-library/api/SubscribeEventsMap)
- [SuccessFormatterParseResult](https://docs.lumencharts.com/charting-library/api/SuccessFormatterParseResult)
- [SupportedLineTools](https://docs.lumencharts.com/charting-library/api/SupportedLineTools)
- [SymbolExt](https://docs.lumencharts.com/charting-library/api/SymbolExt)
- [SymbolInfoPriceSource](https://docs.lumencharts.com/charting-library/api/SymbolInfoPriceSource)
- [SymbolInputSymbolSource](https://docs.lumencharts.com/charting-library/api/SymbolInputSymbolSource)
- [SymbolIntervalResult](https://docs.lumencharts.com/charting-library/api/SymbolIntervalResult)
- [SymbolResolveExtension](https://docs.lumencharts.com/charting-library/api/SymbolResolveExtension)
- [SymbolSearchCompleteData](https://docs.lumencharts.com/charting-library/api/SymbolSearchCompleteData)
- [SymbolSearchCompleteOverrideFunction](https://docs.lumencharts.com/charting-library/api/SymbolSearchCompleteOverrideFunction)
- [SymbolSource](https://docs.lumencharts.com/charting-library/api/SymbolSource)
- [ThemeName](https://docs.lumencharts.com/charting-library/api/ThemeName)
- [TickMarkType](https://docs.lumencharts.com/charting-library/api/TickMarkType)
- [TimeFieldDescriptor](https://docs.lumencharts.com/charting-library/api/TimeFieldDescriptor)
- [TimeFrameItem](https://docs.lumencharts.com/charting-library/api/TimeFrameItem)
- [TimeFramePeriodBack](https://docs.lumencharts.com/charting-library/api/TimeFramePeriodBack)
- [TimeFrameTimeRange](https://docs.lumencharts.com/charting-library/api/TimeFrameTimeRange)
- [TimeFrameValue](https://docs.lumencharts.com/charting-library/api/TimeFrameValue)
- [TimeHoursFormat](https://docs.lumencharts.com/charting-library/api/TimeHoursFormat)
- [TimePoint](https://docs.lumencharts.com/charting-library/api/TimePoint)
- [TimeScaleMarkShape](https://docs.lumencharts.com/charting-library/api/TimeScaleMarkShape)
- [TimeScaleOptions](https://docs.lumencharts.com/charting-library/api/TimeScaleOptions)
- [TimeframeOption](https://docs.lumencharts.com/charting-library/api/TimeframeOption)
- [TimescaleMark](https://docs.lumencharts.com/charting-library/api/TimescaleMark)
- [Timezone](https://docs.lumencharts.com/charting-library/api/Timezone)
- [TimezoneId](https://docs.lumencharts.com/charting-library/api/TimezoneId)
- [TimezoneInfo](https://docs.lumencharts.com/charting-library/api/TimezoneInfo)
- [UndoOptions](https://docs.lumencharts.com/charting-library/api/UndoOptions)
- [UndoRedoState](https://docs.lumencharts.com/charting-library/api/UndoRedoState)
- [Unit](https://docs.lumencharts.com/charting-library/api/Unit)
- [UnitInfo](https://docs.lumencharts.com/charting-library/api/UnitInfo)
- [UserTimeFieldDescriptor](https://docs.lumencharts.com/charting-library/api/UserTimeFieldDescriptor)
- [ValueByStyleId](https://docs.lumencharts.com/charting-library/api/ValueByStyleId)
- [VertLinePreferences](https://docs.lumencharts.com/charting-library/api/VertLinePreferences)
- [VisibilityType](https://docs.lumencharts.com/charting-library/api/VisibilityType)
- [VisiblePlotsSet](https://docs.lumencharts.com/charting-library/api/VisiblePlotsSet)
- [VisiblePriceRange](https://docs.lumencharts.com/charting-library/api/VisiblePriceRange)
- [VisibleTimeRange](https://docs.lumencharts.com/charting-library/api/VisibleTimeRange)
- [WatchListSymbolList](https://docs.lumencharts.com/charting-library/api/WatchListSymbolList)
- [WatchListSymbolListAddedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListAddedCallback)
- [WatchListSymbolListChangedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListChangedCallback)
- [WatchListSymbolListData](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListData)
- [WatchListSymbolListMap](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListMap)
- [WatchListSymbolListRemovedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRemovedCallback)
- [WatchListSymbolListRenamedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRenamedCallback)
- [WatchedValueCallback](https://docs.lumencharts.com/charting-library/api/WatchedValueCallback)
- [WatchedValueSubscribeOptions](https://docs.lumencharts.com/charting-library/api/WatchedValueSubscribeOptions)
- [WatermarkContentData](https://docs.lumencharts.com/charting-library/api/WatermarkContentData)
- [WatermarkContentProvider](https://docs.lumencharts.com/charting-library/api/WatermarkContentProvider)
- [WatermarkLine](https://docs.lumencharts.com/charting-library/api/WatermarkLine)
- [WidgetOverrides](https://docs.lumencharts.com/charting-library/api/WidgetOverrides)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/


---

<!-- Public documentation export; not library implementation source. -->
# Indicator overrides

[Integration guide](https://docs.lumencharts.com/charting-library/studies/catalog) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Style properties for each built-in indicator, with their types and default values. Pass them as the `overrides` argument of [createStudy](https://docs.lumencharts.com/charting-library/api/IChartWidgetApi#createstudy) or to [applyOverrides](https://docs.lumencharts.com/charting-library/api/IStudyApi#applyoverrides), without the indicator name. Find an indicator by name in the [indicator catalog](https://docs.lumencharts.com/charting-library/studies/catalog). Legacy product-specific keys are not a promise of implementation.

## AcceleratorOscillatorIndicatorOverrides {#acceleratoroscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AccumulationDistributionIndicatorOverrides {#accumulationdistributionindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AccumulativeSwingIndexIndicatorOverrides {#accumulativeswingindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `asi.display` | `number` |  |
| `asi.linestyle` | `number` |  |
| `asi.linewidth` | `number` |  |
| `asi.plottype` | `LineStudyPlotStyleName` |  |
| `asi.trackprice` | `boolean` |  |
| `asi.transparency` | `number` |  |
| `asi.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AdvanceDeclineIndicatorOverrides {#advancedeclineindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AnchoredVWAPIndicatorOverrides {#anchoredvwapindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `vwap.display` | `number` |  |
| `vwap.color` | `string` |  |
| `vwap.linestyle` | `number` |  |
| `vwap.linewidth` | `number` |  |
| `vwap.plottype` | `LineStudyPlotStyleName` |  |
| `vwap.trackprice` | `boolean` |  |
| `vwap.transparency` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## ArnaudLegouxMovingAverageIndicatorOverrides {#arnaudlegouxmovingaverageindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AroonIndicatorOverrides {#aroonindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `upper.display` | `number` |  |
| `upper.linestyle` | `number` |  |
| `upper.linewidth` | `number` |  |
| `upper.plottype` | `LineStudyPlotStyleName` |  |
| `upper.trackprice` | `boolean` |  |
| `upper.transparency` | `number` |  |
| `upper.color` | `string` |  |
| `lower.display` | `number` |  |
| `lower.linestyle` | `number` |  |
| `lower.linewidth` | `number` |  |
| `lower.plottype` | `LineStudyPlotStyleName` |  |
| `lower.trackprice` | `boolean` |  |
| `lower.transparency` | `number` |  |
| `lower.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AverageDirectionalIndexIndicatorOverrides {#averagedirectionalindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `adx.display` | `number` |  |
| `adx.linestyle` | `number` |  |
| `adx.linewidth` | `number` |  |
| `adx.plottype` | `LineStudyPlotStyleName` |  |
| `adx.trackprice` | `boolean` |  |
| `adx.transparency` | `number` |  |
| `adx.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AveragePriceIndicatorOverrides {#averagepriceindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AverageTrueRangeIndicatorOverrides {#averagetruerangeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## AwesomeOscillatorIndicatorOverrides {#awesomeoscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## BalanceofPowerIndicatorOverrides {#balanceofpowerindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## BollingerBandsBIndicatorOverrides {#bollingerbandsbindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## BollingerBandsIndicatorOverrides {#bollingerbandsindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plots background.color` | `string` |  |
| `plots background.transparency` | `number` |  |
| `plots background.visible` | `boolean` |  |
| `median.display` | `number` |  |
| `median.linestyle` | `number` |  |
| `median.linewidth` | `number` |  |
| `median.plottype` | `LineStudyPlotStyleName` |  |
| `median.trackprice` | `boolean` |  |
| `median.transparency` | `number` |  |
| `median.color` | `string` |  |
| `upper.display` | `number` |  |
| `upper.linestyle` | `number` |  |
| `upper.linewidth` | `number` |  |
| `upper.plottype` | `LineStudyPlotStyleName` |  |
| `upper.trackprice` | `boolean` |  |
| `upper.transparency` | `number` |  |
| `upper.color` | `string` |  |
| `lower.display` | `number` |  |
| `lower.linestyle` | `number` |  |
| `lower.linewidth` | `number` |  |
| `lower.plottype` | `LineStudyPlotStyleName` |  |
| `lower.trackprice` | `boolean` |  |
| `lower.transparency` | `number` |  |
| `lower.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## BollingerBandsWidthIndicatorOverrides {#bollingerbandswidthindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ChaikinMoneyFlowIndicatorOverrides {#chaikinmoneyflowindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ChaikinOscillatorIndicatorOverrides {#chaikinoscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ChaikinVolatilityIndicatorOverrides {#chaikinvolatilityindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ChandeKrollStopIndicatorOverrides {#chandekrollstopindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `long.display` | `number` |  |
| `long.linestyle` | `number` |  |
| `long.linewidth` | `number` |  |
| `long.plottype` | `LineStudyPlotStyleName` |  |
| `long.trackprice` | `boolean` |  |
| `long.transparency` | `number` |  |
| `long.color` | `string` |  |
| `short.display` | `number` |  |
| `short.linestyle` | `number` |  |
| `short.linewidth` | `number` |  |
| `short.plottype` | `LineStudyPlotStyleName` |  |
| `short.trackprice` | `boolean` |  |
| `short.transparency` | `number` |  |
| `short.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ChandeMomentumOscillatorIndicatorOverrides {#chandemomentumoscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ChopZoneIndicatorOverrides {#chopzoneindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ChoppinessIndexIndicatorOverrides {#choppinessindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## CommodityChannelIndexIndicatorOverrides {#commoditychannelindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `smoothed ma.display` | `number` |  |
| `smoothed ma.linestyle` | `number` |  |
| `smoothed ma.linewidth` | `number` |  |
| `smoothed ma.plottype` | `LineStudyPlotStyleName` |  |
| `smoothed ma.trackprice` | `boolean` |  |
| `smoothed ma.transparency` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## CompareIndicatorOverrides {#compareindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ConnorsRSIIndicatorOverrides {#connorsrsiindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `crsi.display` | `number` |  |
| `crsi.linestyle` | `number` |  |
| `crsi.linewidth` | `number` |  |
| `crsi.plottype` | `LineStudyPlotStyleName` |  |
| `crsi.trackprice` | `boolean` |  |
| `crsi.transparency` | `number` |  |
| `crsi.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## CoppockCurveIndicatorOverrides {#coppockcurveindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## CorrelationCoefficientIndicatorOverrides {#correlationcoefficientindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## CorrelationLogIndicatorOverrides {#correlationlogindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## DetrendedPriceOscillatorIndicatorOverrides {#detrendedpriceoscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `dpo.display` | `number` |  |
| `dpo.linestyle` | `number` |  |
| `dpo.linewidth` | `number` |  |
| `dpo.plottype` | `LineStudyPlotStyleName` |  |
| `dpo.trackprice` | `boolean` |  |
| `dpo.transparency` | `number` |  |
| `dpo.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## DirectionalMovementIndicatorOverrides {#directionalmovementindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `+di.display` | `number` |  |
| `+di.linestyle` | `number` |  |
| `+di.linewidth` | `number` |  |
| `+di.plottype` | `LineStudyPlotStyleName` |  |
| `+di.trackprice` | `boolean` |  |
| `+di.transparency` | `number` |  |
| `+di.color` | `string` |  |
| `-di.display` | `number` |  |
| `-di.linestyle` | `number` |  |
| `-di.linewidth` | `number` |  |
| `-di.plottype` | `LineStudyPlotStyleName` |  |
| `-di.trackprice` | `boolean` |  |
| `-di.transparency` | `number` |  |
| `-di.color` | `string` |  |
| `adx.display` | `number` |  |
| `adx.linestyle` | `number` |  |
| `adx.linewidth` | `number` |  |
| `adx.plottype` | `LineStudyPlotStyleName` |  |
| `adx.trackprice` | `boolean` |  |
| `adx.transparency` | `number` |  |
| `adx.color` | `string` |  |
| `dx.display` | `number` |  |
| `dx.linestyle` | `number` |  |
| `dx.linewidth` | `number` |  |
| `dx.plottype` | `LineStudyPlotStyleName` |  |
| `dx.trackprice` | `boolean` |  |
| `dx.transparency` | `number` |  |
| `dx.color` | `string` |  |
| `adxr.display` | `number` |  |
| `adxr.linestyle` | `number` |  |
| `adxr.linewidth` | `number` |  |
| `adxr.plottype` | `LineStudyPlotStyleName` |  |
| `adxr.trackprice` | `boolean` |  |
| `adxr.transparency` | `number` |  |
| `adxr.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## DonchianChannelsIndicatorOverrides {#donchianchannelsindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plots background.color` | `string` |  |
| `plots background.transparency` | `number` |  |
| `plots background.visible` | `boolean` |  |
| `lower.display` | `number` |  |
| `lower.linestyle` | `number` |  |
| `lower.linewidth` | `number` |  |
| `lower.plottype` | `LineStudyPlotStyleName` |  |
| `lower.trackprice` | `boolean` |  |
| `lower.transparency` | `number` |  |
| `lower.color` | `string` |  |
| `upper.display` | `number` |  |
| `upper.linestyle` | `number` |  |
| `upper.linewidth` | `number` |  |
| `upper.plottype` | `LineStudyPlotStyleName` |  |
| `upper.trackprice` | `boolean` |  |
| `upper.transparency` | `number` |  |
| `upper.color` | `string` |  |
| `basis.display` | `number` |  |
| `basis.linestyle` | `number` |  |
| `basis.linewidth` | `number` |  |
| `basis.plottype` | `LineStudyPlotStyleName` |  |
| `basis.trackprice` | `boolean` |  |
| `basis.transparency` | `number` |  |
| `basis.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## DoubleEMAIndicatorOverrides {#doubleemaindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## EMACrossIndicatorOverrides {#emacrossindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `short:plot.display` | `number` |  |
| `short:plot.linestyle` | `number` |  |
| `short:plot.linewidth` | `number` |  |
| `short:plot.plottype` | `LineStudyPlotStyleName` |  |
| `short:plot.trackprice` | `boolean` |  |
| `short:plot.transparency` | `number` |  |
| `short:plot.color` | `string` |  |
| `long:plot.display` | `number` |  |
| `long:plot.linestyle` | `number` |  |
| `long:plot.linewidth` | `number` |  |
| `long:plot.plottype` | `LineStudyPlotStyleName` |  |
| `long:plot.trackprice` | `boolean` |  |
| `long:plot.transparency` | `number` |  |
| `long:plot.color` | `string` |  |
| `crosses.display` | `number` |  |
| `crosses.linestyle` | `number` |  |
| `crosses.linewidth` | `number` |  |
| `crosses.plottype` | `LineStudyPlotStyleName` |  |
| `crosses.trackprice` | `boolean` |  |
| `crosses.transparency` | `number` |  |
| `crosses.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## EaseOfMovementIndicatorOverrides {#easeofmovementindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## EldersForceIndexIndicatorOverrides {#eldersforceindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## EnvelopesIndicatorOverrides {#envelopesindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plots background.color` | `string` |  |
| `plots background.transparency` | `number` |  |
| `plots background.visible` | `boolean` |  |
| `average.display` | `number` |  |
| `average.linestyle` | `number` |  |
| `average.linewidth` | `number` |  |
| `average.plottype` | `LineStudyPlotStyleName` |  |
| `average.trackprice` | `boolean` |  |
| `average.transparency` | `number` |  |
| `average.color` | `string` |  |
| `upper.display` | `number` |  |
| `upper.linestyle` | `number` |  |
| `upper.linewidth` | `number` |  |
| `upper.plottype` | `LineStudyPlotStyleName` |  |
| `upper.trackprice` | `boolean` |  |
| `upper.transparency` | `number` |  |
| `upper.color` | `string` |  |
| `lower.display` | `number` |  |
| `lower.linestyle` | `number` |  |
| `lower.linewidth` | `number` |  |
| `lower.plottype` | `LineStudyPlotStyleName` |  |
| `lower.trackprice` | `boolean` |  |
| `lower.transparency` | `number` |  |
| `lower.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## FiftyTwoWeekHighLowIndicatorOverrides {#fiftytwoweekhighlowindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `` | `StudyOverrideValueType` |  |

## FisherTransformIndicatorOverrides {#fishertransformindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `level:band.color` | `string` |  |
| `level:band.linestyle` | `number` |  |
| `level:band.linewidth` | `number` |  |
| `level:band.visible` | `boolean` |  |
| `level:band.value` | `number` |  |
| `fisher.display` | `number` |  |
| `fisher.linestyle` | `number` |  |
| `fisher.linewidth` | `number` |  |
| `fisher.plottype` | `LineStudyPlotStyleName` |  |
| `fisher.trackprice` | `boolean` |  |
| `fisher.transparency` | `number` |  |
| `fisher.color` | `string` |  |
| `trigger.display` | `number` |  |
| `trigger.linestyle` | `number` |  |
| `trigger.linewidth` | `number` |  |
| `trigger.plottype` | `LineStudyPlotStyleName` |  |
| `trigger.trackprice` | `boolean` |  |
| `trigger.transparency` | `number` |  |
| `trigger.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## FixedRangeIndicatorOverrides {#fixedrangeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `developing poc.color` | `string` |  |
| `developing poc.linestyle` | `number` |  |
| `developing poc.linewidth` | `number` |  |
| `developing poc.plottype` | `LineStudyPlotStyleName` |  |
| `developing poc.trackprice` | `boolean` |  |
| `developing poc.transparency` | `number` |  |
| `developing poc.display` | `number` |  |
| `developing va high.color` | `string` |  |
| `developing va high.linestyle` | `number` |  |
| `developing va high.linewidth` | `number` |  |
| `developing va high.plottype` | `LineStudyPlotStyleName` |  |
| `developing va high.trackprice` | `boolean` |  |
| `developing va high.transparency` | `number` |  |
| `developing va high.display` | `number` |  |
| `developing va low.color` | `string` |  |
| `developing va low.linestyle` | `number` |  |
| `developing va low.linewidth` | `number` |  |
| `developing va low.plottype` | `LineStudyPlotStyleName` |  |
| `developing va low.trackprice` | `boolean` |  |
| `developing va low.transparency` | `number` |  |
| `developing va low.display` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## GuppyMultipleMovingAverageIndicatorOverrides {#guppymultiplemovingaverageindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `trader ema 1.display` | `number` |  |
| `trader ema 1.color` | `string` |  |
| `trader ema 1.linestyle` | `number` |  |
| `trader ema 1.linewidth` | `number` |  |
| `trader ema 1.plottype` | `LineStudyPlotStyleName` |  |
| `trader ema 1.trackprice` | `boolean` |  |
| `trader ema 1.transparency` | `number` |  |
| `trader ema 2.display` | `number` |  |
| `trader ema 2.color` | `string` |  |
| `trader ema 2.linestyle` | `number` |  |
| `trader ema 2.linewidth` | `number` |  |
| `trader ema 2.plottype` | `LineStudyPlotStyleName` |  |
| `trader ema 2.trackprice` | `boolean` |  |
| `trader ema 2.transparency` | `number` |  |
| `trader ema 3.display` | `number` |  |
| `trader ema 3.color` | `string` |  |
| `trader ema 3.linestyle` | `number` |  |
| `trader ema 3.linewidth` | `number` |  |
| `trader ema 3.plottype` | `LineStudyPlotStyleName` |  |
| `trader ema 3.trackprice` | `boolean` |  |
| `trader ema 3.transparency` | `number` |  |
| `trader ema 4.display` | `number` |  |
| `trader ema 4.color` | `string` |  |
| `trader ema 4.linestyle` | `number` |  |
| `trader ema 4.linewidth` | `number` |  |
| `trader ema 4.plottype` | `LineStudyPlotStyleName` |  |
| `trader ema 4.trackprice` | `boolean` |  |
| `trader ema 4.transparency` | `number` |  |
| `trader ema 5.display` | `number` |  |
| `trader ema 5.color` | `string` |  |
| `trader ema 5.linestyle` | `number` |  |
| `trader ema 5.linewidth` | `number` |  |
| `trader ema 5.plottype` | `LineStudyPlotStyleName` |  |
| `trader ema 5.trackprice` | `boolean` |  |
| `trader ema 5.transparency` | `number` |  |
| `trader ema 6.display` | `number` |  |
| `trader ema 6.color` | `string` |  |
| `trader ema 6.linestyle` | `number` |  |
| `trader ema 6.linewidth` | `number` |  |
| `trader ema 6.plottype` | `LineStudyPlotStyleName` |  |
| `trader ema 6.trackprice` | `boolean` |  |
| `trader ema 6.transparency` | `number` |  |
| `investor ema 1.display` | `number` |  |
| `investor ema 1.color` | `string` |  |
| `investor ema 1.linestyle` | `number` |  |
| `investor ema 1.linewidth` | `number` |  |
| `investor ema 1.plottype` | `LineStudyPlotStyleName` |  |
| `investor ema 1.trackprice` | `boolean` |  |
| `investor ema 1.transparency` | `number` |  |
| `investor ema 2.display` | `number` |  |
| `investor ema 2.color` | `string` |  |
| `investor ema 2.linestyle` | `number` |  |
| `investor ema 2.linewidth` | `number` |  |
| `investor ema 2.plottype` | `LineStudyPlotStyleName` |  |
| `investor ema 2.trackprice` | `boolean` |  |
| `investor ema 2.transparency` | `number` |  |
| `investor ema 3.display` | `number` |  |
| `investor ema 3.color` | `string` |  |
| `investor ema 3.linestyle` | `number` |  |
| `investor ema 3.linewidth` | `number` |  |
| `investor ema 3.plottype` | `LineStudyPlotStyleName` |  |
| `investor ema 3.trackprice` | `boolean` |  |
| `investor ema 3.transparency` | `number` |  |
| `investor ema 4.display` | `number` |  |
| `investor ema 4.color` | `string` |  |
| `investor ema 4.linestyle` | `number` |  |
| `investor ema 4.linewidth` | `number` |  |
| `investor ema 4.plottype` | `LineStudyPlotStyleName` |  |
| `investor ema 4.trackprice` | `boolean` |  |
| `investor ema 4.transparency` | `number` |  |
| `investor ema 5.display` | `number` |  |
| `investor ema 5.color` | `string` |  |
| `investor ema 5.linestyle` | `number` |  |
| `investor ema 5.linewidth` | `number` |  |
| `investor ema 5.plottype` | `LineStudyPlotStyleName` |  |
| `investor ema 5.trackprice` | `boolean` |  |
| `investor ema 5.transparency` | `number` |  |
| `investor ema 6.display` | `number` |  |
| `investor ema 6.color` | `string` |  |
| `investor ema 6.linestyle` | `number` |  |
| `investor ema 6.linewidth` | `number` |  |
| `investor ema 6.plottype` | `LineStudyPlotStyleName` |  |
| `investor ema 6.trackprice` | `boolean` |  |
| `investor ema 6.transparency` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## HistoricalVolatilityIndicatorOverrides {#historicalvolatilityindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## HullMovingAverageIndicatorOverrides {#hullmovingaverageindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## IchimokuCloudIndicatorOverrides {#ichimokucloudindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plots background.color` | `string` |  |
| `plots background.transparency` | `number` |  |
| `plots background.visible` | `boolean` |  |
| `conversion line.display` | `number` |  |
| `conversion line.linestyle` | `number` |  |
| `conversion line.linewidth` | `number` |  |
| `conversion line.plottype` | `LineStudyPlotStyleName` |  |
| `conversion line.trackprice` | `boolean` |  |
| `conversion line.transparency` | `number` |  |
| `conversion line.color` | `string` |  |
| `base line.display` | `number` |  |
| `base line.linestyle` | `number` |  |
| `base line.linewidth` | `number` |  |
| `base line.plottype` | `LineStudyPlotStyleName` |  |
| `base line.trackprice` | `boolean` |  |
| `base line.transparency` | `number` |  |
| `base line.color` | `string` |  |
| `lagging span.display` | `number` |  |
| `lagging span.linestyle` | `number` |  |
| `lagging span.linewidth` | `number` |  |
| `lagging span.plottype` | `LineStudyPlotStyleName` |  |
| `lagging span.trackprice` | `boolean` |  |
| `lagging span.transparency` | `number` |  |
| `lagging span.color` | `string` |  |
| `leading span a.display` | `number` |  |
| `leading span a.linestyle` | `number` |  |
| `leading span a.linewidth` | `number` |  |
| `leading span a.plottype` | `LineStudyPlotStyleName` |  |
| `leading span a.trackprice` | `boolean` |  |
| `leading span a.transparency` | `number` |  |
| `leading span a.color` | `string` |  |
| `leading span b.display` | `number` |  |
| `leading span b.linestyle` | `number` |  |
| `leading span b.linewidth` | `number` |  |
| `leading span b.plottype` | `LineStudyPlotStyleName` |  |
| `leading span b.trackprice` | `boolean` |  |
| `leading span b.transparency` | `number` |  |
| `leading span b.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## KeltnerChannelsIndicatorOverrides {#keltnerchannelsindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plots background.color` | `string` |  |
| `plots background.transparency` | `number` |  |
| `plots background.visible` | `boolean` |  |
| `upper.display` | `number` |  |
| `upper.linestyle` | `number` |  |
| `upper.linewidth` | `number` |  |
| `upper.plottype` | `LineStudyPlotStyleName` |  |
| `upper.trackprice` | `boolean` |  |
| `upper.transparency` | `number` |  |
| `upper.color` | `string` |  |
| `middle.display` | `number` |  |
| `middle.linestyle` | `number` |  |
| `middle.linewidth` | `number` |  |
| `middle.plottype` | `LineStudyPlotStyleName` |  |
| `middle.trackprice` | `boolean` |  |
| `middle.transparency` | `number` |  |
| `middle.color` | `string` |  |
| `lower.display` | `number` |  |
| `lower.linestyle` | `number` |  |
| `lower.linewidth` | `number` |  |
| `lower.plottype` | `LineStudyPlotStyleName` |  |
| `lower.trackprice` | `boolean` |  |
| `lower.transparency` | `number` |  |
| `lower.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## KlingerOscillatorIndicatorOverrides {#klingeroscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `signal.display` | `number` |  |
| `signal.linestyle` | `number` |  |
| `signal.linewidth` | `number` |  |
| `signal.plottype` | `LineStudyPlotStyleName` |  |
| `signal.trackprice` | `boolean` |  |
| `signal.transparency` | `number` |  |
| `signal.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## KnowSureThingIndicatorOverrides {#knowsurethingindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `kst.display` | `number` |  |
| `kst.linestyle` | `number` |  |
| `kst.linewidth` | `number` |  |
| `kst.plottype` | `LineStudyPlotStyleName` |  |
| `kst.trackprice` | `boolean` |  |
| `kst.transparency` | `number` |  |
| `kst.color` | `string` |  |
| `signal.display` | `number` |  |
| `signal.linestyle` | `number` |  |
| `signal.linewidth` | `number` |  |
| `signal.plottype` | `LineStudyPlotStyleName` |  |
| `signal.trackprice` | `boolean` |  |
| `signal.transparency` | `number` |  |
| `signal.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## LeastSquaresMovingAverageIndicatorOverrides {#leastsquaresmovingaverageindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## LinearRegressionCurveIndicatorOverrides {#linearregressioncurveindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## LinearRegressionSlopeIndicatorOverrides {#linearregressionslopeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MACDIndicatorOverrides {#macdindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `histogram.display` | `number` |  |
| `histogram.linestyle` | `number` |  |
| `histogram.linewidth` | `number` |  |
| `histogram.plottype` | `LineStudyPlotStyleName` |  |
| `histogram.trackprice` | `boolean` |  |
| `histogram.transparency` | `number` |  |
| `histogram.color` | `string` |  |
| `macd.display` | `number` |  |
| `macd.linestyle` | `number` |  |
| `macd.linewidth` | `number` |  |
| `macd.plottype` | `LineStudyPlotStyleName` |  |
| `macd.trackprice` | `boolean` |  |
| `macd.transparency` | `number` |  |
| `macd.color` | `string` |  |
| `signal.display` | `number` |  |
| `signal.linestyle` | `number` |  |
| `signal.linewidth` | `number` |  |
| `signal.plottype` | `LineStudyPlotStyleName` |  |
| `signal.trackprice` | `boolean` |  |
| `signal.transparency` | `number` |  |
| `signal.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MACrossIndicatorOverrides {#macrossindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `short:plot.display` | `number` |  |
| `short:plot.linestyle` | `number` |  |
| `short:plot.linewidth` | `number` |  |
| `short:plot.plottype` | `LineStudyPlotStyleName` |  |
| `short:plot.trackprice` | `boolean` |  |
| `short:plot.transparency` | `number` |  |
| `short:plot.color` | `string` |  |
| `long:plot.display` | `number` |  |
| `long:plot.linestyle` | `number` |  |
| `long:plot.linewidth` | `number` |  |
| `long:plot.plottype` | `LineStudyPlotStyleName` |  |
| `long:plot.trackprice` | `boolean` |  |
| `long:plot.transparency` | `number` |  |
| `long:plot.color` | `string` |  |
| `crosses.display` | `number` |  |
| `crosses.linestyle` | `number` |  |
| `crosses.linewidth` | `number` |  |
| `crosses.plottype` | `LineStudyPlotStyleName` |  |
| `crosses.trackprice` | `boolean` |  |
| `crosses.transparency` | `number` |  |
| `crosses.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MAwithEMACrossIndicatorOverrides {#mawithemacrossindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `ma.display` | `number` |  |
| `ma.linestyle` | `number` |  |
| `ma.linewidth` | `number` |  |
| `ma.plottype` | `LineStudyPlotStyleName` |  |
| `ma.trackprice` | `boolean` |  |
| `ma.transparency` | `number` |  |
| `ma.color` | `string` |  |
| `ema.display` | `number` |  |
| `ema.linestyle` | `number` |  |
| `ema.linewidth` | `number` |  |
| `ema.plottype` | `LineStudyPlotStyleName` |  |
| `ema.trackprice` | `boolean` |  |
| `ema.transparency` | `number` |  |
| `ema.color` | `string` |  |
| `crosses.display` | `number` |  |
| `crosses.linestyle` | `number` |  |
| `crosses.linewidth` | `number` |  |
| `crosses.plottype` | `LineStudyPlotStyleName` |  |
| `crosses.trackprice` | `boolean` |  |
| `crosses.transparency` | `number` |  |
| `crosses.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MajorityRuleIndicatorOverrides {#majorityruleindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `majority rule.display` | `number` |  |
| `majority rule.linestyle` | `number` |  |
| `majority rule.linewidth` | `number` |  |
| `majority rule.plottype` | `LineStudyPlotStyleName` |  |
| `majority rule.trackprice` | `boolean` |  |
| `majority rule.transparency` | `number` |  |
| `majority rule.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MassIndexIndicatorOverrides {#massindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## McGinleyDynamicIndicatorOverrides {#mcginleydynamicindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MedianPriceIndicatorOverrides {#medianpriceindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MomentumIndicatorOverrides {#momentumindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `mom.display` | `number` |  |
| `mom.linestyle` | `number` |  |
| `mom.linewidth` | `number` |  |
| `mom.plottype` | `LineStudyPlotStyleName` |  |
| `mom.trackprice` | `boolean` |  |
| `mom.transparency` | `number` |  |
| `mom.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MoneyFlowIndexIndicatorOverrides {#moneyflowindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageAdaptiveIndicatorOverrides {#movingaverageadaptiveindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot 1.display` | `number` |  |
| `plot 1.linestyle` | `number` |  |
| `plot 1.linewidth` | `number` |  |
| `plot 1.plottype` | `LineStudyPlotStyleName` |  |
| `plot 1.transparency` | `number` |  |
| `plot 1.trackprice` | `boolean` |  |
| `plot 1.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageChannelIndicatorOverrides {#movingaveragechannelindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plots background.color` | `string` |  |
| `plots background.transparency` | `number` |  |
| `plots background.visible` | `boolean` |  |
| `upper.display` | `number` |  |
| `upper.linestyle` | `number` |  |
| `upper.linewidth` | `number` |  |
| `upper.plottype` | `LineStudyPlotStyleName` |  |
| `upper.trackprice` | `boolean` |  |
| `upper.transparency` | `number` |  |
| `upper.color` | `string` |  |
| `lower.display` | `number` |  |
| `lower.linestyle` | `number` |  |
| `lower.linewidth` | `number` |  |
| `lower.plottype` | `LineStudyPlotStyleName` |  |
| `lower.trackprice` | `boolean` |  |
| `lower.transparency` | `number` |  |
| `lower.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageDoubleIndicatorOverrides {#movingaveragedoubleindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot 1.display` | `number` |  |
| `plot 1.linestyle` | `number` |  |
| `plot 1.linewidth` | `number` |  |
| `plot 1.plottype` | `LineStudyPlotStyleName` |  |
| `plot 1.trackprice` | `boolean` |  |
| `plot 1.transparency` | `number` |  |
| `plot 1.color` | `string` |  |
| `plot 2.display` | `number` |  |
| `plot 2.linestyle` | `number` |  |
| `plot 2.linewidth` | `number` |  |
| `plot 2.plottype` | `LineStudyPlotStyleName` |  |
| `plot 2.trackprice` | `boolean` |  |
| `plot 2.transparency` | `number` |  |
| `plot 2.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageExponentialIndicatorOverrides {#movingaverageexponentialindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `smoothed ma.display` | `number` |  |
| `smoothed ma.linestyle` | `number` |  |
| `smoothed ma.linewidth` | `number` |  |
| `smoothed ma.plottype` | `LineStudyPlotStyleName` |  |
| `smoothed ma.trackprice` | `boolean` |  |
| `smoothed ma.transparency` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageHammingIndicatorOverrides {#movingaveragehammingindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot 1.display` | `number` |  |
| `plot 1.linestyle` | `number` |  |
| `plot 1.linewidth` | `number` |  |
| `plot 1.plottype` | `LineStudyPlotStyleName` |  |
| `plot 1.transparency` | `number` |  |
| `plot 1.trackprice` | `boolean` |  |
| `plot 1.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageIndicatorOverrides {#movingaverageindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `smoothed ma.display` | `number` |  |
| `smoothed ma.linestyle` | `number` |  |
| `smoothed ma.linewidth` | `number` |  |
| `smoothed ma.plottype` | `LineStudyPlotStyleName` |  |
| `smoothed ma.trackprice` | `boolean` |  |
| `smoothed ma.transparency` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageMultipleIndicatorOverrides {#movingaveragemultipleindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot 1.display` | `number` |  |
| `plot 1.linestyle` | `number` |  |
| `plot 1.linewidth` | `number` |  |
| `plot 1.plottype` | `LineStudyPlotStyleName` |  |
| `plot 1.transparency` | `number` |  |
| `plot 1.trackprice` | `boolean` |  |
| `plot 1.color` | `string` |  |
| `plot 2.display` | `number` |  |
| `plot 2.linestyle` | `number` |  |
| `plot 2.linewidth` | `number` |  |
| `plot 2.transparency` | `number` |  |
| `plot 2.plottype` | `LineStudyPlotStyleName` |  |
| `plot 2.trackprice` | `boolean` |  |
| `plot 2.color` | `string` |  |
| `plot 3.display` | `number` |  |
| `plot 3.linestyle` | `number` |  |
| `plot 3.linewidth` | `number` |  |
| `plot 3.transparency` | `number` |  |
| `plot 3.plottype` | `LineStudyPlotStyleName` |  |
| `plot 3.trackprice` | `boolean` |  |
| `plot 3.color` | `string` |  |
| `plot 4.display` | `number` |  |
| `plot 4.linestyle` | `number` |  |
| `plot 4.linewidth` | `number` |  |
| `plot 4.transparency` | `number` |  |
| `plot 4.plottype` | `LineStudyPlotStyleName` |  |
| `plot 4.trackprice` | `boolean` |  |
| `plot 4.color` | `string` |  |
| `plot 5.display` | `number` |  |
| `plot 5.linestyle` | `number` |  |
| `plot 5.linewidth` | `number` |  |
| `plot 5.transparency` | `number` |  |
| `plot 5.plottype` | `LineStudyPlotStyleName` |  |
| `plot 5.trackprice` | `boolean` |  |
| `plot 5.color` | `string` |  |
| `plot 6.display` | `number` |  |
| `plot 6.linestyle` | `number` |  |
| `plot 6.linewidth` | `number` |  |
| `plot 6.transparency` | `number` |  |
| `plot 6.plottype` | `LineStudyPlotStyleName` |  |
| `plot 6.trackprice` | `boolean` |  |
| `plot 6.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageTripleIndicatorOverrides {#movingaveragetripleindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot 1.display` | `number` |  |
| `plot 1.linestyle` | `number` |  |
| `plot 1.linewidth` | `number` |  |
| `plot 1.plottype` | `LineStudyPlotStyleName` |  |
| `plot 1.transparency` | `number` |  |
| `plot 1.trackprice` | `boolean` |  |
| `plot 1.color` | `string` |  |
| `plot 2.display` | `number` |  |
| `plot 2.linestyle` | `number` |  |
| `plot 2.linewidth` | `number` |  |
| `plot 2.transparency` | `number` |  |
| `plot 2.plottype` | `LineStudyPlotStyleName` |  |
| `plot 2.trackprice` | `boolean` |  |
| `plot 2.color` | `string` |  |
| `plot 3.display` | `number` |  |
| `plot 3.linestyle` | `number` |  |
| `plot 3.linewidth` | `number` |  |
| `plot 3.transparency` | `number` |  |
| `plot 3.plottype` | `LineStudyPlotStyleName` |  |
| `plot 3.trackprice` | `boolean` |  |
| `plot 3.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## MovingAverageWeightedIndicatorOverrides {#movingaverageweightedindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## NetVolumeIndicatorOverrides {#netvolumeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## OnBalanceVolumeIndicatorOverrides {#onbalancevolumeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `smoothed ma.display` | `number` |  |
| `smoothed ma.linestyle` | `number` |  |
| `smoothed ma.linewidth` | `number` |  |
| `smoothed ma.plottype` | `LineStudyPlotStyleName` |  |
| `smoothed ma.trackprice` | `boolean` |  |
| `smoothed ma.transparency` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## OverlayIndicatorOverrides {#overlayindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `` | `StudyOverrideValueType` |  |

## ParabolicSARIndicatorOverrides {#parabolicsarindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## PivotPointsStandardIndicatorOverrides {#pivotpointsstandardindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `` | `StudyOverrideValueType` |  |

## PriceChannelIndicatorOverrides {#pricechannelindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `highprice line.display` | `number` |  |
| `highprice line.linestyle` | `number` |  |
| `highprice line.linewidth` | `number` |  |
| `highprice line.plottype` | `LineStudyPlotStyleName` |  |
| `highprice line.trackprice` | `boolean` |  |
| `highprice line.transparency` | `number` |  |
| `highprice line.color` | `string` |  |
| `lowprice line.display` | `number` |  |
| `lowprice line.linestyle` | `number` |  |
| `lowprice line.linewidth` | `number` |  |
| `lowprice line.plottype` | `LineStudyPlotStyleName` |  |
| `lowprice line.trackprice` | `boolean` |  |
| `lowprice line.transparency` | `number` |  |
| `lowprice line.color` | `string` |  |
| `centerprice line.display` | `number` |  |
| `centerprice line.linestyle` | `number` |  |
| `centerprice line.linewidth` | `number` |  |
| `centerprice line.plottype` | `LineStudyPlotStyleName` |  |
| `centerprice line.trackprice` | `boolean` |  |
| `centerprice line.transparency` | `number` |  |
| `centerprice line.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## PriceOscillatorIndicatorOverrides {#priceoscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## PriceVolumeTrendIndicatorOverrides {#pricevolumetrendindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `pvt.display` | `number` |  |
| `pvt.linestyle` | `number` |  |
| `pvt.linewidth` | `number` |  |
| `pvt.plottype` | `LineStudyPlotStyleName` |  |
| `pvt.trackprice` | `boolean` |  |
| `pvt.transparency` | `number` |  |
| `pvt.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## RateOfChangeIndicatorOverrides {#rateofchangeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero line.color` | `string` |  |
| `zero line.linestyle` | `number` |  |
| `zero line.linewidth` | `number` |  |
| `zero line.visible` | `boolean` |  |
| `zero line.value` | `number` |  |
| `roc.display` | `number` |  |
| `roc.linestyle` | `number` |  |
| `roc.linewidth` | `number` |  |
| `roc.plottype` | `LineStudyPlotStyleName` |  |
| `roc.trackprice` | `boolean` |  |
| `roc.transparency` | `number` |  |
| `roc.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## RatioIndicatorOverrides {#ratioindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `plot.display` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## RegressionTrendIndicatorOverrides {#regressiontrendindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `` | `StudyOverrideValueType` |  |

## RelativeStrengthIndexIndicatorOverrides {#relativestrengthindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `upperlimit.zorder` | `number` |  |
| `middlelimit.color` | `string` |  |
| `middlelimit.linestyle` | `number` |  |
| `middlelimit.linewidth` | `number` |  |
| `middlelimit.visible` | `boolean` |  |
| `middlelimit.value` | `number` |  |
| `middlelimit.zorder` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `lowerlimit.zorder` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `smoothed ma.display` | `number` |  |
| `smoothed ma.linestyle` | `number` |  |
| `smoothed ma.linewidth` | `number` |  |
| `smoothed ma.plottype` | `LineStudyPlotStyleName` |  |
| `smoothed ma.trackprice` | `boolean` |  |
| `smoothed ma.transparency` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## RelativeVigorIndexIndicatorOverrides {#relativevigorindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `rvgi.display` | `number` |  |
| `rvgi.linestyle` | `number` |  |
| `rvgi.linewidth` | `number` |  |
| `rvgi.plottype` | `LineStudyPlotStyleName` |  |
| `rvgi.trackprice` | `boolean` |  |
| `rvgi.transparency` | `number` |  |
| `rvgi.color` | `string` |  |
| `signal.display` | `number` |  |
| `signal.linestyle` | `number` |  |
| `signal.linewidth` | `number` |  |
| `signal.plottype` | `LineStudyPlotStyleName` |  |
| `signal.trackprice` | `boolean` |  |
| `signal.transparency` | `number` |  |
| `signal.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## RelativeVolatilityIndexIndicatorOverrides {#relativevolatilityindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## SMIErgodicIndicatorOscillatorIndicatorOverrides {#smiergodicindicatoroscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `indicator.display` | `number` |  |
| `indicator.linestyle` | `number` |  |
| `indicator.linewidth` | `number` |  |
| `indicator.plottype` | `LineStudyPlotStyleName` |  |
| `indicator.trackprice` | `boolean` |  |
| `indicator.transparency` | `number` |  |
| `indicator.color` | `string` |  |
| `signal.display` | `number` |  |
| `signal.linestyle` | `number` |  |
| `signal.linewidth` | `number` |  |
| `signal.plottype` | `LineStudyPlotStyleName` |  |
| `signal.trackprice` | `boolean` |  |
| `signal.transparency` | `number` |  |
| `signal.color` | `string` |  |
| `oscillator.display` | `number` |  |
| `oscillator.linestyle` | `number` |  |
| `oscillator.linewidth` | `number` |  |
| `oscillator.plottype` | `LineStudyPlotStyleName` |  |
| `oscillator.trackprice` | `boolean` |  |
| `oscillator.transparency` | `number` |  |
| `oscillator.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## SessionsIndicatorOverrides {#sessionsindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `` | `StudyOverrideValueType` |  |

## SingleIndicatorOverrides {#singleindicatoroverrides}

```ts
export type SingleIndicatorOverrides =
  | FiftyTwoWeekHighLowIndicatorOverrides
  | AcceleratorOscillatorIndicatorOverrides
  | AccumulationDistributionIndicatorOverrides
  | AccumulativeSwingIndexIndicatorOverrides
  | AdvanceDeclineIndicatorOverrides
  | AnchoredVWAPIndicatorOverrides
  | ArnaudLegouxMovingAverageIndicatorOverrides
  | AroonIndicatorOverrides
  | AverageDirectionalIndexIndicatorOverrides
  | AveragePriceIndicatorOverrides
  | AverageTrueRangeIndicatorOverrides
  | AwesomeOscillatorIndicatorOverrides
  | BalanceofPowerIndicatorOverrides
  | BollingerBandsIndicatorOverrides
  | BollingerBandsBIndicatorOverrides
  | BollingerBandsWidthIndicatorOverrides
  | ChaikinMoneyFlowIndicatorOverrides
  | ChaikinOscillatorIndicatorOverrides
  | ChaikinVolatilityIndicatorOverrides
  | ChandeKrollStopIndicatorOverrides
  | ChandeMomentumOscillatorIndicatorOverrides
  | ChopZoneIndicatorOverrides
  | ChoppinessIndexIndicatorOverrides
  | CommodityChannelIndexIndicatorOverrides
  | CompareIndicatorOverrides
  | ConnorsRSIIndicatorOverrides
  | CoppockCurveIndicatorOverrides
  | CorrelationLogIndicatorOverrides
  | CorrelationCoefficientIndicatorOverrides
  | DetrendedPriceOscillatorIndicatorOverrides
  | DirectionalMovementIndicatorOverrides
  | DonchianChannelsIndicatorOverrides
  | DoubleEMAIndicatorOverrides
  | EMACrossIndicatorOverrides
  | EaseOfMovementIndicatorOverrides
  | EldersForceIndexIndicatorOverrides
  | EnvelopesIndicatorOverrides
  | FisherTransformIndicatorOverrides
  | FixedRangeIndicatorOverrides
  | GuppyMultipleMovingAverageIndicatorOverrides
  | HistoricalVolatilityIndicatorOverrides
  | HullMovingAverageIndicatorOverrides
  | IchimokuCloudIndicatorOverrides
  | KeltnerChannelsIndicatorOverrides
  | KlingerOscillatorIndicatorOverrides
  | KnowSureThingIndicatorOverrides
  | LeastSquaresMovingAverageIndicatorOverrides
  | LinearRegressionCurveIndicatorOverrides
  | LinearRegressionSlopeIndicatorOverrides
  | MACrossIndicatorOverrides
  | MAwithEMACrossIndicatorOverrides
  | MACDIndicatorOverrides
  | MajorityRuleIndicatorOverrides
  | MassIndexIndicatorOverrides
  | McGinleyDynamicIndicatorOverrides
  | MedianPriceIndicatorOverrides
  | MomentumIndicatorOverrides
  | MoneyFlowIndexIndicatorOverrides
  | MovingAverageIndicatorOverrides
  | MovingAverageAdaptiveIndicatorOverrides
  | MovingAverageChannelIndicatorOverrides
  | MovingAverageDoubleIndicatorOverrides
  | MovingAverageExponentialIndicatorOverrides
  | MovingAverageHammingIndicatorOverrides
  | MovingAverageMultipleIndicatorOverrides
  | MovingAverageTripleIndicatorOverrides
  | MovingAverageWeightedIndicatorOverrides
  | NetVolumeIndicatorOverrides
  | OnBalanceVolumeIndicatorOverrides
  | OverlayIndicatorOverrides
  | ParabolicSARIndicatorOverrides
  | PivotPointsStandardIndicatorOverrides
  | PriceChannelIndicatorOverrides
  | PriceOscillatorIndicatorOverrides
  | PriceVolumeTrendIndicatorOverrides
  | RateOfChangeIndicatorOverrides
  | RatioIndicatorOverrides
  | RegressionTrendIndicatorOverrides
  | RelativeStrengthIndexIndicatorOverrides
  | RelativeVigorIndexIndicatorOverrides
  | RelativeVolatilityIndexIndicatorOverrides
  | SMIErgodicIndicatorOscillatorIndicatorOverrides
  | SessionsIndicatorOverrides
  | SmoothedMovingAverageIndicatorOverrides
  | SpreadIndicatorOverrides
  | StandardDeviationIndicatorOverrides
  | StandardErrorIndicatorOverrides
  | StandardErrorBandsIndicatorOverrides
  | StochasticIndicatorOverrides
  | StochasticRSIIndicatorOverrides
  | SuperTrendIndicatorOverrides
  | TRIXIndicatorOverrides
  | TrendStrengthIndexIndicatorOverrides
  | TripleEMAIndicatorOverrides
  | TrueStrengthIndexIndicatorOverrides
  | TypicalPriceIndicatorOverrides
  | UltimateOscillatorIndicatorOverrides
  | VWAPIndicatorOverrides
  | VWMAIndicatorOverrides
  | VolatilityClosetoCloseIndicatorOverrides
  | VolatilityIndexIndicatorOverrides
  | VolatilityOHLCIndicatorOverrides
  | VolatilityZeroTrendClosetoCloseIndicatorOverrides
  | VolumeIndicatorOverrides
  | VolumeOscillatorIndicatorOverrides
  | VolumeProfileFixedRangeIndicatorOverrides
  | VolumeProfileVisibleRangeIndicatorOverrides
  | VortexIndicatorIndicatorOverrides
  | WilliamsRIndicatorOverrides
  | WilliamsAlligatorIndicatorOverrides
  | WilliamsFractalIndicatorOverrides
  | ZigZagIndicatorOverrides;
```

## SmoothedMovingAverageIndicatorOverrides {#smoothedmovingaverageindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## SpreadIndicatorOverrides {#spreadindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `negative fill.transparency` | `number` |  |
| `negative fill.visible` | `boolean` |  |
| `positive fill.transparency` | `number` |  |
| `positive fill.visible` | `boolean` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `plot.display` | `number` |  |
| `baseline.linestyle` | `number` |  |
| `baseline.linewidth` | `number` |  |
| `baseline.plottype` | `LineStudyPlotStyleName` |  |
| `baseline.trackprice` | `boolean` |  |
| `baseline.transparency` | `number` |  |
| `baseline.color` | `string` |  |
| `baseline.display` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## StandardDeviationIndicatorOverrides {#standarddeviationindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## StandardErrorBandsIndicatorOverrides {#standarderrorbandsindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `background.color` | `string` |  |
| `background.transparency` | `number` |  |
| `background.visible` | `boolean` |  |
| `plot 1.display` | `number` |  |
| `plot 1.linestyle` | `number` |  |
| `plot 1.linewidth` | `number` |  |
| `plot 1.plottype` | `LineStudyPlotStyleName` |  |
| `plot 1.transparency` | `number` |  |
| `plot 1.trackprice` | `boolean` |  |
| `plot 1.color` | `string` |  |
| `plot 2.display` | `number` |  |
| `plot 2.linestyle` | `number` |  |
| `plot 2.linewidth` | `number` |  |
| `plot 2.transparency` | `number` |  |
| `plot 2.plottype` | `LineStudyPlotStyleName` |  |
| `plot 2.trackprice` | `boolean` |  |
| `plot 2.color` | `string` |  |
| `plot 3.display` | `number` |  |
| `plot 3.linestyle` | `number` |  |
| `plot 3.linewidth` | `number` |  |
| `plot 3.transparency` | `number` |  |
| `plot 3.plottype` | `LineStudyPlotStyleName` |  |
| `plot 3.trackprice` | `boolean` |  |
| `plot 3.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## StandardErrorIndicatorOverrides {#standarderrorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## StochasticIndicatorOverrides {#stochasticindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `%k.display` | `number` |  |
| `%k.linestyle` | `number` |  |
| `%k.linewidth` | `number` |  |
| `%k.plottype` | `LineStudyPlotStyleName` |  |
| `%k.trackprice` | `boolean` |  |
| `%k.transparency` | `number` |  |
| `%k.color` | `string` |  |
| `%d.display` | `number` |  |
| `%d.linestyle` | `number` |  |
| `%d.linewidth` | `number` |  |
| `%d.plottype` | `LineStudyPlotStyleName` |  |
| `%d.trackprice` | `boolean` |  |
| `%d.transparency` | `number` |  |
| `%d.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## StochasticRSIIndicatorOverrides {#stochasticrsiindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `%k.display` | `number` |  |
| `%k.linestyle` | `number` |  |
| `%k.linewidth` | `number` |  |
| `%k.plottype` | `LineStudyPlotStyleName` |  |
| `%k.trackprice` | `boolean` |  |
| `%k.transparency` | `number` |  |
| `%k.color` | `string` |  |
| `%d.display` | `number` |  |
| `%d.linestyle` | `number` |  |
| `%d.linewidth` | `number` |  |
| `%d.plottype` | `LineStudyPlotStyleName` |  |
| `%d.trackprice` | `boolean` |  |
| `%d.transparency` | `number` |  |
| `%d.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## SuperTrendIndicatorOverrides {#supertrendindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `supertrend.display` | `number` |  |
| `supertrend.linestyle` | `number` |  |
| `supertrend.linewidth` | `number` |  |
| `supertrend.plottype` | `LineStudyPlotStyleName` |  |
| `supertrend.trackprice` | `boolean` |  |
| `supertrend.transparency` | `number` |  |
| `supertrend.color` | `string` |  |
| `up arrow.display` | `number` |  |
| `up arrow.linestyle` | `number` |  |
| `up arrow.linewidth` | `number` |  |
| `up arrow.plottype` | `string` |  |
| `up arrow.trackprice` | `boolean` |  |
| `up arrow.location` | `string` |  |
| `up arrow.transparency` | `number` |  |
| `up arrow.color` | `string` |  |
| `down arrow.display` | `number` |  |
| `down arrow.linestyle` | `number` |  |
| `down arrow.linewidth` | `number` |  |
| `down arrow.plottype` | `string` |  |
| `down arrow.trackprice` | `boolean` |  |
| `down arrow.location` | `string` |  |
| `down arrow.transparency` | `number` |  |
| `down arrow.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## TRIXIndicatorOverrides {#trixindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `trix.display` | `number` |  |
| `trix.linestyle` | `number` |  |
| `trix.linewidth` | `number` |  |
| `trix.plottype` | `LineStudyPlotStyleName` |  |
| `trix.trackprice` | `boolean` |  |
| `trix.transparency` | `number` |  |
| `trix.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## TrendStrengthIndexIndicatorOverrides {#trendstrengthindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## TripleEMAIndicatorOverrides {#tripleemaindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## TrueStrengthIndexIndicatorOverrides {#truestrengthindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `true strength index.display` | `number` |  |
| `true strength index.linestyle` | `number` |  |
| `true strength index.linewidth` | `number` |  |
| `true strength index.plottype` | `LineStudyPlotStyleName` |  |
| `true strength index.trackprice` | `boolean` |  |
| `true strength index.transparency` | `number` |  |
| `true strength index.color` | `string` |  |
| `signal.display` | `number` |  |
| `signal.linestyle` | `number` |  |
| `signal.linewidth` | `number` |  |
| `signal.plottype` | `LineStudyPlotStyleName` |  |
| `signal.trackprice` | `boolean` |  |
| `signal.transparency` | `number` |  |
| `signal.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## TypicalPriceIndicatorOverrides {#typicalpriceindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## UltimateOscillatorIndicatorOverrides {#ultimateoscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `uo.display` | `number` |  |
| `uo.linestyle` | `number` |  |
| `uo.linewidth` | `number` |  |
| `uo.plottype` | `LineStudyPlotStyleName` |  |
| `uo.trackprice` | `boolean` |  |
| `uo.transparency` | `number` |  |
| `uo.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VWAPIndicatorOverrides {#vwapindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `vwap.display` | `number` |  |
| `vwap.linestyle` | `number` |  |
| `vwap.linewidth` | `number` |  |
| `vwap.plottype` | `LineStudyPlotStyleName` |  |
| `vwap.trackprice` | `number` |  |
| `vwap.transparency` | `number` |  |
| `vwap.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VWMAIndicatorOverrides {#vwmaindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VolatilityClosetoCloseIndicatorOverrides {#volatilityclosetocloseindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VolatilityIndexIndicatorOverrides {#volatilityindexindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VolatilityOHLCIndicatorOverrides {#volatilityohlcindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VolatilityZeroTrendClosetoCloseIndicatorOverrides {#volatilityzerotrendclosetocloseindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VolumeIndicatorOverrides {#volumeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `volume.display` | `number` |  |
| `volume.linestyle` | `number` |  |
| `volume.linewidth` | `number` |  |
| `volume.plottype` | `LineStudyPlotStyleName` |  |
| `volume.trackprice` | `boolean` |  |
| `volume.transparency` | `number` |  |
| `volume.color` | `string` |  |
| `volume ma.display` | `number` |  |
| `volume ma.linestyle` | `number` |  |
| `volume ma.linewidth` | `number` |  |
| `volume ma.plottype` | `LineStudyPlotStyleName` |  |
| `volume ma.trackprice` | `boolean` |  |
| `volume ma.transparency` | `number` |  |
| `volume ma.color` | `string` |  |
| `smoothed ma.display` | `number` |  |
| `smoothed ma.linestyle` | `number` |  |
| `smoothed ma.linewidth` | `number` |  |
| `smoothed ma.plottype` | `LineStudyPlotStyleName` |  |
| `smoothed ma.trackprice` | `boolean` |  |
| `smoothed ma.transparency` | `number` |  |
| `smoothed ma.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VolumeOscillatorIndicatorOverrides {#volumeoscillatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `zero.color` | `string` |  |
| `zero.linestyle` | `number` |  |
| `zero.linewidth` | `number` |  |
| `zero.visible` | `boolean` |  |
| `zero.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## VolumeProfileFixedRangeIndicatorOverrides {#volumeprofilefixedrangeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `developing poc.color` | `string` |  |
| `developing poc.linestyle` | `number` |  |
| `developing poc.linewidth` | `number` |  |
| `developing poc.plottype` | `LineStudyPlotStyleName` |  |
| `developing poc.trackprice` | `boolean` |  |
| `developing poc.transparency` | `number` |  |
| `developing poc.display` | `number` |  |
| `developing va high.color` | `string` |  |
| `developing va high.linestyle` | `number` |  |
| `developing va high.linewidth` | `number` |  |
| `developing va high.plottype` | `LineStudyPlotStyleName` |  |
| `developing va high.trackprice` | `boolean` |  |
| `developing va high.transparency` | `number` |  |
| `developing va high.display` | `number` |  |
| `developing va low.color` | `string` |  |
| `developing va low.linestyle` | `number` |  |
| `developing va low.linewidth` | `number` |  |
| `developing va low.plottype` | `LineStudyPlotStyleName` |  |
| `developing va low.trackprice` | `boolean` |  |
| `developing va low.transparency` | `number` |  |
| `developing va low.display` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## VolumeProfileVisibleRangeIndicatorOverrides {#volumeprofilevisiblerangeindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `developing poc.color` | `string` |  |
| `developing poc.linestyle` | `number` |  |
| `developing poc.linewidth` | `number` |  |
| `developing poc.plottype` | `LineStudyPlotStyleName` |  |
| `developing poc.trackprice` | `boolean` |  |
| `developing poc.transparency` | `number` |  |
| `developing poc.display` | `number` |  |
| `developing va high.color` | `string` |  |
| `developing va high.linestyle` | `number` |  |
| `developing va high.linewidth` | `number` |  |
| `developing va high.plottype` | `LineStudyPlotStyleName` |  |
| `developing va high.trackprice` | `boolean` |  |
| `developing va high.transparency` | `number` |  |
| `developing va high.display` | `number` |  |
| `developing va low.color` | `string` |  |
| `developing va low.linestyle` | `number` |  |
| `developing va low.linewidth` | `number` |  |
| `developing va low.plottype` | `LineStudyPlotStyleName` |  |
| `developing va low.trackprice` | `boolean` |  |
| `developing va low.transparency` | `number` |  |
| `developing va low.display` | `number` |  |
| `` | `StudyOverrideValueType` |  |

## VortexIndicatorIndicatorOverrides {#vortexindicatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `vi +.display` | `number` |  |
| `vi +.linestyle` | `number` |  |
| `vi +.linewidth` | `number` |  |
| `vi +.plottype` | `LineStudyPlotStyleName` |  |
| `vi +.trackprice` | `boolean` |  |
| `vi +.transparency` | `number` |  |
| `vi +.color` | `string` |  |
| `vi -.display` | `number` |  |
| `vi -.linestyle` | `number` |  |
| `vi -.linewidth` | `number` |  |
| `vi -.plottype` | `LineStudyPlotStyleName` |  |
| `vi -.trackprice` | `boolean` |  |
| `vi -.transparency` | `number` |  |
| `vi -.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## WilliamsAlligatorIndicatorOverrides {#williamsalligatorindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `jaw.display` | `number` |  |
| `jaw.linestyle` | `number` |  |
| `jaw.linewidth` | `number` |  |
| `jaw.plottype` | `LineStudyPlotStyleName` |  |
| `jaw.trackprice` | `boolean` |  |
| `jaw.transparency` | `number` |  |
| `jaw.color` | `string` |  |
| `teeth.display` | `number` |  |
| `teeth.linestyle` | `number` |  |
| `teeth.linewidth` | `number` |  |
| `teeth.plottype` | `LineStudyPlotStyleName` |  |
| `teeth.trackprice` | `boolean` |  |
| `teeth.transparency` | `number` |  |
| `teeth.color` | `string` |  |
| `lips.display` | `number` |  |
| `lips.linestyle` | `number` |  |
| `lips.linewidth` | `number` |  |
| `lips.plottype` | `LineStudyPlotStyleName` |  |
| `lips.trackprice` | `boolean` |  |
| `lips.transparency` | `number` |  |
| `lips.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## WilliamsFractalIndicatorOverrides {#williamsfractalindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `down fractals.display` | `number` |  |
| `down fractals.plottype` | `string` |  |
| `down fractals.location` | `string` |  |
| `down fractals.transparency` | `number` |  |
| `down fractals.color` | `string` |  |
| `up fractals.display` | `number` |  |
| `up fractals.plottype` | `string` |  |
| `up fractals.location` | `string` |  |
| `up fractals.transparency` | `number` |  |
| `up fractals.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## WilliamsRIndicatorOverrides {#williamsrindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `hlines background.color` | `string` |  |
| `hlines background.transparency` | `number` |  |
| `hlines background.visible` | `boolean` |  |
| `upperlimit.color` | `string` |  |
| `upperlimit.linestyle` | `number` |  |
| `upperlimit.linewidth` | `number` |  |
| `upperlimit.visible` | `boolean` |  |
| `upperlimit.value` | `number` |  |
| `lowerlimit.color` | `string` |  |
| `lowerlimit.linestyle` | `number` |  |
| `lowerlimit.linewidth` | `number` |  |
| `lowerlimit.visible` | `boolean` |  |
| `lowerlimit.value` | `number` |  |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

## ZigZagIndicatorOverrides {#zigzagindicatoroverrides}

| Property | Type | Default |
| --- | --- | --- |
| `plot.display` | `number` |  |
| `plot.linestyle` | `number` |  |
| `plot.linewidth` | `number` |  |
| `plot.plottype` | `LineStudyPlotStyleName` |  |
| `plot.trackprice` | `boolean` |  |
| `plot.transparency` | `number` |  |
| `plot.color` | `string` |  |
| `` | `StudyOverrideValueType` |  |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/indicator-overrides


---

<!-- Public documentation export; not library implementation source. -->
# INewsApi

[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.

## refresh {#refresh}

```ts
refresh(): void;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/INewsApi


---

<!-- Public documentation export; not library implementation source. -->
# InitialSettingsMap

[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.

## signature {#signature}

```ts
[key: string]: string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/InitialSettingsMap


---

<!-- Public documentation export; not library implementation source. -->
# INonSeriesStudyBarsResult

[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.

## type {#type}

```ts
type: "non_series_bars";
```

Use the type signature above and the integration guide for the owning capability.

## bars {#bars}

```ts
bars: IBarArray[];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [IBarArray](https://docs.lumencharts.com/charting-library/api/IBarArray)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/INonSeriesStudyBarsResult


---

<!-- Public documentation export; not library implementation source. -->
# INonSeriesStudyResult

[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.

## type {#type}

```ts
type: "non_series_data";
```

Use the type signature above and the integration guide for the owning capability.

## nonseries {#nonseries}

```ts
nonseries: true;
```

Use the type signature above and the integration guide for the owning capability.

## data {#data}

```ts
data: object;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/INonSeriesStudyResult


---

<!-- Public documentation export; not library implementation source. -->
# IntrabarCoverage

[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.

```ts
export type IntrabarCoverage = {
  version: 1;
  requestedMode: BarDetailizationMode;
  effectiveMode: BarDetailizationMode;
  status: IntrabarCoverageStatus;
  parentResolution: string;
  childResolution: string | null;
  requestedFrom: number | null;
  requestedTo: number | null;
  coveredFrom: number | null;
  coveredTo: number | null;
  magnifiedParentBars: number;
  fallbackParentBars: number;
  childBarCount: number;
  datasetHash: string;
  fallbackReason: string | null;
};
```

## Related types

- [BarDetailizationMode](https://docs.lumencharts.com/charting-library/api/BarDetailizationMode)
- [IntrabarCoverageStatus](https://docs.lumencharts.com/charting-library/api/IntrabarCoverageStatus)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IntrabarCoverage


---

<!-- Public documentation export; not library implementation source. -->
# IntrabarCoverageStatus

[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.

```ts
export type IntrabarCoverageStatus = "full" | "partial" | "none" | "unsupported";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IntrabarCoverageStatus


---

<!-- Public documentation export; not library implementation source. -->
# INumberFormatter

[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.

## Extends

[IFormatter](https://docs.lumencharts.com/charting-library/api/IFormatter)

## formatChange {#formatchange}

```ts
formatChange?(currentPrice: number, prevPrice: number): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `currentPrice` | `number` | Yes |
| `prevPrice` | `number` | Yes |

## Related types

- [IFormatter](https://docs.lumencharts.com/charting-library/api/IFormatter)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/INumberFormatter


---

<!-- Public documentation export; not library implementation source. -->
# IObservable

[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.

## subscribe {#subscribe}

```ts
subscribe(callback: (value: T) => void): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `(value: T) => void` | Yes |

## unsubscribe {#unsubscribe}

```ts
unsubscribe(callback: (value: T) => void): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `(value: T) => void` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IObservable


---

<!-- Public documentation export; not library implementation source. -->
# IObservableValue

[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.

```ts
export interface IObservableValue<T> extends IBoxedValue<T>, IObservable<T> {}
```

## Related types

- [IBoxedValue](https://docs.lumencharts.com/charting-library/api/IBoxedValue)
- [IObservable](https://docs.lumencharts.com/charting-library/api/IObservable)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IObservableValue


---

<!-- Public documentation export; not library implementation source. -->
# IObservableValueReadOnly

[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.

```ts
export interface IObservableValueReadOnly<T>
  extends IBoxedValueReadOnly<T>, IObservable<T> {}
```

## Related types

- [IBoxedValueReadOnly](https://docs.lumencharts.com/charting-library/api/IBoxedValueReadOnly)
- [IObservable](https://docs.lumencharts.com/charting-library/api/IObservable)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IObservableValueReadOnly


---

<!-- Public documentation export; not library implementation source. -->
# IOrderLineAdapter

[Integration guide](https://docs.lumencharts.com/charting-library/drawings#host-trading-overlays) · [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.

## remove {#remove}

```ts
remove(): void;
```

Use the type signature above and the integration guide for the owning capability.

## onModify {#onmodify}

```ts
onModify(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onModify (overload 2) {#onmodify-1}

```ts
onModify<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## onMove {#onmove}

```ts
onMove(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onMove (overload 2) {#onmove-1}

```ts
onMove<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## onMoving {#onmoving}

```ts
onMoving(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onMoving (overload 2) {#onmoving-1}

```ts
onMoving<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## onCancel {#oncancel}

```ts
onCancel(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onCancel (overload 2) {#oncancel-1}

```ts
onCancel<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## getPrice {#getprice}

```ts
getPrice(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setPrice {#setprice}

```ts
setPrice(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getText {#gettext}

```ts
getText(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setText {#settext}

```ts
setText(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getTooltip {#gettooltip}

```ts
getTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setTooltip {#settooltip}

```ts
setTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getModifyTooltip {#getmodifytooltip}

```ts
getModifyTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setModifyTooltip {#setmodifytooltip}

```ts
setModifyTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCancelTooltip {#getcanceltooltip}

```ts
getCancelTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCancelTooltip {#setcanceltooltip}

```ts
setCancelTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantity {#getquantity}

```ts
getQuantity(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantity {#setquantity}

```ts
setQuantity(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getEditable {#geteditable}

```ts
getEditable(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setEditable {#seteditable}

```ts
setEditable(value: boolean): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `boolean` | Yes |

## getCancellable {#getcancellable}

```ts
getCancellable(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setCancellable {#setcancellable}

```ts
setCancellable(value: boolean): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `boolean` | Yes |

## getExtendLeft {#getextendleft}

```ts
getExtendLeft(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setExtendLeft {#setextendleft}

```ts
setExtendLeft(value: boolean): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `boolean` | Yes |

## getLineLength {#getlinelength}

```ts
getLineLength(): number;
```

Use the type signature above and the integration guide for the owning capability.

## getLineLengthUnit {#getlinelengthunit}

```ts
getLineLengthUnit(): OrderLineLengthUnit;
```

Use the type signature above and the integration guide for the owning capability.

## setLineLength {#setlinelength}

```ts
setLineLength(value: number, unit?: OrderLineLengthUnit): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |
| `unit` | `OrderLineLengthUnit` | No |

## getLineStyle {#getlinestyle}

```ts
getLineStyle(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineStyle {#setlinestyle}

```ts
setLineStyle(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getLineWidth {#getlinewidth}

```ts
getLineWidth(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineWidth {#setlinewidth}

```ts
setLineWidth(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getBodyFont {#getbodyfont}

```ts
getBodyFont(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyFont {#setbodyfont}

```ts
setBodyFont(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityFont {#getquantityfont}

```ts
getQuantityFont(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityFont {#setquantityfont}

```ts
setQuantityFont(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getLineColor {#getlinecolor}

```ts
getLineColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setLineColor {#setlinecolor}

```ts
setLineColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyBorderColor {#getbodybordercolor}

```ts
getBodyBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyBorderColor {#setbodybordercolor}

```ts
setBodyBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyBackgroundColor {#getbodybackgroundcolor}

```ts
getBodyBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyBackgroundColor {#setbodybackgroundcolor}

```ts
setBodyBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyTextColor {#getbodytextcolor}

```ts
getBodyTextColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyTextColor {#setbodytextcolor}

```ts
setBodyTextColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityBorderColor {#getquantitybordercolor}

```ts
getQuantityBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityBorderColor {#setquantitybordercolor}

```ts
setQuantityBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityBackgroundColor {#getquantitybackgroundcolor}

```ts
getQuantityBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityBackgroundColor {#setquantitybackgroundcolor}

```ts
setQuantityBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityTextColor {#getquantitytextcolor}

```ts
getQuantityTextColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityTextColor {#setquantitytextcolor}

```ts
setQuantityTextColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCancelButtonBorderColor {#getcancelbuttonbordercolor}

```ts
getCancelButtonBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCancelButtonBorderColor {#setcancelbuttonbordercolor}

```ts
setCancelButtonBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCancelButtonBackgroundColor {#getcancelbuttonbackgroundcolor}

```ts
getCancelButtonBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCancelButtonBackgroundColor {#setcancelbuttonbackgroundcolor}

```ts
setCancelButtonBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCancelButtonIconColor {#getcancelbuttoniconcolor}

```ts
getCancelButtonIconColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCancelButtonIconColor {#setcancelbuttoniconcolor}

```ts
setCancelButtonIconColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## Related types

- [OrderLineLengthUnit](https://docs.lumencharts.com/charting-library/api/OrderLineLengthUnit)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IOrderLineAdapter


---

<!-- Public documentation export; not library implementation source. -->
# IPaneApi

[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.

## hasMainSeries {#hasmainseries}

```ts
hasMainSeries(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## getLeftPriceScales {#getleftpricescales}

```ts
getLeftPriceScales(): readonly IPriceScaleApi[];
```

Use the type signature above and the integration guide for the owning capability.

## getRightPriceScales {#getrightpricescales}

```ts
getRightPriceScales(): readonly IPriceScaleApi[];
```

Use the type signature above and the integration guide for the owning capability.

## getMainSourcePriceScale {#getmainsourcepricescale}

```ts
getMainSourcePriceScale(): IPriceScaleApi | null;
```

Use the type signature above and the integration guide for the owning capability.

## getHeight {#getheight}

```ts
getHeight(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setHeight {#setheight}

```ts
setHeight(height: number): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `height` | `number` | Yes |

## moveTo {#moveto}

```ts
moveTo(paneIndex: number): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `paneIndex` | `number` | Yes |

## paneIndex {#paneindex}

```ts
paneIndex(): number;
```

Use the type signature above and the integration guide for the owning capability.

## collapse {#collapse}

```ts
collapse(): void;
```

Use the type signature above and the integration guide for the owning capability.

## restore {#restore}

```ts
restore(): void;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [IPriceScaleApi](https://docs.lumencharts.com/charting-library/api/IPriceScaleApi)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPaneApi


---

<!-- Public documentation export; not library implementation source. -->
# IPineSeries

[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.

## get {#get}

```ts
get(n?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n` | `number` | No |

## set {#set}

```ts
set(value: number): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## indexOf {#indexof}

```ts
indexOf(time: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `time` | `number` | Yes |

## adopt {#adopt}

```ts
adopt(source: IPineSeries, destination: IPineSeries, mode: 0 | 1): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `destination` | `IPineSeries` | Yes |
| `mode` | `0 &#124; 1` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPineSeries


---

<!-- Public documentation export; not library implementation source. -->
# IPineStudyResult

[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.

```ts
export type IPineStudyResult = IPineStudyResultTypes<IPineStudyResultSimple>;
```

## Related types

- [IPineStudyResultTypes](https://docs.lumencharts.com/charting-library/api/IPineStudyResultTypes)
- [IPineStudyResultSimple](https://docs.lumencharts.com/charting-library/api/IPineStudyResultSimple)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPineStudyResult


---

<!-- Public documentation export; not library implementation source. -->
# IPineStudyResultSimple

[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.

```ts
export type IPineStudyResultSimple =
  | StudyPrimitiveResult
  | ISeriesStudyResult
  | INonSeriesStudyBarsResult
  | IProjectionStudyResult
  | INonSeriesStudyResult;
```

## Related types

- [StudyPrimitiveResult](https://docs.lumencharts.com/charting-library/api/StudyPrimitiveResult)
- [ISeriesStudyResult](https://docs.lumencharts.com/charting-library/api/ISeriesStudyResult)
- [INonSeriesStudyBarsResult](https://docs.lumencharts.com/charting-library/api/INonSeriesStudyBarsResult)
- [IProjectionStudyResult](https://docs.lumencharts.com/charting-library/api/IProjectionStudyResult)
- [INonSeriesStudyResult](https://docs.lumencharts.com/charting-library/api/INonSeriesStudyResult)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPineStudyResultSimple


---

<!-- Public documentation export; not library implementation source. -->
# IPineStudyResultTypes

[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.

```ts
export type IPineStudyResultTypes<TPineStudyResultSimple> =
  TPineStudyResultSimple | PineStudyResultComposite<TPineStudyResultSimple>;
```

## Related types

- [PineStudyResultComposite](https://docs.lumencharts.com/charting-library/api/PineStudyResultComposite)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPineStudyResultTypes


---

<!-- Public documentation export; not library implementation source. -->
# IPositionLineAdapter

[Integration guide](https://docs.lumencharts.com/charting-library/drawings#host-trading-overlays) · [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.

## remove {#remove}

```ts
remove(): void;
```

Use the type signature above and the integration guide for the owning capability.

## onClose {#onclose}

```ts
onClose(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onClose (overload 2) {#onclose-1}

```ts
onClose<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## onModify {#onmodify}

```ts
onModify(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onModify (overload 2) {#onmodify-1}

```ts
onModify<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## onReverse {#onreverse}

```ts
onReverse(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onReverse (overload 2) {#onreverse-1}

```ts
onReverse<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## getPrice {#getprice}

```ts
getPrice(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setPrice {#setprice}

```ts
setPrice(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getText {#gettext}

```ts
getText(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setText {#settext}

```ts
setText(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getTooltip {#gettooltip}

```ts
getTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setTooltip {#settooltip}

```ts
setTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getProtectTooltip {#getprotecttooltip}

```ts
getProtectTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setProtectTooltip {#setprotecttooltip}

```ts
setProtectTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseTooltip {#getclosetooltip}

```ts
getCloseTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseTooltip {#setclosetooltip}

```ts
setCloseTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseTooltip {#getreversetooltip}

```ts
getReverseTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseTooltip {#setreversetooltip}

```ts
setReverseTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantity {#getquantity}

```ts
getQuantity(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantity {#setquantity}

```ts
setQuantity(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getExtendLeft {#getextendleft}

```ts
getExtendLeft(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setExtendLeft {#setextendleft}

```ts
setExtendLeft(value: boolean): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `boolean` | Yes |

## getLineLengthUnit {#getlinelengthunit}

```ts
getLineLengthUnit(): PositionLineLengthUnit;
```

Use the type signature above and the integration guide for the owning capability.

## getLineLength {#getlinelength}

```ts
getLineLength(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineLength {#setlinelength}

```ts
setLineLength(value: number, unit?: PositionLineLengthUnit): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |
| `unit` | `PositionLineLengthUnit` | No |

## getLineStyle {#getlinestyle}

```ts
getLineStyle(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineStyle {#setlinestyle}

```ts
setLineStyle(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getLineWidth {#getlinewidth}

```ts
getLineWidth(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineWidth {#setlinewidth}

```ts
setLineWidth(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getBodyFont {#getbodyfont}

```ts
getBodyFont(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyFont {#setbodyfont}

```ts
setBodyFont(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityFont {#getquantityfont}

```ts
getQuantityFont(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityFont {#setquantityfont}

```ts
setQuantityFont(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getLineColor {#getlinecolor}

```ts
getLineColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setLineColor {#setlinecolor}

```ts
setLineColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyBorderColor {#getbodybordercolor}

```ts
getBodyBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyBorderColor {#setbodybordercolor}

```ts
setBodyBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyBackgroundColor {#getbodybackgroundcolor}

```ts
getBodyBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyBackgroundColor {#setbodybackgroundcolor}

```ts
setBodyBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyTextColor {#getbodytextcolor}

```ts
getBodyTextColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyTextColor {#setbodytextcolor}

```ts
setBodyTextColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityBorderColor {#getquantitybordercolor}

```ts
getQuantityBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityBorderColor {#setquantitybordercolor}

```ts
setQuantityBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityBackgroundColor {#getquantitybackgroundcolor}

```ts
getQuantityBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityBackgroundColor {#setquantitybackgroundcolor}

```ts
setQuantityBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityTextColor {#getquantitytextcolor}

```ts
getQuantityTextColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityTextColor {#setquantitytextcolor}

```ts
setQuantityTextColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseButtonBorderColor {#getreversebuttonbordercolor}

```ts
getReverseButtonBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseButtonBorderColor {#setreversebuttonbordercolor}

```ts
setReverseButtonBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseButtonBackgroundColor {#getreversebuttonbackgroundcolor}

```ts
getReverseButtonBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseButtonBackgroundColor {#setreversebuttonbackgroundcolor}

```ts
setReverseButtonBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseButtonIconColor {#getreversebuttoniconcolor}

```ts
getReverseButtonIconColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseButtonIconColor {#setreversebuttoniconcolor}

```ts
setReverseButtonIconColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseButtonBorderColor {#getclosebuttonbordercolor}

```ts
getCloseButtonBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseButtonBorderColor {#setclosebuttonbordercolor}

```ts
setCloseButtonBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseButtonBackgroundColor {#getclosebuttonbackgroundcolor}

```ts
getCloseButtonBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseButtonBackgroundColor {#setclosebuttonbackgroundcolor}

```ts
setCloseButtonBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseButtonIconColor {#getclosebuttoniconcolor}

```ts
getCloseButtonIconColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseButtonIconColor {#setclosebuttoniconcolor}

```ts
setCloseButtonIconColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## Related types

- [PositionLineLengthUnit](https://docs.lumencharts.com/charting-library/api/PositionLineLengthUnit)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPositionLineAdapter


---

<!-- 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


---

<!-- Public documentation export; not library implementation source. -->
# IProjectionBar

[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.

```ts
export type IProjectionBar =
  | [number, number, number, number, number, number]
  | [number, number, number, number, number, number, number];
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IProjectionBar


---

<!-- Public documentation export; not library implementation source. -->
# IProjectionStudyResult

[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.

## bars {#bars}

```ts
bars: IProjectionBar[];
```

Use the type signature above and the integration guide for the owning capability.

## nonseries {#nonseries}

```ts
nonseries?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## price {#price}

```ts
price?: number;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
type: "projection";
```

Use the type signature above and the integration guide for the owning capability.

## boxSize {#boxsize}

```ts
boxSize?: number;
```

Use the type signature above and the integration guide for the owning capability.

## reversalAmount {#reversalamount}

```ts
reversalAmount?: number;
```

Use the type signature above and the integration guide for the owning capability.

## projectionTime {#projectiontime}

```ts
projectionTime?: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [IProjectionBar](https://docs.lumencharts.com/charting-library/api/IProjectionBar)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IProjectionStudyResult


---

<!-- Public documentation export; not library implementation source. -->
# ISelectionApi

[Integration guide](https://docs.lumencharts.com/charting-library/drawings#selection-groups-and-ordering) · [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.

## add {#add}

```ts
add(entities: EntityId[] | EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `entities` | `EntityId[] &#124; EntityId` | Yes |

## set {#set}

```ts
set(entities: EntityId[] | EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `entities` | `EntityId[] &#124; EntityId` | Yes |

## remove {#remove}

```ts
remove(entities: EntityId[]): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `entities` | `EntityId[]` | Yes |

## contains {#contains}

```ts
contains(entity: EntityId): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `entity` | `EntityId` | Yes |

## allSources {#allsources}

```ts
allSources(): EntityId[];
```

Use the type signature above and the integration guide for the owning capability.

## isEmpty {#isempty}

```ts
isEmpty(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## clear {#clear}

```ts
clear(): void;
```

Use the type signature above and the integration guide for the owning capability.

## onChanged {#onchanged}

```ts
onChanged(): ISubscription<() => void>;
```

Use the type signature above and the integration guide for the owning capability.

## canBeAddedToSelection {#canbeaddedtoselection}

```ts
canBeAddedToSelection(entity: EntityId): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `entity` | `EntityId` | Yes |

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ISelectionApi


---

<!-- Public documentation export; not library implementation source. -->
# ISeparator

[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.

## Extends

[IMenuItem](https://docs.lumencharts.com/charting-library/api/IMenuItem)

## type {#type}

```ts
readonly type: MenuItemType.Separator;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [IMenuItem](https://docs.lumencharts.com/charting-library/api/IMenuItem)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ISeparator


---

<!-- 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


---

<!-- Public documentation export; not library implementation source. -->
# ISeriesStudyResult

[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.

```ts
export type ISeriesStudyResult = [
  time: number,
  open: number,
  high: number,
  low: number,
  close: number,
  volume: number,
  updatetime: number | undefined,
  isBarClosed: boolean | undefined,
  emptyBars: number[] | undefined,
  emptyBarsPrice: number | undefined,
];
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ISeriesStudyResult


---

<!-- Public documentation export; not library implementation source. -->
# ISettingsAdapter

[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.

## initialSettings {#initialsettings}

```ts
initialSettings?: InitialSettingsMap;
```

Use the type signature above and the integration guide for the owning capability.

## setValue {#setvalue}

```ts
setValue(key: string, value: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |
| `value` | `string` | Yes |

## removeValue {#removevalue}

```ts
removeValue(key: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

## Related types

- [InitialSettingsMap](https://docs.lumencharts.com/charting-library/api/InitialSettingsMap)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ISettingsAdapter


---

<!-- Public documentation export; not library implementation source. -->
# IShapesGroupControllerApi

[Integration guide](https://docs.lumencharts.com/charting-library/drawings#selection-groups-and-ordering) · [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.

## createGroupFromSelection {#creategroupfromselection}

```ts
createGroupFromSelection(): ShapesGroupId;
```

Use the type signature above and the integration guide for the owning capability.

## removeGroup {#removegroup}

```ts
removeGroup(groupId: ShapesGroupId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## groups {#groups}

```ts
groups(): readonly ShapesGroupId[];
```

Use the type signature above and the integration guide for the owning capability.

## shapesInGroup {#shapesingroup}

```ts
shapesInGroup(groupId: ShapesGroupId): readonly EntityId[];
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## excludeShapeFromGroup {#excludeshapefromgroup}

```ts
excludeShapeFromGroup(groupId: ShapesGroupId, shapeId: EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |
| `shapeId` | `EntityId` | Yes |

## addShapeToGroup {#addshapetogroup}

```ts
addShapeToGroup(groupId: ShapesGroupId, shapeId: EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |
| `shapeId` | `EntityId` | Yes |

## availableZOrderOperations {#availablezorderoperations}

```ts
availableZOrderOperations(groupId: ShapesGroupId): AvailableZOrderOperations;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## bringToFront {#bringtofront}

```ts
bringToFront(groupId: ShapesGroupId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## sendToBack {#sendtoback}

```ts
sendToBack(groupId: ShapesGroupId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## bringForward {#bringforward}

```ts
bringForward(groupId: ShapesGroupId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## sendBackward {#sendbackward}

```ts
sendBackward(groupId: ShapesGroupId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## insertAfter {#insertafter}

```ts
insertAfter(groupId: ShapesGroupId, target: ShapesGroupId | EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |
| `target` | `ShapesGroupId &#124; EntityId` | Yes |

## insertBefore {#insertbefore}

```ts
insertBefore(groupId: ShapesGroupId, target: ShapesGroupId | EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |
| `target` | `ShapesGroupId &#124; EntityId` | Yes |

## setGroupVisibility {#setgroupvisibility}

```ts
setGroupVisibility(groupId: ShapesGroupId, value: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |
| `value` | `boolean` | Yes |

## groupVisibility {#groupvisibility}

```ts
groupVisibility(groupId: ShapesGroupId): GroupVisibilityState;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## setGroupLock {#setgrouplock}

```ts
setGroupLock(groupId: ShapesGroupId, value: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |
| `value` | `boolean` | Yes |

## groupLock {#grouplock}

```ts
groupLock(groupId: ShapesGroupId): GroupLockState;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## getGroupName {#getgroupname}

```ts
getGroupName(groupId: ShapesGroupId): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |

## setGroupName {#setgroupname}

```ts
setGroupName(groupId: ShapesGroupId, name: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `groupId` | `ShapesGroupId` | Yes |
| `name` | `string` | Yes |

## canBeGroupped {#canbegroupped}

```ts
canBeGroupped(shapes: readonly EntityId[]): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `shapes` | `readonly EntityId[]` | Yes |

## Related types

- [ShapesGroupId](https://docs.lumencharts.com/charting-library/api/ShapesGroupId)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [AvailableZOrderOperations](https://docs.lumencharts.com/charting-library/api/AvailableZOrderOperations)
- [GroupVisibilityState](https://docs.lumencharts.com/charting-library/api/GroupVisibilityState)
- [GroupLockState](https://docs.lumencharts.com/charting-library/api/GroupLockState)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IShapesGroupControllerApi


---

<!-- Public documentation export; not library implementation source. -->
# IStudyApi

[Integration guide](https://docs.lumencharts.com/charting-library/studies/) · [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 |

## getInputsInfo {#getinputsinfo}

```ts
getInputsInfo(): StudyInputInformation[];
```

Use the type signature above and the integration guide for the owning capability.

## getInputValues {#getinputvalues}

```ts
getInputValues(): StudyInputValueItem[];
```

Use the type signature above and the integration guide for the owning capability.

## setInputValues {#setinputvalues}

```ts
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}

```ts
getStyleInfo(): StudyStyleInfo;
```

Use the type signature above and the integration guide for the owning capability.

## getStyleValues {#getstylevalues}

```ts
getStyleValues(): StudyStyleValues;
```

Use the type signature above and the integration guide for the owning capability.

## 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.

## changePriceScale {#changepricescale}

```ts
changePriceScale(newPriceScale: StudyPriceScale | EntityId): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `newPriceScale` | `StudyPriceScale &#124; EntityId` | 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.

## applyOverrides {#applyoverrides}

```ts
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}

```ts
applyToEntireLayout(): void;
```

Use the type signature above and the integration guide for the owning capability.

## onDataLoaded {#ondataloaded}

```ts
onDataLoaded(): ISubscription<() => void>;
```

Use the type signature above and the integration guide for the owning capability.

## onStudyError {#onstudyerror}

```ts
onStudyError(): ISubscription<() => void>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputInformation](https://docs.lumencharts.com/charting-library/api/StudyInputInformation)
- [StudyInputValueItem](https://docs.lumencharts.com/charting-library/api/StudyInputValueItem)
- [StudyStyleInfo](https://docs.lumencharts.com/charting-library/api/StudyStyleInfo)
- [StudyStyleValues](https://docs.lumencharts.com/charting-library/api/StudyStyleValues)
- [StudyPriceScale](https://docs.lumencharts.com/charting-library/api/StudyPriceScale)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [SingleIndicatorOverrides](https://docs.lumencharts.com/charting-library/api/indicator-overrides#singleindicatoroverrides)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IStudyApi


---

<!-- Public documentation export; not library implementation source. -->
# ISubscription

[Integration guide](https://docs.lumencharts.com/charting-library/getting-started/lifecycle) · [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.

## subscribe {#subscribe}

```ts
subscribe(obj: object | null, member: TFunc, singleshot?: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `obj` | `object &#124; null` | Yes |
| `member` | `TFunc` | Yes |
| `singleshot` | `boolean` | No |

## unsubscribe {#unsubscribe}

```ts
unsubscribe(obj: object | null, member: TFunc): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `obj` | `object &#124; null` | Yes |
| `member` | `TFunc` | Yes |

## unsubscribeAll {#unsubscribeall}

```ts
unsubscribeAll(obj: object | null): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `obj` | `object &#124; null` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ISubscription


---

<!-- Public documentation export; not library implementation source. -->
# ISymbolInstrument

[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.

## periodBase {#periodbase}

```ts
periodBase: string;
```

Use the type signature above and the integration guide for the owning capability.

## tickerid {#tickerid}

```ts
tickerid: string;
```

Use the type signature above and the integration guide for the owning capability.

## currencyCode {#currencycode}

```ts
currencyCode?: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## unitId {#unitid}

```ts
unitId?: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## period {#period}

```ts
period: ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

## index {#index}

```ts
index: number;
```

Use the type signature above and the integration guide for the owning capability.

## time {#time}

```ts
time: number;
```

Use the type signature above and the integration guide for the owning capability.

## open {#open}

```ts
open: number;
```

Use the type signature above and the integration guide for the owning capability.

## high {#high}

```ts
high: number;
```

Use the type signature above and the integration guide for the owning capability.

## low {#low}

```ts
low: number;
```

Use the type signature above and the integration guide for the owning capability.

## close {#close}

```ts
close: number;
```

Use the type signature above and the integration guide for the owning capability.

## volume {#volume}

```ts
volume: number;
```

Use the type signature above and the integration guide for the owning capability.

## updatetime {#updatetime}

```ts
updatetime: number;
```

Use the type signature above and the integration guide for the owning capability.

## ticker {#ticker}

```ts
ticker: string;
```

Use the type signature above and the integration guide for the owning capability.

## resolution {#resolution}

```ts
resolution: string;
```

Use the type signature above and the integration guide for the owning capability.

## interval {#interval}

```ts
interval: number;
```

Use the type signature above and the integration guide for the owning capability.

## minTick {#mintick}

```ts
minTick: number;
```

Use the type signature above and the integration guide for the owning capability.

## isFirstBar {#isfirstbar}

```ts
isFirstBar: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## isLastBar {#islastbar}

```ts
isLastBar: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## isNewBar {#isnewbar}

```ts
isNewBar: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## isBarClosed {#isbarclosed}

```ts
isBarClosed: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## info {#info}

```ts
info?: LibrarySymbolInfo;
```

Use the type signature above and the integration guide for the owning capability.

## bartime {#bartime}

```ts
bartime(): number;
```

Use the type signature above and the integration guide for the owning capability.

## isdwm {#isdwm}

```ts
isdwm(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ISymbolInstrument


---

<!-- Public documentation export; not library implementation source. -->
# ISymbolValueFormatter

[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.

## format {#format}

```ts
format(price: number, signPositive?: boolean): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `price` | `number` | Yes |
| `signPositive` | `boolean` | No |

## formatChange {#formatchange}

```ts
formatChange?(
    currentPrice: number,
    prevPrice: number,
    signPositive?: boolean,
  ): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `currentPrice` | `number` | Yes |
| `prevPrice` | `number` | Yes |
| `signPositive` | `boolean` | No |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ISymbolValueFormatter


---

<!-- Public documentation export; not library implementation source. -->
# ITimeScaleApi

[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.

## coordinateToTime {#coordinatetotime}

```ts
coordinateToTime(x: number): number | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## barSpacingChanged {#barspacingchanged}

```ts
barSpacingChanged(): ISubscription<(newBarSpacing: number) => void>;
```

Use the type signature above and the integration guide for the owning capability.

## rightOffsetChanged {#rightoffsetchanged}

```ts
rightOffsetChanged(): ISubscription<(rightOffset: number) => void>;
```

Use the type signature above and the integration guide for the owning capability.

## setRightOffset {#setrightoffset}

```ts
setRightOffset(offset: number): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `offset` | `number` | Yes |

## setBarSpacing {#setbarspacing}

```ts
setBarSpacing(newBarSpacing: number): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `newBarSpacing` | `number` | Yes |

## barSpacing {#barspacing}

```ts
barSpacing(): number;
```

Use the type signature above and the integration guide for the owning capability.

## rightOffset {#rightoffset}

```ts
rightOffset(): number;
```

Use the type signature above and the integration guide for the owning capability.

## width {#width}

```ts
width(): number;
```

Use the type signature above and the integration guide for the owning capability.

## defaultRightOffset {#defaultrightoffset}

```ts
defaultRightOffset(): IWatchedValue<number>;
```

Use the type signature above and the integration guide for the owning capability.

## defaultRightOffsetPercentage {#defaultrightoffsetpercentage}

```ts
defaultRightOffsetPercentage(): IWatchedValue<number>;
```

Use the type signature above and the integration guide for the owning capability.

## usePercentageRightOffset {#usepercentagerightoffset}

```ts
usePercentageRightOffset(): IWatchedValue<boolean>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)
- [IWatchedValue](https://docs.lumencharts.com/charting-library/api/IWatchedValue)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ITimeScaleApi


---

<!-- Public documentation export; not library implementation source. -->
# ITimezoneApi

[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.

## availableTimezones {#availabletimezones}

```ts
availableTimezones(): readonly TimezoneInfo[];
```

Use the type signature above and the integration guide for the owning capability.

## getTimezone {#gettimezone}

```ts
getTimezone(): TimezoneInfo;
```

Use the type signature above and the integration guide for the owning capability.

## setTimezone {#settimezone}

```ts
setTimezone(
    timezone: TimezoneId | CustomTimezoneId,
    options?: UndoOptions,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `timezone` | `TimezoneId &#124; CustomTimezoneId` | Yes |
| `options` | `UndoOptions` | No |

## onTimezoneChanged {#ontimezonechanged}

```ts
onTimezoneChanged(): ISubscription<(timezone: TimezoneId) => void>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [TimezoneInfo](https://docs.lumencharts.com/charting-library/api/TimezoneInfo)
- [TimezoneId](https://docs.lumencharts.com/charting-library/api/TimezoneId)
- [CustomTimezoneId](https://docs.lumencharts.com/charting-library/api/CustomTimezoneId)
- [UndoOptions](https://docs.lumencharts.com/charting-library/api/UndoOptions)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ITimezoneApi


---

<!-- Public documentation export; not library implementation source. -->
# IUpdatableAction

[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.

## Extends

[IAction](https://docs.lumencharts.com/charting-library/api/IAction)

## update {#update}

```ts
update(options: Partial<OmitActionId<ActionOptions>>): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `options` | `Partial<OmitActionId<ActionOptions>>` | Yes |

## Related types

- [IAction](https://docs.lumencharts.com/charting-library/api/IAction)
- [OmitActionId](https://docs.lumencharts.com/charting-library/api/OmitActionId)
- [ActionOptions](https://docs.lumencharts.com/charting-library/api/ActionOptions)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IUpdatableAction


---

<!-- Public documentation export; not library implementation source. -->
# IWatchedValue

[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.

## Extends

[IWatchedValueReadonly](https://docs.lumencharts.com/charting-library/api/IWatchedValueReadonly), [IObservableValue](https://docs.lumencharts.com/charting-library/api/IObservableValue)

## setValue {#setvalue}

```ts
setValue(value: T, forceUpdate?: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `T` | Yes |
| `forceUpdate` | `boolean` | No |

## subscribe {#subscribe}

```ts
subscribe(
    callback: WatchedValueCallback<T>,
    options?: WatchedValueSubscribeOptions,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `WatchedValueCallback<T>` | Yes |
| `options` | `WatchedValueSubscribeOptions` | No |

## unsubscribe {#unsubscribe}

```ts
unsubscribe(callback?: WatchedValueCallback<T> | null): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `WatchedValueCallback<T> &#124; null` | No |

## Related types

- [IWatchedValueReadonly](https://docs.lumencharts.com/charting-library/api/IWatchedValueReadonly)
- [IObservableValue](https://docs.lumencharts.com/charting-library/api/IObservableValue)
- [WatchedValueCallback](https://docs.lumencharts.com/charting-library/api/WatchedValueCallback)
- [WatchedValueSubscribeOptions](https://docs.lumencharts.com/charting-library/api/WatchedValueSubscribeOptions)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IWatchedValue


---

<!-- Public documentation export; not library implementation source. -->
# IWatchedValueReadonly

[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.

## Extends

[IObservableValueReadOnly](https://docs.lumencharts.com/charting-library/api/IObservableValueReadOnly)

## subscribe {#subscribe}

```ts
subscribe(
    callback: (value: T) => void,
    options?: WatchedValueSubscribeOptions,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `(value: T) => void` | Yes |
| `options` | `WatchedValueSubscribeOptions` | No |

## unsubscribe {#unsubscribe}

```ts
unsubscribe(callback?: ((value: T) => void) | null): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `((value: T) => void) &#124; null` | No |

## when {#when}

```ts
when(callback: WatchedValueCallback<T>): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `WatchedValueCallback<T>` | Yes |

## Related types

- [IObservableValueReadOnly](https://docs.lumencharts.com/charting-library/api/IObservableValueReadOnly)
- [WatchedValueSubscribeOptions](https://docs.lumencharts.com/charting-library/api/WatchedValueSubscribeOptions)
- [WatchedValueCallback](https://docs.lumencharts.com/charting-library/api/WatchedValueCallback)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IWatchedValueReadonly


---

<!-- Public documentation export; not library implementation source. -->
# IWatchListApi

[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.

## defaultList {#defaultlist}

```ts
defaultList(): string[];
```

Use the type signature above and the integration guide for the owning capability.

## getList {#getlist}

```ts
getList(id?: string): string[] | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | No |

## getAllLists {#getalllists}

```ts
getAllLists(): WatchListSymbolListMap | null;
```

Use the type signature above and the integration guide for the owning capability.

## setActiveList {#setactivelist}

```ts
setActiveList(id: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `id` | `string` | Yes |

## getActiveListId {#getactivelistid}

```ts
getActiveListId(): string | null;
```

Use the type signature above and the integration guide for the owning capability.

## setList {#setlist}

```ts
setList(symbols: string[]): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `symbols` | `string[]` | Yes |

## updateList {#updatelist}

```ts
updateList(listId: string, symbols: string[]): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listId` | `string` | Yes |
| `symbols` | `string[]` | Yes |

## renameList {#renamelist}

```ts
renameList(listId: string, newName: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listId` | `string` | Yes |
| `newName` | `string` | Yes |

## createList {#createlist}

```ts
createList(listName?: string, symbols?: string[]): WatchListSymbolList | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listName` | `string` | No |
| `symbols` | `string[]` | No |

## saveList {#savelist}

```ts
saveList(list: WatchListSymbolList): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `list` | `WatchListSymbolList` | Yes |

## deleteList {#deletelist}

```ts
deleteList(listId: string): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listId` | `string` | Yes |

## onListChanged {#onlistchanged}

```ts
onListChanged(): ISubscription<WatchListSymbolListChangedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onActiveListChanged {#onactivelistchanged}

```ts
onActiveListChanged(): ISubscription<EmptyCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onListAdded {#onlistadded}

```ts
onListAdded(): ISubscription<WatchListSymbolListAddedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onListRemoved {#onlistremoved}

```ts
onListRemoved(): ISubscription<WatchListSymbolListRemovedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## onListRenamed {#onlistrenamed}

```ts
onListRenamed(): ISubscription<WatchListSymbolListRenamedCallback>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [WatchListSymbolListMap](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListMap)
- [WatchListSymbolList](https://docs.lumencharts.com/charting-library/api/WatchListSymbolList)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)
- [WatchListSymbolListChangedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListChangedCallback)
- [EmptyCallback](https://docs.lumencharts.com/charting-library/api/EmptyCallback)
- [WatchListSymbolListAddedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListAddedCallback)
- [WatchListSymbolListRemovedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRemovedCallback)
- [WatchListSymbolListRenamedCallback](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRenamedCallback)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IWatchListApi


---

<!-- Public documentation export; not library implementation source. -->
# IWatermarkApi

[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.

## color {#color}

```ts
color(): IWatchedValue<string>;
```

Use the type signature above and the integration guide for the owning capability.

## visibility {#visibility}

```ts
visibility(): IWatchedValue<boolean>;
```

Use the type signature above and the integration guide for the owning capability.

## setContentProvider {#setcontentprovider}

```ts
setContentProvider(provider: WatermarkContentProvider | null): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `provider` | `WatermarkContentProvider &#124; null` | Yes |

## Related types

- [IWatchedValue](https://docs.lumencharts.com/charting-library/api/IWatchedValue)
- [WatermarkContentProvider](https://docs.lumencharts.com/charting-library/api/WatermarkContentProvider)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IWatermarkApi


---

<!-- Public documentation export; not library implementation source. -->
# IWidgetbarApi

[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.

## Extends

[IDestroyable](https://docs.lumencharts.com/charting-library/api/IDestroyable)

## showPage {#showpage}

```ts
showPage(pageName: PageName): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `pageName` | `PageName` | Yes |

## hidePage {#hidepage}

```ts
hidePage(pageName: PageName): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `pageName` | `PageName` | Yes |

## isPageVisible {#ispagevisible}

```ts
isPageVisible(pageName: PageName): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `pageName` | `PageName` | Yes |

## openOrderPanel {#openorderpanel}

```ts
openOrderPanel(): void;
```

Use the type signature above and the integration guide for the owning capability.

## closeOrderPanel {#closeorderpanel}

```ts
closeOrderPanel(): void;
```

Use the type signature above and the integration guide for the owning capability.

## changeWidgetBarVisibility {#changewidgetbarvisibility}

```ts
changeWidgetBarVisibility(visible: boolean): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `visible` | `boolean` | Yes |

## Related types

- [IDestroyable](https://docs.lumencharts.com/charting-library/api/IDestroyable)
- [PageName](https://docs.lumencharts.com/charting-library/api/PageName)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IWidgetbarApi


---

<!-- Public documentation export; not library implementation source. -->
# KagiStylePreferences

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColor {#downcolor}

```ts
downColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## upColorProjection {#upcolorprojection}

```ts
upColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColorProjection {#downcolorprojection}

```ts
downColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/KagiStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# LanguageCode

[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.

```ts
export type LanguageCode =
  | "ar"
  | "zh"
  | "ca_ES"
  | "en"
  | "fr"
  | "de"
  | "he_IL"
  | "id_ID"
  | "it"
  | "ja"
  | "ko"
  | "pl"
  | "pt"
  | "ru"
  | "es"
  | "sv"
  | "th"
  | "tr"
  | "vi"
  | "ms_MY"
  | "zh_TW";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LanguageCode


---

<!-- Public documentation export; not library implementation source. -->
# LayoutType

[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.

```ts
export type LayoutType = SingleChartLayoutType | MultipleChartsLayoutType;
```

## Related types

- [SingleChartLayoutType](https://docs.lumencharts.com/charting-library/api/SingleChartLayoutType)
- [MultipleChartsLayoutType](https://docs.lumencharts.com/charting-library/api/MultipleChartsLayoutType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LayoutType


---

<!-- Public documentation export; not library implementation source. -->
# LegendMode

[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.

```ts
export type LegendMode = "horizontal" | "vertical";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LegendMode


---

<!-- Public documentation export; not library implementation source. -->
# LibraryPineStudy

[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.

## init {#init}

```ts
init?(
    ctx: IContext,
    inputs: <T extends StudyInputValue>(index: number) => T,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `ctx` | `IContext` | Yes |
| `inputs` | `<T extends StudyInputValue>(index: number) => T` | Yes |

## main {#main}

```ts
main(
    ctx: IContext,
    inputs: <T extends StudyInputValue>(index: number) => T,
  ): TPineStudyResult | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `ctx` | `IContext` | Yes |
| `inputs` | `<T extends StudyInputValue>(index: number) => T` | Yes |

## signature {#signature}

```ts
[key: string]: any;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

## Related types

- [IContext](https://docs.lumencharts.com/charting-library/api/IContext)
- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LibraryPineStudy


---

<!-- Public documentation export; not library implementation source. -->
# LibraryPineStudyConstructor

[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.

## signature {#signature}

```ts
new (): LibraryPineStudy<TPineStudyResult>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [LibraryPineStudy](https://docs.lumencharts.com/charting-library/api/LibraryPineStudy)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LibraryPineStudyConstructor


---

<!-- Public documentation export; not library implementation source. -->
# LibrarySessionId

[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.

```ts
export type LibrarySessionId =
  "regular" | "extended" | "premarket" | "postmarket";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LibrarySessionId


---

<!-- Public documentation export; not library implementation source. -->
# LibrarySubsessionInfo

[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.

## description {#description}

```ts
description: string;
```

Use the type signature above and the integration guide for the owning capability.

## id {#id}

```ts
id: LibrarySessionId;
```

Use the type signature above and the integration guide for the owning capability.

## session {#session}

```ts
session: string;
```

Use the type signature above and the integration guide for the owning capability.

## session-correction {#session-correction}

```ts
"session-correction"?: string;
```

Use the type signature above and the integration guide for the owning capability.

## session-display {#session-display}

```ts
"session-display"?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [LibrarySessionId](https://docs.lumencharts.com/charting-library/api/LibrarySessionId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LibrarySubsessionInfo


---

<!-- Public documentation export; not library implementation source. -->
# LibrarySymbolInfo

[Integration guide](https://docs.lumencharts.com/charting-library/datafeed#symbol-search-and-metadata) · [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.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## base_name {#base_name}

```ts
base_name?: [string];
```

Use the type signature above and the integration guide for the owning capability.

## ticker {#ticker}

```ts
ticker?: string;
```

Use the type signature above and the integration guide for the owning capability.

## description {#description}

```ts
description: string;
```

Use the type signature above and the integration guide for the owning capability.

## long_description {#long_description}

```ts
long_description?: string;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
type: string;
```

Use the type signature above and the integration guide for the owning capability.

## session {#session}

```ts
session: string;
```

Use the type signature above and the integration guide for the owning capability.

## session_display {#session_display}

```ts
session_display?: string;
```

Use the type signature above and the integration guide for the owning capability.

## session_holidays {#session_holidays}

```ts
session_holidays?: string;
```

Use the type signature above and the integration guide for the owning capability.

## corrections {#corrections}

```ts
corrections?: string;
```

Use the type signature above and the integration guide for the owning capability.

## exchange {#exchange}

```ts
exchange: string;
```

Use the type signature above and the integration guide for the owning capability.

## listed_exchange {#listed_exchange}

```ts
listed_exchange: string;
```

Use the type signature above and the integration guide for the owning capability.

## timezone {#timezone}

```ts
timezone: Timezone;
```

Use the type signature above and the integration guide for the owning capability.

## format {#format}

```ts
format: SeriesFormat;
```

Use the type signature above and the integration guide for the owning capability.

## pricescale {#pricescale}

```ts
pricescale: number;
```

Use the type signature above and the integration guide for the owning capability.

## minmov {#minmov}

```ts
minmov: number;
```

Use the type signature above and the integration guide for the owning capability.

## fractional {#fractional}

```ts
fractional?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## minmove2 {#minmove2}

```ts
minmove2?: number;
```

Use the type signature above and the integration guide for the owning capability.

## variable_tick_size {#variable_tick_size}

```ts
variable_tick_size?: string;
```

Use the type signature above and the integration guide for the owning capability.

## has_intraday {#has_intraday}

```ts
has_intraday?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## supported_resolutions {#supported_resolutions}

```ts
supported_resolutions?: ResolutionString[];
```

Use the type signature above and the integration guide for the owning capability.

## intraday_multipliers {#intraday_multipliers}

```ts
intraday_multipliers?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## has_seconds {#has_seconds}

```ts
has_seconds?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## has_ticks {#has_ticks}

```ts
has_ticks?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## seconds_multipliers {#seconds_multipliers}

```ts
seconds_multipliers?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## has_daily {#has_daily}

```ts
has_daily?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## daily_multipliers {#daily_multipliers}

```ts
daily_multipliers?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## has_weekly_and_monthly {#has_weekly_and_monthly}

```ts
has_weekly_and_monthly?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## weekly_multipliers {#weekly_multipliers}

```ts
weekly_multipliers?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## monthly_multipliers {#monthly_multipliers}

```ts
monthly_multipliers?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## has_empty_bars {#has_empty_bars}

```ts
has_empty_bars?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## visible_plots_set {#visible_plots_set}

```ts
visible_plots_set?: VisiblePlotsSet;
```

Use the type signature above and the integration guide for the owning capability.

## volume_precision {#volume_precision}

```ts
volume_precision?: number;
```

Use the type signature above and the integration guide for the owning capability.

## data_status {#data_status}

```ts
data_status?: "streaming" | "endofday" | "delayed_streaming";
```

Use the type signature above and the integration guide for the owning capability.

## delay {#delay}

```ts
delay?: number;
```

Use the type signature above and the integration guide for the owning capability.

## expired {#expired}

```ts
expired?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## expiration_date {#expiration_date}

```ts
expiration_date?: number;
```

Use the type signature above and the integration guide for the owning capability.

## sector {#sector}

```ts
sector?: string;
```

Use the type signature above and the integration guide for the owning capability.

## industry {#industry}

```ts
industry?: string;
```

Use the type signature above and the integration guide for the owning capability.

## currency_code {#currency_code}

```ts
currency_code?: string;
```

Use the type signature above and the integration guide for the owning capability.

## original_currency_code {#original_currency_code}

```ts
original_currency_code?: string;
```

Use the type signature above and the integration guide for the owning capability.

## unit_id {#unit_id}

```ts
unit_id?: string;
```

Use the type signature above and the integration guide for the owning capability.

## original_unit_id {#original_unit_id}

```ts
original_unit_id?: string;
```

Use the type signature above and the integration guide for the owning capability.

## unit_conversion_types {#unit_conversion_types}

```ts
unit_conversion_types?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## subsession_id {#subsession_id}

```ts
subsession_id?: string;
```

Use the type signature above and the integration guide for the owning capability.

## subsessions {#subsessions}

```ts
subsessions?: LibrarySubsessionInfo[];
```

Use the type signature above and the integration guide for the owning capability.

## price_source_id {#price_source_id}

```ts
price_source_id?: string;
```

Use the type signature above and the integration guide for the owning capability.

## price_sources {#price_sources}

```ts
price_sources?: SymbolInfoPriceSource[];
```

Use the type signature above and the integration guide for the owning capability.

## logo_urls {#logo_urls}

```ts
logo_urls?: [string] | [string, string];
```

Use the type signature above and the integration guide for the owning capability.

## exchange_logo {#exchange_logo}

```ts
exchange_logo?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [Timezone](https://docs.lumencharts.com/charting-library/api/Timezone)
- [SeriesFormat](https://docs.lumencharts.com/charting-library/api/SeriesFormat)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [VisiblePlotsSet](https://docs.lumencharts.com/charting-library/api/VisiblePlotsSet)
- [LibrarySubsessionInfo](https://docs.lumencharts.com/charting-library/api/LibrarySubsessionInfo)
- [SymbolInfoPriceSource](https://docs.lumencharts.com/charting-library/api/SymbolInfoPriceSource)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo


---

<!-- Public documentation export; not library implementation source. -->
# LineBreakStylePreferences

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColor {#downcolor}

```ts
downColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderUpColor {#borderupcolor}

```ts
borderUpColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderDownColor {#borderdowncolor}

```ts
borderDownColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## upColorProjection {#upcolorprojection}

```ts
upColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColorProjection {#downcolorprojection}

```ts
downColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderUpColorProjection {#borderupcolorprojection}

```ts
borderUpColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderDownColorProjection {#borderdowncolorprojection}

```ts
borderDownColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineBreakStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# LineStudyPlotStyle

[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.

```ts
declare enum LineStudyPlotStyle {
  Line = 0,
  Histogram = 1,
  Cross = 3,
  Area = 4,
  Columns = 5,
  Circles = 6,
  LineWithBreaks = 7,
  AreaWithBreaks = 8,
  StepLine = 9,
  StepLineWithDiamonds = 10,
  StepLineWithBreaks = 11,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineStudyPlotStyle


---

<!-- Public documentation export; not library implementation source. -->
# LineStudyPlotStyleName

[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.

```ts
export type LineStudyPlotStyleName =
  | "line"
  | "histogram"
  | "cross"
  | "area"
  | "columns"
  | "circles"
  | "line_with_breaks"
  | "area_with_breaks"
  | "step_line"
  | "step_line_with_breaks"
  | "step_line_with_diamonds";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineStudyPlotStyleName


---

<!-- Public documentation export; not library implementation source. -->
# LineStyle

[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.

```ts
declare enum LineStyle {
  Solid = 0,
  Dotted = 1,
  Dashed = 2,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineStyle


---

<!-- Public documentation export; not library implementation source. -->
# LineStylePreferences

[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.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## linestyle {#linestyle}

```ts
linestyle: number;
```

Use the type signature above and the integration guide for the owning capability.

## linewidth {#linewidth}

```ts
linewidth: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# LineToolsAndGroupsLoadRequestContext

[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.

## symbol {#symbol}

```ts
symbol?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsLoadRequestContext


---

<!-- Public documentation export; not library implementation source. -->
# LineToolsAndGroupsLoadRequestType

[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.

```ts
export type LineToolsAndGroupsLoadRequestType =
  | "allLineTools"
  | "lineToolsWithoutSymbol"
  | "studiesLineTools"
  | "mainSeriesLineTools";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsLoadRequestType


---

<!-- Public documentation export; not library implementation source. -->
# LineToolsAndGroupsState

[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.

## sources {#sources}

```ts
sources: Map<EntityId, LineToolState | null> | null;
```

Use the type signature above and the integration guide for the owning capability.

## groups {#groups}

```ts
groups: Map<string, LineToolsGroupState | null>;
```

Use the type signature above and the integration guide for the owning capability.

## symbol {#symbol}

```ts
symbol?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [LineToolState](https://docs.lumencharts.com/charting-library/api/LineToolState)
- [LineToolsGroupState](https://docs.lumencharts.com/charting-library/api/LineToolsGroupState)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineToolsAndGroupsState


---

<!-- Public documentation export; not library implementation source. -->
# LineToolsGroupState

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## symbol {#symbol}

```ts
symbol: string;
```

Use the type signature above and the integration guide for the owning capability.

## currencyId {#currencyid}

```ts
currencyId?: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## unitId {#unitid}

```ts
unitId?: string | null;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineToolsGroupState


---

<!-- Public documentation export; not library implementation source. -->
# LineToolState

[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.

## id {#id}

```ts
id: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## symbol {#symbol}

```ts
symbol?: string;
```

Use the type signature above and the integration guide for the owning capability.

## ownerSource {#ownersource}

```ts
ownerSource: string;
```

Use the type signature above and the integration guide for the owning capability.

## groupId {#groupid}

```ts
groupId?: string;
```

Use the type signature above and the integration guide for the owning capability.

## currencyId {#currencyid}

```ts
currencyId?: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## unitId {#unitid}

```ts
unitId?: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## state {#state}

```ts
state: unknown;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LineToolState


---

<!-- Public documentation export; not library implementation source. -->
# LoadingScreenOptions

[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.

## foregroundColor {#foregroundcolor}

```ts
foregroundColor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## backgroundColor {#backgroundcolor}

```ts
backgroundColor?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LoadingScreenOptions


---

<!-- Public documentation export; not library implementation source. -->
# LumenChartingLibraryFeatureset

[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.

```ts
export type LumenChartingLibraryFeatureset =
  | "chart_style_volume_footprint"
  | "use_localstorage_for_settings"
  | "items_favoriting"
  | "save_chart_properties_to_local_storage"
  | "create_volume_indicator_by_default"
  | "create_volume_indicator_by_default_once"
  | "volume_force_overlay"
  | "right_bar_stays_on_scroll"
  | "constraint_dialogs_movement"
  | "charting_library_debug_mode"
  | "side_toolbar_in_fullscreen_mode"
  | "header_in_fullscreen_mode"
  | "disable_resolution_rebuild"
  | "chart_scroll"
  | "chart_zoom"
  | "horz_touch_drag_scroll"
  | "vert_touch_drag_scroll"
  | "mouse_wheel_scroll"
  | "pressed_mouse_move_scroll"
  | "mouse_wheel_scale"
  | "pinch_scale"
  | "axis_pressed_mouse_move_scale"
  | "low_density_bars"
  | "uppercase_instrument_names"
  | "no_min_chart_width"
  | "fix_left_edge"
  | "lock_visible_time_range_on_resize"
  | "shift_visible_range_on_new_bar"
  | "custom_resolutions"
  | "end_of_period_timescale_marks"
  | "cropped_tick_marks"
  | "study_overlay_compare_legend_option"
  | "study_symbol_ticker_description"
  | "auto_enable_symbol_labels"
  | "insert_indicator_dialog_shortcut"
  | "two_character_bar_marks_labels"
  | "confirm_overwrite_if_chart_layout_with_name_exists"
  | "determine_first_data_request_size_using_visible_range"
  | "move_logo_to_main_pane"
  | "study_templates"
  | "datasource_copypaste"
  | "seconds_resolution"
  | "tick_resolution"
  | "secondary_series_extend_time_scale"
  | "header_widget"
  | "header_symbol_search"
  | "symbol_search_hot_key"
  | "header_resolutions"
  | "show_interval_dialog_on_key_press"
  | "header_chart_type"
  | "header_settings"
  | "header_indicators"
  | "header_compare"
  | "header_undo_redo"
  | "header_quick_search"
  | "header_screenshot"
  | "header_fullscreen_button"
  | "border_around_the_chart"
  | "header_saveload"
  
  | "header_save_status"
  | "left_toolbar"
  | "control_bar"
  | "timeframes_toolbar"
  | "legend_widget"
  | "display_legend_on_all_charts"
  | "object_tree_legend_mode"
  | "edit_buttons_in_legend"
  | "show_hide_button_in_legend"
  | "format_button_in_legend"
  | "delete_button_in_legend"
  | "context_menus"
  | "pane_context_menu"
  | "scales_context_menu"
  | "legend_context_menu"
  | "main_series_scale_menu"
  | "display_market_status"
  | "remove_library_container_border"
  | "property_pages"
  | "show_chart_property_page"
  | "chart_property_page_scales"
  | "chart_property_page_trading"
  | "chart_property_page_right_margin_editor"
  | "countdown"
  | "dont_show_boolean_study_arguments"
  | "hide_last_na_study_output"
  | "symbol_info"
  | "timezone_menu"
  | "snapshot_trading_drawings"
  | "source_selection_markers"
  | "go_to_date"
  | "adaptive_logo"
  | "show_dom_first_time"
  | "hide_left_toolbar_by_default"
  | "chart_style_hilo"
  | "chart_style_hilo_last_price"
  | "pricescale_currency"
  | "pricescale_unit"
  | "scales_date_format"
  | "popup_hints"
  | "save_shortcut"
  | "show_right_widgets_panel_by_default"
  | "show_object_tree"
  | "show_spread_operators"
  | "hide_exponentiation_spread_operator"
  | "hide_reciprocal_spread_operator"
  | "compare_symbol_search_spread_operators"
  | "studies_symbol_search_spread_operators"
  | "hide_resolution_in_legend"
  | "hide_unresolved_symbols_in_legend"
  | "show_zoom_and_move_buttons_on_touch"
  | "hide_main_series_symbol_from_indicator_legend"
  | "hide_price_scale_global_last_bar_value"
  | "show_average_close_price_line_and_label"
  | "hide_image_invalid_symbol"
  | "hide_object_tree_and_price_scale_exchange_label"
  | "scales_time_hours_format"
  | "use_na_string_for_not_available_values"
  | "pre_post_market_sessions"
  | "show_percent_option_for_right_margin"
  | "lock_visible_time_range_when_adjusting_percentage_right_margin"
  | "iframe_loading_compatibility_mode"
  | "use_last_visible_bar_value_in_legend"
  | "symbol_info_long_description"
  | "symbol_info_price_source"
  | "chart_template_storage"
  | "request_only_visible_range_on_reset"
  | "clear_price_scale_on_error_or_empty_bars"
  
  | "series_data_error_overlay"
  | "legend_inplace_edit"
  | "show_symbol_logos"
  | "show_exchange_logos"
  | "show_symbol_logo_in_legend"
  | "show_symbol_logo_for_compare_studies"
  | "always_show_legend_values_on_mobile"
  | "studies_extend_time_scale"
  | "accessible_keyboard_shortcuts"
  | "accessibility"
  | "aria_detailed_chart_descriptions"
  | "aria_crosshair_price_description"
  | "saveload_separate_drawings_storage";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LumenChartingLibraryFeatureset


---

<!-- Public documentation export; not library implementation source. -->
# LumenChartingLibraryWidgetOptions

[Integration guide](https://docs.lumencharts.com/charting-library/configuration/) · [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.

## container {#container}

```ts
container: HTMLElement | string;
```

Use the type signature above and the integration guide for the owning capability.

## datafeed {#datafeed}

```ts
datafeed: IBasicDataFeed | (IBasicDataFeed & IDatafeedQuotesApi);
```

Use the type signature above and the integration guide for the owning capability.

## interval {#interval}

```ts
interval: ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

## symbol {#symbol}

```ts
symbol?: string;
```

Use the type signature above and the integration guide for the owning capability.

## auto_save_delay {#auto_save_delay}

```ts
auto_save_delay?: number;
```

Use the type signature above and the integration guide for the owning capability.

## pine_script {#pine_script}

```ts
pine_script?: PineScriptWidgetOptions;
```

Opt-in native Pine v5/v6 indicator execution and editor configuration.

## autosize {#autosize}

```ts
autosize?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## debug {#debug}

```ts
debug?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## disabled_features {#disabled_features}

```ts
disabled_features?: LumenChartingLibraryFeatureset[];
```

Use the type signature above and the integration guide for the owning capability.

## drawings_access {#drawings_access}

```ts
drawings_access?: AccessList;
```

Use the type signature above and the integration guide for the owning capability.

## enabled_features {#enabled_features}

```ts
enabled_features?: LumenChartingLibraryFeatureset[];
```

Use the type signature above and the integration guide for the owning capability.

## ai_commands {#ai_commands}

```ts
ai_commands?: AiCommandsOptions;
```

Programmatic command families that hosts (for example an AI assistant) can
drive through the chart's command APIs. Every family is on when omitted;
set one to `false` to switch it off.

- `inspection`: capability schema and exact-ID reads of drawings, studies and the chart.
- `drawingSettings`: `settings`, `reset` and local `ref` names (create, then group in the same batch) on drawing batches. Needs `inspection`.
- `studies`: study command changes and study inspection. Study save and restore keep working.
- `chartSettings`: chart type and main price scale commands. Needs `inspection`.

Unknown keys or non-boolean values are rejected when the widget is created.

Example:
```javascript
ai_commands: { chartSettings: false },
```

## fullscreen {#fullscreen}

```ts
fullscreen?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## library_path {#library_path}

```ts
library_path?: string;
```

Use the type signature above and the integration guide for the owning capability.

## locale {#locale}

```ts
locale: LanguageCode;
```

Use the type signature above and the integration guide for the owning capability.

## numeric_formatting {#numeric_formatting}

```ts
numeric_formatting?: NumericFormattingParams;
```

Use the type signature above and the integration guide for the owning capability.

## saved_data {#saved_data}

```ts
saved_data?: object;
```

Use the type signature above and the integration guide for the owning capability.

## saved_data_meta_info {#saved_data_meta_info}

```ts
saved_data_meta_info?: SavedStateMetaInfo;
```

Use the type signature above and the integration guide for the owning capability.

## studies_access {#studies_access}

```ts
studies_access?: AccessList;
```

Use the type signature above and the integration guide for the owning capability.

## study_count_limit {#study_count_limit}

```ts
study_count_limit?: number;
```

Use the type signature above and the integration guide for the owning capability.

## symbol_search_request_delay {#symbol_search_request_delay}

```ts
symbol_search_request_delay?: number;
```

Use the type signature above and the integration guide for the owning capability.

## timeframe {#timeframe}

```ts
timeframe?: TimeframeOption;
```

Use the type signature above and the integration guide for the owning capability.

## timezone {#timezone}

```ts
timezone?: "exchange" | Timezone;
```

Use the type signature above and the integration guide for the owning capability.

## toolbar_bg {#toolbar_bg}

```ts
toolbar_bg?: string;
```

Use the type signature above and the integration guide for the owning capability.

## width {#width}

```ts
width?: number;
```

Use the type signature above and the integration guide for the owning capability.

## height {#height}

```ts
height?: number;
```

Use the type signature above and the integration guide for the owning capability.

## charts_storage_url {#charts_storage_url}

```ts
charts_storage_url?: string;
```

Use the type signature above and the integration guide for the owning capability.

## charts_storage_api_version {#charts_storage_api_version}

```ts
charts_storage_api_version?: AvailableSaveloadVersions;
```

Use the type signature above and the integration guide for the owning capability.

## client_id {#client_id}

```ts
client_id?: string;
```

Use the type signature above and the integration guide for the owning capability.

## user_id {#user_id}

```ts
user_id?: string;
```

Use the type signature above and the integration guide for the owning capability.

## load_last_chart {#load_last_chart}

```ts
load_last_chart?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## studies_overrides {#studies_overrides}

```ts
studies_overrides?: Partial<StudyOverrides>;
```

Use the type signature above and the integration guide for the owning capability.

## custom_formatters {#custom_formatters}

```ts
custom_formatters?: CustomFormatters;
```

Use the type signature above and the integration guide for the owning capability.

## overrides {#overrides}

```ts
overrides?: Partial<WidgetOverrides>;
```

Use the type signature above and the integration guide for the owning capability.

## snapshot_url {#snapshot_url}

```ts
snapshot_url?: string;
```

Use the type signature above and the integration guide for the owning capability.

## time_frames {#time_frames}

```ts
time_frames?: TimeFrameItem[];
```

Use the type signature above and the integration guide for the owning capability.

## custom_css_url {#custom_css_url}

```ts
custom_css_url?: string;
```

Use the type signature above and the integration guide for the owning capability.

## custom_font_family {#custom_font_family}

```ts
custom_font_family?: string;
```

Use the type signature above and the integration guide for the owning capability.

## favorites {#favorites}

```ts
favorites?: Favorites<ChartTypeFavorites>;
```

Use the type signature above and the integration guide for the owning capability.

## save_load_adapter {#save_load_adapter}

```ts
save_load_adapter?: IExternalSaveLoadAdapter;
```

Use the type signature above and the integration guide for the owning capability.

## loading_screen {#loading_screen}

```ts
loading_screen?: LoadingScreenOptions;
```

Use the type signature above and the integration guide for the owning capability.

## settings_adapter {#settings_adapter}

```ts
settings_adapter?: ISettingsAdapter;
```

Use the type signature above and the integration guide for the owning capability.

## theme {#theme}

```ts
theme?: ThemeName;
```

Use the type signature above and the integration guide for the owning capability.

## compare_symbols {#compare_symbols}

```ts
compare_symbols?: CompareSymbol[];
```

Use the type signature above and the integration guide for the owning capability.

## custom_indicators_getter {#custom_indicators_getter}

```ts
custom_indicators_getter?: (
    PineJS: PineJS,
  ) => Promise<readonly CustomIndicator[]>;
```

Use the type signature above and the integration guide for the owning capability.

## additional_symbol_info_fields {#additional_symbol_info_fields}

```ts
additional_symbol_info_fields?: AdditionalSymbolInfoField[];
```

Use the type signature above and the integration guide for the owning capability.

## header_widget_buttons_mode {#header_widget_buttons_mode}

```ts
header_widget_buttons_mode?: HeaderWidgetButtonsMode;
```

Use the type signature above and the integration guide for the owning capability.

## context_menu {#context_menu}

```ts
context_menu?: ContextMenuOptions;
```

Use the type signature above and the integration guide for the owning capability.

## time_scale {#time_scale}

```ts
time_scale?: TimeScaleOptions;
```

Use the type signature above and the integration guide for the owning capability.

## custom_translate_function {#custom_translate_function}

```ts
custom_translate_function?: CustomTranslateFunction;
```

Use the type signature above and the integration guide for the owning capability.

## symbol_search_complete {#symbol_search_complete}

```ts
symbol_search_complete?: SymbolSearchCompleteOverrideFunction;
```

Use the type signature above and the integration guide for the owning capability.

## settings_overrides {#settings_overrides}

```ts
settings_overrides?: Overrides;
```

Use the type signature above and the integration guide for the owning capability.

## custom_timezones {#custom_timezones}

```ts
custom_timezones?: CustomAliasedTimezone[];
```

Use the type signature above and the integration guide for the owning capability.

## custom_chart_description_function {#custom_chart_description_function}

```ts
custom_chart_description_function?: ChartDescriptorFunction;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [IBasicDataFeed](https://docs.lumencharts.com/charting-library/api/IBasicDataFeed)
- [IDatafeedQuotesApi](https://docs.lumencharts.com/charting-library/api/IDatafeedQuotesApi)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [PineScriptWidgetOptions](https://docs.lumencharts.com/charting-library/api/PineScriptWidgetOptions)
- [LumenChartingLibraryFeatureset](https://docs.lumencharts.com/charting-library/api/LumenChartingLibraryFeatureset)
- [AccessList](https://docs.lumencharts.com/charting-library/api/AccessList)
- [LanguageCode](https://docs.lumencharts.com/charting-library/api/LanguageCode)
- [NumericFormattingParams](https://docs.lumencharts.com/charting-library/api/NumericFormattingParams)
- [SavedStateMetaInfo](https://docs.lumencharts.com/charting-library/api/SavedStateMetaInfo)
- [TimeframeOption](https://docs.lumencharts.com/charting-library/api/TimeframeOption)
- [Timezone](https://docs.lumencharts.com/charting-library/api/Timezone)
- [AvailableSaveloadVersions](https://docs.lumencharts.com/charting-library/api/AvailableSaveloadVersions)
- [StudyOverrides](https://docs.lumencharts.com/charting-library/api/StudyOverrides)
- [CustomFormatters](https://docs.lumencharts.com/charting-library/api/CustomFormatters)
- [WidgetOverrides](https://docs.lumencharts.com/charting-library/api/WidgetOverrides)
- [TimeFrameItem](https://docs.lumencharts.com/charting-library/api/TimeFrameItem)
- [Favorites](https://docs.lumencharts.com/charting-library/api/Favorites)
- [ChartTypeFavorites](https://docs.lumencharts.com/charting-library/api/ChartTypeFavorites)
- [IExternalSaveLoadAdapter](https://docs.lumencharts.com/charting-library/api/IExternalSaveLoadAdapter)
- [LoadingScreenOptions](https://docs.lumencharts.com/charting-library/api/LoadingScreenOptions)
- [ISettingsAdapter](https://docs.lumencharts.com/charting-library/api/ISettingsAdapter)
- [ThemeName](https://docs.lumencharts.com/charting-library/api/ThemeName)
- [CompareSymbol](https://docs.lumencharts.com/charting-library/api/CompareSymbol)
- [PineJS](https://docs.lumencharts.com/charting-library/api/PineJS)
- [CustomIndicator](https://docs.lumencharts.com/charting-library/api/CustomIndicator)
- [AdditionalSymbolInfoField](https://docs.lumencharts.com/charting-library/api/AdditionalSymbolInfoField)
- [HeaderWidgetButtonsMode](https://docs.lumencharts.com/charting-library/api/HeaderWidgetButtonsMode)
- [ContextMenuOptions](https://docs.lumencharts.com/charting-library/api/ContextMenuOptions)
- [TimeScaleOptions](https://docs.lumencharts.com/charting-library/api/TimeScaleOptions)
- [CustomTranslateFunction](https://docs.lumencharts.com/charting-library/api/CustomTranslateFunction)
- [SymbolSearchCompleteOverrideFunction](https://docs.lumencharts.com/charting-library/api/SymbolSearchCompleteOverrideFunction)
- [Overrides](https://docs.lumencharts.com/charting-library/api/Overrides)
- [CustomAliasedTimezone](https://docs.lumencharts.com/charting-library/api/CustomAliasedTimezone)
- [ChartDescriptorFunction](https://docs.lumencharts.com/charting-library/api/ChartDescriptorFunction)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LumenChartingLibraryWidgetOptions


---

<!-- Public documentation export; not library implementation source. -->
# MappedObject

[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.

## signature {#signature}

```ts
[key: string]: TValue | undefined;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MappedObject


---

<!-- Public documentation export; not library implementation source. -->
# Mark

[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.

## id {#id}

```ts
id: string | number;
```

Use the type signature above and the integration guide for the owning capability.

## time {#time}

```ts
time: number;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: MarkConstColors | MarkCustomColor;
```

Use the type signature above and the integration guide for the owning capability.

## text {#text}

```ts
text: string;
```

Use the type signature above and the integration guide for the owning capability.

## label {#label}

```ts
label: string;
```

Use the type signature above and the integration guide for the owning capability.

## labelFontColor {#labelfontcolor}

```ts
labelFontColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## minSize {#minsize}

```ts
minSize: number;
```

Use the type signature above and the integration guide for the owning capability.

## borderWidth {#borderwidth}

```ts
borderWidth?: number;
```

Use the type signature above and the integration guide for the owning capability.

## hoveredBorderWidth {#hoveredborderwidth}

```ts
hoveredBorderWidth?: number;
```

Use the type signature above and the integration guide for the owning capability.

## imageUrl {#imageurl}

```ts
imageUrl?: string;
```

Use the type signature above and the integration guide for the owning capability.

## showLabelWhenImageLoaded {#showlabelwhenimageloaded}

```ts
showLabelWhenImageLoaded?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [MarkConstColors](https://docs.lumencharts.com/charting-library/api/MarkConstColors)
- [MarkCustomColor](https://docs.lumencharts.com/charting-library/api/MarkCustomColor)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/Mark


---

<!-- Public documentation export; not library implementation source. -->
# MarkConstColors

[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.

```ts
export type MarkConstColors = "red" | "green" | "blue" | "yellow";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MarkConstColors


---

<!-- Public documentation export; not library implementation source. -->
# MarkCustomColor

[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.

## border {#border}

```ts
border: string;
```

Use the type signature above and the integration guide for the owning capability.

## background {#background}

```ts
background: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MarkCustomColor


---

<!-- Public documentation export; not library implementation source. -->
# MarketStatus

[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.

```ts
export declare const enum MarketStatus {
  Open = "market",
  Pre = "pre_market",
  Post = "post_market",
  Close = "out_of_session",
  Holiday = "holiday",
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MarketStatus


---

<!-- Public documentation export; not library implementation source. -->
# MarkLocation

[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.

```ts
declare enum MarkLocation {
  AboveBar = "AboveBar",
  BelowBar = "BelowBar",
  Top = "Top",
  Bottom = "Bottom",
  Right = "Right",
  Left = "Left",
  Absolute = "Absolute",
  AbsoluteUp = "AbsoluteUp",
  AbsoluteDown = "AbsoluteDown",
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MarkLocation


---

<!-- Public documentation export; not library implementation source. -->
# MenuItemType

[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.

```ts
export declare const enum MenuItemType {
  Separator = "separator",
  Action = "action",
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MenuItemType


---

<!-- Public documentation export; not library implementation source. -->
# MouseEventParams

[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.

## clientX {#clientx}

```ts
clientX: number;
```

Use the type signature above and the integration guide for the owning capability.

## clientY {#clienty}

```ts
clientY: number;
```

Use the type signature above and the integration guide for the owning capability.

## pageX {#pagex}

```ts
pageX: number;
```

Use the type signature above and the integration guide for the owning capability.

## pageY {#pagey}

```ts
pageY: number;
```

Use the type signature above and the integration guide for the owning capability.

## screenX {#screenx}

```ts
screenX: number;
```

Use the type signature above and the integration guide for the owning capability.

## screenY {#screeny}

```ts
screenY: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MouseEventParams


---

<!-- Public documentation export; not library implementation source. -->
# MultipleChartsLayoutType

[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.

```ts
export type MultipleChartsLayoutType =
  | "2h"
  | "2v"
  | "2-1"
  | "3s"
  | "3h"
  | "3v"
  | "4"
  | "6"
  | "8"
  | "1-2"
  | "3r"
  | "4h"
  | "4v"
  | "4s"
  | "5h"
  | "6h"
  | "7h"
  | "8h"
  | "1-3"
  | "2-2"
  | "2-3"
  | "1-4"
  | "5s"
  | "6c"
  | "8c";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/MultipleChartsLayoutType


---

<!-- Public documentation export; not library implementation source. -->
# Nominal

[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.

```ts
export declare type Nominal<T, Name extends string> = T & {
 [Symbol.species]: Name;
};
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/Nominal


---

<!-- Public documentation export; not library implementation source. -->
# NumericFormattingParams

[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.

## decimal_sign {#decimal_sign}

```ts
decimal_sign: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/NumericFormattingParams


---

<!-- Public documentation export; not library implementation source. -->
# OmitActionId

[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.

```ts
export type OmitActionId<
  T extends {
    actionId: ActionId;
  },
> = Omit<T, "actionId">;
```

## Related types

- [ActionId](https://docs.lumencharts.com/charting-library/api/ActionId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OmitActionId


---

<!-- Public documentation export; not library implementation source. -->
# OnActionExecuteHandler

[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.

```ts
export type OnActionExecuteHandler = (action: IAction) => void;
```

## Related types

- [IAction](https://docs.lumencharts.com/charting-library/api/IAction)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OnActionExecuteHandler


---

<!-- Public documentation export; not library implementation source. -->
# OnActionUpdateHandler

[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.

```ts
export type OnActionUpdateHandler = (action: IAction) => void;
```

## Related types

- [IAction](https://docs.lumencharts.com/charting-library/api/IAction)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OnActionUpdateHandler


---

<!-- Public documentation export; not library implementation source. -->
# OnReadyCallback

[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.

```ts
export type OnReadyCallback = (configuration: DatafeedConfiguration) => void;
```

## Related types

- [DatafeedConfiguration](https://docs.lumencharts.com/charting-library/api/DatafeedConfiguration)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OnReadyCallback


---

<!-- Public documentation export; not library implementation source. -->
# OpenChartAutomationOptions

[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.

Options for `IChartWidgetApi.openAutomation()`. SDK types come from the
`@lumencharts/chart-automation/sdk` and `@lumencharts/chart-automation/contracts`.

## commands {#commands}

```ts
commands?: readonly ChartAutomationFamily[];
```

Native families to install. Defaults to every chart-level family; host-disabled families stay `unsupported`.
A family listed in `owners` must also be listed here when this is given, or opening rejects with `invalid_input`.

## owners {#owners}

```ts
owners?: ChartAutomationOwners;
```

Adopt existing owners instead of building new ones, so SDK changes share
their leases, Undo and persistence. Keep one mutating owner per chart per
family: a second session on the same chart should pass the same owners.

## policy {#policy}

```ts
policy?: AutomationPolicy;
```

Use the type signature above and the integration guide for the owning capability.

## chartId {#chartid}

```ts
chartId?: string;
```

Stable ID used as the request target. Defaults to the runtime's chart ID.

## binding {#binding}

```ts
binding?: ChartBinding;
```

Persistence identity for native document owners. Defaults to a session-local identity.

## capturePng {#capturepng}

```ts
capturePng?: (() => Promise<string | Blob>) | null;
```

Replaces the built-in exact-chart capture; `null` turns capture off.

## requestHistory {#requesthistory}

```ts
requestHistory?: NativeChartAutomationOptions['requestHistory'];
```

Use the type signature above and the integration guide for the owning capability.

## additionalData {#additionaldata}

```ts
additionalData?: NativeChartAutomationOptions['additionalData'];
```

Use the type signature above and the integration guide for the owning capability.

## subscribeAdditionalData {#subscribeadditionaldata}

```ts
subscribeAdditionalData?: NativeChartAutomationOptions['subscribeAdditionalData'];
```

Use the type signature above and the integration guide for the owning capability.

## workspace {#workspace}

```ts
workspace?: ChartWorkspaceApi;
```

A widget-level workspace owner (`widget.createWorkspaceCommands`); the caller keeps ownership.

## persist {#persist}

```ts
persist?: NativeCommandOwners['persist'];
```

Durable save between native preparation and commit for drawing and study changes.

## Related types

- [ChartAutomationFamily](https://docs.lumencharts.com/charting-library/api/ChartAutomationFamily)
- [ChartAutomationOwners](https://docs.lumencharts.com/charting-library/api/ChartAutomationOwners)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OpenChartAutomationOptions


---

<!-- Public documentation export; not library implementation source. -->
# OrderLineLengthUnit

[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.

```ts
export type OrderLineLengthUnit = "pixel" | "percentage";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OrderLineLengthUnit


---

<!-- Public documentation export; not library implementation source. -->
# OverrideLineStyle

[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.

```ts
export declare const enum OverrideLineStyle {
  Solid = 0,
  Dotted = 1,
  Dashed = 2,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OverrideLineStyle


---

<!-- Public documentation export; not library implementation source. -->
# OverridePriceAxisLastValueMode

[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.

```ts
export declare const enum OverridePriceAxisLastValueMode {
  LastPriceAndPercentageValue = 0,
  LastValueAccordingToScale = 1,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/OverridePriceAxisLastValueMode


---

<!-- Public documentation export; not library implementation source. -->
# Overrides

[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.

## signature {#signature}

```ts
[key: string]: string | number | boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/Overrides


---

<!-- Public documentation export; not library implementation source. -->
# PageName

[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.

```ts
export type PageName = "watchlist_details_news" | "data_window" | "object_tree";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PageName


---

<!-- Public documentation export; not library implementation source. -->
# PeriodParams

[Integration guide](https://docs.lumencharts.com/charting-library/datafeed/history) · [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.

## from {#from}

```ts
from: number;
```

Use the type signature above and the integration guide for the owning capability.

## to {#to}

```ts
to: number;
```

Use the type signature above and the integration guide for the owning capability.

## countBack {#countback}

```ts
countBack: number;
```

Use the type signature above and the integration guide for the owning capability.

## firstDataRequest {#firstdatarequest}

```ts
firstDataRequest: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PeriodParams


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertConditionMeta

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## kind {#kind}

```ts
kind: "alert-call" | "alertcondition";
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title: string;
```

Use the type signature above and the integration guide for the owning capability.

## message {#message}

```ts
message: string;
```

Use the type signature above and the integration guide for the owning capability.

## line {#line}

```ts
line: number;
```

Use the type signature above and the integration guide for the owning capability.

## column {#column}

```ts
column: number;
```

Use the type signature above and the integration guide for the owning capability.

## endLine {#endline}

```ts
endLine: number;
```

Use the type signature above and the integration guide for the owning capability.

## endColumn {#endcolumn}

```ts
endColumn: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertConditionMeta


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertDeliveryProvider

[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.

## deliver {#deliver}

```ts
deliver(
    request: { channelId: string; deliveryId: string; event: PineAlertEvent },
    options: { signal: AbortSignal },
  ): Promise<PineAlertDeliveryReceipt>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `{ channelId: string; deliveryId: string; event: PineAlertEvent }` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## Related types

- [PineAlertEvent](https://docs.lumencharts.com/charting-library/api/PineAlertEvent)
- [PineAlertDeliveryReceipt](https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryReceipt)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryProvider


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertDeliveryReceipt

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## deliveredAt {#deliveredat}

```ts
deliveredAt: number;
```

Use the type signature above and the integration guide for the owning capability.

## metadata {#metadata}

```ts
metadata?: Readonly<Record<string, unknown>>;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryReceipt


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertDeliveryStatus

[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.

## deliveryId {#deliveryid}

```ts
deliveryId: string;
```

Use the type signature above and the integration guide for the owning capability.

## state {#state}

```ts
state: "pending" | "delivered" | "failed" | "cancelled";
```

Use the type signature above and the integration guide for the owning capability.

## receipt {#receipt}

```ts
receipt?: PineAlertDeliveryReceipt;
```

Use the type signature above and the integration guide for the owning capability.

## error {#error}

```ts
error?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineAlertDeliveryReceipt](https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryReceipt)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryStatus


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertEvent

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## ruleId {#ruleid}

```ts
ruleId: string;
```

Use the type signature above and the integration guide for the owning capability.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## conditionId {#conditionid}

```ts
conditionId: string;
```

Use the type signature above and the integration guide for the owning capability.

## message {#message}

```ts
message: string;
```

Use the type signature above and the integration guide for the owning capability.

## time {#time}

```ts
time: number;
```

Use the type signature above and the integration guide for the owning capability.

## barIndex {#barindex}

```ts
barIndex: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertEvent


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertFrequency

[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.

```ts
export type PineAlertFrequency = "all" | "once-per-bar" | "once-per-bar-close";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertFrequency


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertRule

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## conditionId {#conditionid}

```ts
conditionId: string;
```

Use the type signature above and the integration guide for the owning capability.

## enabled {#enabled}

```ts
enabled: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## frequency {#frequency}

```ts
frequency: PineAlertFrequency;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## createdAt {#createdat}

```ts
createdAt: number;
```

Use the type signature above and the integration guide for the owning capability.

## warning {#warning}

```ts
warning?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [PineAlertFrequency](https://docs.lumencharts.com/charting-library/api/PineAlertFrequency)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertRule


---

<!-- Public documentation export; not library implementation source. -->
# PineAlertRuleInput

[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.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## conditionId {#conditionid}

```ts
conditionId: string;
```

Use the type signature above and the integration guide for the owning capability.

## enabled {#enabled}

```ts
enabled?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## frequency {#frequency}

```ts
frequency?: PineAlertFrequency;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [PineAlertFrequency](https://docs.lumencharts.com/charting-library/api/PineAlertFrequency)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineAlertRuleInput


---

<!-- Public documentation export; not library implementation source. -->
# PineChartQualifiedSource

[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.

## kind {#kind}

```ts
kind: "chart-study-output";
```

Use the type signature above and the integration guide for the owning capability.

## chartId {#chartid}

```ts
chartId: string;
```

Use the type signature above and the integration guide for the owning capability.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## outputId {#outputid}

```ts
outputId: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineChartQualifiedSource


---

<!-- Public documentation export; not library implementation source. -->
# PineChartRuntimeApi

[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.

## chartEpoch {#chartepoch}

```ts
chartEpoch(): number;
```

Use the type signature above and the integration guide for the owning capability.

## compile {#compile}

```ts
compile(
    source: string,
    options?: { signal?: AbortSignal },
  ): Promise<PineScriptCompileResult>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `string` | Yes |
| `options` | `{ signal?: AbortSignal }` | No |

## run {#run}

```ts
run(input: {
    source: string;
    sourceHash: string;
    studyId?: string | null;
  }): Promise<{
    chartEpoch: number;
    compile: PineScriptCompileResult;
    sourceHash: string;
    strategyReportBaseline: {
      revision: number;
      studyId: string | null;
    };
    studyId: string;
  }>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `input` | `{     source: string;     sourceHash: string;     studyId?: string &#124; null;   }` | Yes |

## remove {#remove}

```ts
remove(studyId: string): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |

## getExecutionProgress {#getexecutionprogress}

```ts
getExecutionProgress(studyId: string): PineExecutionProgress | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |

## getStrategyReport {#getstrategyreport}

```ts
getStrategyReport(studyId: string): PineStrategyReport | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |

## getStrategySnapshot {#getstrategysnapshot}

```ts
getStrategySnapshot(studyId: string): {
    report: PineStrategyReport;
    revision: number;
  } | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |

## getLogSnapshot {#getlogsnapshot}

```ts
getLogSnapshot(studyId: string): { logs: PineLogPage; revision: number } | null;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |

## subscribeLogs {#subscribelogs}

```ts
subscribeLogs(studyId: string, listener: (change: { revision: number; logs: PineLogPage | null }) => void): () => void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |
| `listener` | `(change: { revision: number; logs: PineLogPage &#124; null }) => void` | Yes |

## readLogPage {#readlogpage}

```ts
readLogPage(studyId: string, cursor: PineLogCursor, options?: { signal?: AbortSignal }): Promise<PineLogPage>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |
| `cursor` | `PineLogCursor` | Yes |
| `options` | `{ signal?: AbortSignal }` | No |

## focusLogBar {#focuslogbar}

```ts
focusLogBar(studyId: string, barOpenTimeMs: number): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |
| `barOpenTimeMs` | `number` | Yes |

## subscribeExecutionProgress {#subscribeexecutionprogress}

```ts
subscribeExecutionProgress(
    studyId: string,
    listener: (progress: PineExecutionProgress) => void,
  ): () => void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |
| `listener` | `(progress: PineExecutionProgress) => void` | Yes |

## subscribeStrategyReport {#subscribestrategyreport}

```ts
subscribeStrategyReport(
    studyId: string,
    listener: (change: {
      revision: number;
      report: PineStrategyReport;
    }) => void,
  ): () => void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |
| `listener` | `(change: {       revision: number;       report: PineStrategyReport;     }) => void` | Yes |

## focusStrategyTrade {#focusstrategytrade}

```ts
focusStrategyTrade(studyId: string, tradeId: string): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `studyId` | `string` | Yes |
| `tradeId` | `string` | Yes |

## Related types

- [PineScriptCompileResult](https://docs.lumencharts.com/charting-library/api/PineScriptCompileResult)
- [PineStrategyReport](https://docs.lumencharts.com/charting-library/api/PineStrategyReport)
- [PineLogPage](https://docs.lumencharts.com/charting-library/api/PineLogPage)
- [PineLogCursor](https://docs.lumencharts.com/charting-library/api/PineLogCursor)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineChartRuntimeApi


---

<!-- Public documentation export; not library implementation source. -->
# PineDocumentKind

[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.

```ts
export type PineDocumentKind = "indicator" | "library" | "strategy";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineDocumentKind


---

<!-- Public documentation export; not library implementation source. -->
# PineEditorActionOptions

[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.

## alerts {#alerts}

```ts
alerts?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## apply_to_chart {#apply_to_chart}

```ts
apply_to_chart?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## check {#check}

```ts
check?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## cloud {#cloud}

```ts
cloud?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## copy {#copy}

```ts
copy?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## create {#create}

```ts
create?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## history {#history}

```ts
history?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## move {#move}

```ts
move?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## object_tree {#object_tree}

```ts
object_tree?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## open {#open}

```ts
open?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## rename {#rename}

```ts
rename?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## save {#save}

```ts
save?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## strategy_tester {#strategy_tester}

```ts
strategy_tester?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineEditorActionOptions


---

<!-- Public documentation export; not library implementation source. -->
# PineEditorLayoutRequest

[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.

```ts
export type PineEditorLayoutRequest =
  | { action: "collapse" }
  | { action: "close" }
  | { action: "maximize" }
  | { action: "move"; target: "bottom" | "right" }
  | { action: "open" };
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineEditorLayoutRequest


---

<!-- Public documentation export; not library implementation source. -->
# PineEditorUiOptions

[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.

## actions {#actions}

```ts
actions?: PineEditorActionOptions;
```

Use the type signature above and the integration guide for the owning capability.

## enabled {#enabled}

```ts
enabled?: boolean;
```

Set to false when the host renders its own Pine editor.

## layout_owner {#layout_owner}

```ts
layout_owner?: "host" | "runtime";
```

Use the type signature above and the integration guide for the owning capability.

## preset {#preset}

```ts
preset?: PineEditorUiPreset;
```

Use the type signature above and the integration guide for the owning capability.

## shortcut_owner {#shortcut_owner}

```ts
shortcut_owner?: "editor" | "host";
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineEditorActionOptions](https://docs.lumencharts.com/charting-library/api/PineEditorActionOptions)
- [PineEditorUiPreset](https://docs.lumencharts.com/charting-library/api/PineEditorUiPreset)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineEditorUiOptions


---

<!-- Public documentation export; not library implementation source. -->
# PineEditorUiPreset

[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.

```ts
export type PineEditorUiPreset = "standalone" | "host-controlled" | "read-only";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineEditorUiPreset


---

<!-- Public documentation export; not library implementation source. -->
# PineEditorWorkspaceApi

[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.

## getSnapshot {#getsnapshot}

```ts
getSnapshot(): PineEditorWorkspaceSnapshot;
```

Use the type signature above and the integration guide for the owning capability.

## subscribe {#subscribe}

```ts
subscribe(listener: (change: PineEditorWorkspaceChange) => void): () => void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listener` | `(change: PineEditorWorkspaceChange) => void` | Yes |

## subscribeLayoutRequests {#subscribelayoutrequests}

```ts
subscribeLayoutRequests(
    listener: (request: PineEditorLayoutRequest) => void,
  ): () => void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listener` | `(request: PineEditorLayoutRequest) => void` | Yes |

## previewCompile {#previewcompile}

```ts
previewCompile(source: string): Promise<PineScriptCompileResult>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `string` | Yes |

## replaceSource {#replacesource}

```ts
replaceSource(
    source: string,
    expected: { generation: number; sourceHash: string },
  ): Promise<PineEditorWorkspaceSnapshot>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `string` | Yes |
| `expected` | `{ generation: number; sourceHash: string }` | Yes |

## openEditor {#openeditor}

```ts
openEditor(): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

## openStrategyTester {#openstrategytester}

```ts
openStrategyTester(): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

## check {#check}

```ts
check(): Promise<PineEditorWorkspaceSnapshot>;
```

Use the type signature above and the integration guide for the owning capability.

## run {#run}

```ts
run(): Promise<PineEditorWorkspaceSnapshot>;
```

Use the type signature above and the integration guide for the owning capability.

## save {#save}

```ts
save(title?: string): Promise<PineEditorWorkspaceSnapshot>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `title` | `string` | No |

## getStrategyReport {#getstrategyreport}

```ts
getStrategyReport(): PineStrategyReport | null;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineEditorWorkspaceSnapshot](https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceSnapshot)
- [PineEditorWorkspaceChange](https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceChange)
- [PineEditorLayoutRequest](https://docs.lumencharts.com/charting-library/api/PineEditorLayoutRequest)
- [PineScriptCompileResult](https://docs.lumencharts.com/charting-library/api/PineScriptCompileResult)
- [PineStrategyReport](https://docs.lumencharts.com/charting-library/api/PineStrategyReport)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceApi


---

<!-- Public documentation export; not library implementation source. -->
# PineEditorWorkspaceChange

[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.

## snapshot {#snapshot}

```ts
snapshot: PineEditorWorkspaceSnapshot;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
type: "document" | "source" | "status";
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineEditorWorkspaceSnapshot](https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceSnapshot)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceChange


---

<!-- Public documentation export; not library implementation source. -->
# PineEditorWorkspaceSnapshot

[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.

## boundStudyId {#boundstudyid}

```ts
boundStudyId: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## diagnostics {#diagnostics}

```ts
diagnostics: readonly PineScriptDiagnostic[];
```

Use the type signature above and the integration guide for the owning capability.

## dirty {#dirty}

```ts
dirty: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## documentId {#documentid}

```ts
documentId: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## documentRevision {#documentrevision}

```ts
documentRevision: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## generation {#generation}

```ts
generation: number;
```

Use the type signature above and the integration guide for the owning capability.

## kind {#kind}

```ts
kind: PineDocumentKind;
```

Use the type signature above and the integration guide for the owning capability.

## savedSource {#savedsource}

```ts
savedSource: string;
```

Use the type signature above and the integration guide for the owning capability.

## source {#source}

```ts
source: string;
```

Use the type signature above and the integration guide for the owning capability.

## sourceHash {#sourcehash}

```ts
sourceHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineScriptDiagnostic](https://docs.lumencharts.com/charting-library/api/PineScriptDiagnostic)
- [PineDocumentKind](https://docs.lumencharts.com/charting-library/api/PineDocumentKind)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineEditorWorkspaceSnapshot


---

<!-- Public documentation export; not library implementation source. -->
# PineJS

[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.

## Std {#std}

```ts
Std: PineJSStd;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineJSStd](https://docs.lumencharts.com/charting-library/api/PineJSStd)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineJS


---

<!-- Public documentation export; not library implementation source. -->
# PineJSStd

[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.

## max_series_default_size {#max_series_default_size}

```ts
max_series_default_size: 10001;
```

Use the type signature above and the integration guide for the owning capability.

## eps {#eps}

```ts
eps(): number;
```

Use the type signature above and the integration guide for the owning capability.

## high {#high}

```ts
high(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## low {#low}

```ts
low(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## open {#open}

```ts
open(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## close {#close}

```ts
close(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## ohlc4 {#ohlc4}

```ts
ohlc4(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## volume {#volume}

```ts
volume(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## time {#time}

```ts
time(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## time (overload 2) {#time-1}

```ts
time(context: IContext, period: string, spec: unknown): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `period` | `string` | Yes |
| `spec` | `unknown` | Yes |

## hl2 {#hl2}

```ts
hl2(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## hlc3 {#hlc3}

```ts
hlc3(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## period {#period}

```ts
period(context: IContext): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## tickerid {#tickerid}

```ts
tickerid(context: IContext): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## year {#year}

```ts
year(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## month {#month}

```ts
month(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## weekofyear {#weekofyear}

```ts
weekofyear(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## dayofmonth {#dayofmonth}

```ts
dayofmonth(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## dayofweek {#dayofweek}

```ts
dayofweek(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## hour {#hour}

```ts
hour(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## minute {#minute}

```ts
minute(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## second {#second}

```ts
second(context: IContext, time?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `time` | `number` | No |

## greaterOrEqual {#greaterorequal}

```ts
greaterOrEqual(n1: number, n2: number, eps?: number): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |
| `eps` | `number` | No |

## lessOrEqual {#lessorequal}

```ts
lessOrEqual(n1: number, n2: number, eps?: number): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |
| `eps` | `number` | No |

## equal {#equal}

```ts
equal(n1: number, n2: number, eps?: number): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |
| `eps` | `number` | No |

## greater {#greater}

```ts
greater(n1: number, n2: number, eps?: number): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |
| `eps` | `number` | No |

## less {#less}

```ts
less(n1: number, n2: number, eps?: number): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |
| `eps` | `number` | No |

## compare {#compare}

```ts
compare(n1: number, n2: number, eps?: number): -1 | 0 | 1;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |
| `eps` | `number` | No |

## ge {#ge}

```ts
ge(n1: number, n2: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |

## le {#le}

```ts
le(n1: number, n2: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |

## eq {#eq}

```ts
eq(n1: number, n2: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |

## neq {#neq}

```ts
neq(n1: number, n2: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |

## gt {#gt}

```ts
gt(n1: number, n2: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |

## lt {#lt}

```ts
lt(n1: number, n2: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n1` | `number` | Yes |
| `n2` | `number` | Yes |

## iff {#iff}

```ts
iff(condition: number, thenValue: number, elseValue: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `condition` | `number` | Yes |
| `thenValue` | `number` | Yes |
| `elseValue` | `number` | Yes |

## tr {#tr}

```ts
tr(n_handleNaN: number | undefined, ctx: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_handleNaN` | `number &#124; undefined` | Yes |
| `ctx` | `IContext` | Yes |

## atr {#atr}

```ts
atr(length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## isdwm {#isdwm}

```ts
isdwm(context: IContext): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## isintraday {#isintraday}

```ts
isintraday(context: IContext): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## isdaily {#isdaily}

```ts
isdaily(context: IContext): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## isweekly {#isweekly}

```ts
isweekly(context: IContext): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## ismonthly {#ismonthly}

```ts
ismonthly(context: IContext): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## selectSessionBreaks {#selectsessionbreaks}

```ts
selectSessionBreaks(context: IContext, times: number[]): number[];
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |
| `times` | `number[]` | Yes |

## createNewSessionCheck {#createnewsessioncheck}

```ts
createNewSessionCheck(context: IContext): (time: number) => boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## error {#error}

```ts
error(message: string): never;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `message` | `string` | Yes |

## zigzag {#zigzag}

```ts
zigzag(n_deviation: number, n_depth: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_deviation` | `number` | Yes |
| `n_depth` | `number` | Yes |
| `context` | `IContext` | Yes |

## zigzagbars {#zigzagbars}

```ts
zigzagbars(n_deviation: number, n_depth: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_deviation` | `number` | Yes |
| `n_depth` | `number` | Yes |
| `context` | `IContext` | Yes |

## updatetime {#updatetime}

```ts
updatetime(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## ticker {#ticker}

```ts
ticker(context: IContext): string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## percentrank {#percentrank}

```ts
percentrank(source: IPineSeries, length: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |

## rising {#rising}

```ts
rising(series: IPineSeries, length: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `series` | `IPineSeries` | Yes |
| `length` | `number` | Yes |

## falling {#falling}

```ts
falling(series: IPineSeries, length: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `series` | `IPineSeries` | Yes |
| `length` | `number` | Yes |

## rsi {#rsi}

```ts
rsi(upper: number, lower: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `upper` | `number` | Yes |
| `lower` | `number` | Yes |

## sum {#sum}

```ts
sum(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## sma {#sma}

```ts
sma(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## smma {#smma}

```ts
smma(n_value: number, n_length: number, ctx: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_value` | `number` | Yes |
| `n_length` | `number` | Yes |
| `ctx` | `IContext` | Yes |

## rma {#rma}

```ts
rma(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## ema {#ema}

```ts
ema(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## wma {#wma}

```ts
wma(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## vwma {#vwma}

```ts
vwma(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## swma {#swma}

```ts
swma(source: IPineSeries, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `context` | `IContext` | Yes |

## fixnan {#fixnan}

```ts
fixnan(n_current: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_current` | `number` | Yes |
| `context` | `IContext` | Yes |

## lowestbars {#lowestbars}

```ts
lowestbars(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## lowest {#lowest}

```ts
lowest(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## highestbars {#highestbars}

```ts
highestbars(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## highest {#highest}

```ts
highest(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## cum {#cum}

```ts
cum(n_value: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_value` | `number` | Yes |
| `context` | `IContext` | Yes |

## accdist {#accdist}

```ts
accdist(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## correlation {#correlation}

```ts
correlation(
    sourceA: IPineSeries,
    sourceB: IPineSeries,
    length: number,
    context: IContext,
  ): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `sourceA` | `IPineSeries` | Yes |
| `sourceB` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## stoch {#stoch}

```ts
stoch(
    source: IPineSeries,
    high: IPineSeries,
    low: IPineSeries,
    length: number,
    context: IContext,
  ): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `high` | `IPineSeries` | Yes |
| `low` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## tsi {#tsi}

```ts
tsi(
    source: IPineSeries,
    shortLength: number,
    longLength: number,
    context: IContext,
  ): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `shortLength` | `number` | Yes |
| `longLength` | `number` | Yes |
| `context` | `IContext` | Yes |

## cross {#cross}

```ts
cross(n_0: number, n_1: number, context: IContext): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_0` | `number` | Yes |
| `n_1` | `number` | Yes |
| `context` | `IContext` | Yes |

## linreg {#linreg}

```ts
linreg(source: IPineSeries, length: number, offset: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `offset` | `number` | Yes |

## sar {#sar}

```ts
sar(start: number, inc: number, max: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `start` | `number` | Yes |
| `inc` | `number` | Yes |
| `max` | `number` | Yes |
| `context` | `IContext` | Yes |

## alma {#alma}

```ts
alma(
    series: IPineSeries,
    length: number,
    offset: number,
    sigma: number,
  ): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `series` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `offset` | `number` | Yes |
| `sigma` | `number` | Yes |

## change {#change}

```ts
change(source: IPineSeries): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |

## roc {#roc}

```ts
roc(source: IPineSeries, length: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |

## dev {#dev}

```ts
dev(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## stdev {#stdev}

```ts
stdev(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## variance {#variance}

```ts
variance(source: IPineSeries, length: number, context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `source` | `IPineSeries` | Yes |
| `length` | `number` | Yes |
| `context` | `IContext` | Yes |

## add_days_considering_dst {#add_days_considering_dst}

```ts
add_days_considering_dst(
    timezone: string,
    utcTime: Date,
    daysCount: number,
  ): Date;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `timezone` | `string` | Yes |
| `utcTime` | `Date` | Yes |
| `daysCount` | `number` | Yes |

## add_years_considering_dst {#add_years_considering_dst}

```ts
add_years_considering_dst(
    timezone: string,
    utcTime: Date,
    yearsCount: number,
  ): Date;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `timezone` | `string` | Yes |
| `utcTime` | `Date` | Yes |
| `yearsCount` | `number` | Yes |

## dmi {#dmi}

```ts
dmi(
    diLength: number,
    adxSmoothingLength: number,
    context: IContext,
  ): [number, number, number, number, number];
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `diLength` | `number` | Yes |
| `adxSmoothingLength` | `number` | Yes |
| `context` | `IContext` | Yes |

## na {#na}

```ts
na(n?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n` | `number` | No |

## nz {#nz}

```ts
nz(x: number, y?: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |
| `y` | `number` | No |

## and {#and}

```ts
and(n_0: number, n_1: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_0` | `number` | Yes |
| `n_1` | `number` | Yes |

## or {#or}

```ts
or(n_0: number, n_1: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_0` | `number` | Yes |
| `n_1` | `number` | Yes |

## not {#not}

```ts
not(n_0: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `n_0` | `number` | Yes |

## max {#max}

```ts
max(...values: number[]): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `values` | `number[]` | Yes |

## min {#min}

```ts
min(...values: number[]): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `values` | `number[]` | Yes |

## pow {#pow}

```ts
pow(base: number, exponent: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `base` | `number` | Yes |
| `exponent` | `number` | Yes |

## abs {#abs}

```ts
abs(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## log {#log}

```ts
log(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## log10 {#log10}

```ts
log10(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## sqrt {#sqrt}

```ts
sqrt(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## sign {#sign}

```ts
sign(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## exp {#exp}

```ts
exp(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## sin {#sin}

```ts
sin(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## cos {#cos}

```ts
cos(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## tan {#tan}

```ts
tan(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## asin {#asin}

```ts
asin(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## acos {#acos}

```ts
acos(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## atan {#atan}

```ts
atan(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## floor {#floor}

```ts
floor(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## ceil {#ceil}

```ts
ceil(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## round {#round}

```ts
round(x: number): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `x` | `number` | Yes |

## avg {#avg}

```ts
avg(...values: number[]): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `values` | `number[]` | Yes |

## n {#n}

```ts
n(context: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `context` | `IContext` | Yes |

## isZero {#iszero}

```ts
isZero: (v: number) => number;
```

Use the type signature above and the integration guide for the owning capability.

## toBool {#tobool}

```ts
toBool(v: number): boolean;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `v` | `number` | Yes |

## currencyCode {#currencycode}

```ts
currencyCode(ctx: IContext): string | null | undefined;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `ctx` | `IContext` | Yes |

## unitId {#unitid}

```ts
unitId(ctx: IContext): string | null | undefined;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `ctx` | `IContext` | Yes |

## interval {#interval}

```ts
interval(ctx: IContext): number;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `ctx` | `IContext` | Yes |

## Related types

- [IContext](https://docs.lumencharts.com/charting-library/api/IContext)
- [IPineSeries](https://docs.lumencharts.com/charting-library/api/IPineSeries)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineJSStd


---

<!-- Public documentation export; not library implementation source. -->
# PineLibraryDependencyAnalysis

[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.

## Extends

[PineLibraryLockEntry](https://docs.lumencharts.com/charting-library/api/PineLibraryLockEntry)

## alias {#alias}

```ts
alias: string;
```

Use the type signature above and the integration guide for the owning capability.

## dependencies {#dependencies}

```ts
dependencies: PineLibraryRequest[];
```

Use the type signature above and the integration guide for the owning capability.

## exports {#exports}

```ts
exports: Array<{
    name: string;
    kind: "constant" | "function" | "method" | "type";
    line: number;
    column: number;
    endLine: number;
    endColumn: number;
  }>;
```

Use the type signature above and the integration guide for the owning capability.

## usedExports {#usedexports}

```ts
usedExports: string[];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineLibraryLockEntry](https://docs.lumencharts.com/charting-library/api/PineLibraryLockEntry)
- [PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineLibraryDependencyAnalysis


---

<!-- Public documentation export; not library implementation source. -->
# PineLibraryLockEntry

[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.

## Extends

[PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)

## integrity {#integrity}

```ts
integrity: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineLibraryLockEntry


---

<!-- Public documentation export; not library implementation source. -->
# PineLibraryProvider

[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.

## resolve {#resolve}

```ts
resolve(
    request: PineLibraryRequest,
    options: { signal: AbortSignal },
  ): Promise<PineResolvedLibrary>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineLibraryRequest` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## Related types

- [PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)
- [PineResolvedLibrary](https://docs.lumencharts.com/charting-library/api/PineResolvedLibrary)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineLibraryProvider


---

<!-- Public documentation export; not library implementation source. -->
# PineLibraryRequest

[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.

## author {#author}

```ts
author: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## version {#version}

```ts
version: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineLibraryRequest


---

<!-- Public documentation export; not library implementation source. -->
# PineLogCursor

[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.

## logEpoch {#logepoch}

```ts
logEpoch: string;
```

Use the type signature above and the integration guide for the owning capability.

## beforeSequence {#beforesequence}

```ts
beforeSequence: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineLogCursor


---

<!-- Public documentation export; not library implementation source. -->
# PineLogEvent

[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.

## version {#version}

```ts
version: 1;
```

Use the type signature above and the integration guide for the owning capability.

## sequence {#sequence}

```ts
sequence: number;
```

Use the type signature above and the integration guide for the owning capability.

## logEpoch {#logepoch}

```ts
logEpoch: string;
```

Use the type signature above and the integration guide for the owning capability.

## level {#level}

```ts
level: "info" | "warning" | "error";
```

Use the type signature above and the integration guide for the owning capability.

## message {#message}

```ts
message: string;
```

Use the type signature above and the integration guide for the owning capability.

## truncated {#truncated}

```ts
truncated?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## barIndex {#barindex}

```ts
barIndex: number;
```

Use the type signature above and the integration guide for the owning capability.

## barOpenTimeMs {#baropentimems}

```ts
barOpenTimeMs: number;
```

Use the type signature above and the integration guide for the owning capability.

## emittedAtMs {#emittedatms}

```ts
emittedAtMs: number;
```

Use the type signature above and the integration guide for the owning capability.

## phase {#phase}

```ts
phase: "historical" | "realtime";
```

Use the type signature above and the integration guide for the owning capability.

## context {#context}

```ts
context: { kind: "root" | "request"; requestId?: string };
```

Use the type signature above and the integration guide for the owning capability.

## callSite {#callsite}

```ts
callSite: {
    line: number;
    column?: number;
    endLine: number;
    endColumn?: number;
    source?: { kind: "root" | "library"; identity?: string };
  };
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineLogEvent


---

<!-- Public documentation export; not library implementation source. -->
# PineLogPage

[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.

## version {#version}

```ts
version: 1;
```

Use the type signature above and the integration guide for the owning capability.

## sessionKey {#sessionkey}

```ts
sessionKey: string;
```

Use the type signature above and the integration guide for the owning capability.

## logEpoch {#logepoch}

```ts
logEpoch: string;
```

Use the type signature above and the integration guide for the owning capability.

## firstRetainedSequence {#firstretainedsequence}

```ts
firstRetainedSequence: number;
```

Use the type signature above and the integration guide for the owning capability.

## nextSequence {#nextsequence}

```ts
nextSequence: number;
```

Use the type signature above and the integration guide for the owning capability.

## droppedCount {#droppedcount}

```ts
droppedCount: number;
```

Use the type signature above and the integration guide for the owning capability.

## historyUnavailable {#historyunavailable}

```ts
historyUnavailable: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## reset {#reset}

```ts
reset: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## events {#events}

```ts
events: readonly PineLogEvent[];
```

Use the type signature above and the integration guide for the owning capability.

## hasMore {#hasmore}

```ts
hasMore: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## cursor {#cursor}

```ts
cursor: PineLogCursor | null;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineLogEvent](https://docs.lumencharts.com/charting-library/api/PineLogEvent)
- [PineLogCursor](https://docs.lumencharts.com/charting-library/api/PineLogCursor)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineLogPage


---

<!-- Public documentation export; not library implementation source. -->
# PineObjectOverrideChange

[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.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## revision {#revision}

```ts
revision: number;
```

Use the type signature above and the integration guide for the owning capability.

## overrides {#overrides}

```ts
overrides: readonly PineObjectOverrideSnapshot[];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [PineObjectOverrideSnapshot](https://docs.lumencharts.com/charting-library/api/PineObjectOverrideSnapshot)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineObjectOverrideChange


---

<!-- Public documentation export; not library implementation source. -->
# PineObjectOverridePatch

[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.

## visible {#visible}

```ts
visible?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## locked {#locked}

```ts
locked?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## geometry {#geometry}

```ts
geometry?: Readonly<Record<string, unknown>>;
```

Use the type signature above and the integration guide for the owning capability.

## properties {#properties}

```ts
properties?: Readonly<Record<string, unknown>>;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineObjectOverridePatch


---

<!-- Public documentation export; not library implementation source. -->
# PineObjectOverridePath

[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.

```ts
export type PineObjectOverridePath =
  "visible" | "locked" | `geometry.${string}` | `properties.${string}`;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineObjectOverridePath


---

<!-- Public documentation export; not library implementation source. -->
# PineObjectOverrideSnapshot

[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.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## objectId {#objectid}

```ts
objectId: string;
```

Use the type signature above and the integration guide for the owning capability.

## kind {#kind}

```ts
kind: PineStudyObjectBase["kind"];
```

Use the type signature above and the integration guide for the owning capability.

## sourceHash {#sourcehash}

```ts
sourceHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## baseFingerprint {#basefingerprint}

```ts
baseFingerprint: string;
```

Use the type signature above and the integration guide for the owning capability.

## revision {#revision}

```ts
revision: number;
```

Use the type signature above and the integration guide for the owning capability.

## override {#override}

```ts
override: PineObjectOverridePatch;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [PineStudyObjectBase](https://docs.lumencharts.com/charting-library/api/PineStudyObjectBase)
- [PineObjectOverridePatch](https://docs.lumencharts.com/charting-library/api/PineObjectOverridePatch)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineObjectOverrideSnapshot


---

<!-- Public documentation export; not library implementation source. -->
# PinePublication

[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.

## Extends

[PinePublicationIdentity](https://docs.lumencharts.com/charting-library/api/PinePublicationIdentity)

## source {#source}

```ts
source: string;
```

Use the type signature above and the integration guide for the owning capability.

## integrity {#integrity}

```ts
integrity: string;
```

Use the type signature above and the integration guide for the owning capability.

## dependencyLock {#dependencylock}

```ts
dependencyLock: readonly PineLibraryLockEntry[];
```

Use the type signature above and the integration guide for the owning capability.

## visibility {#visibility}

```ts
visibility: "private" | "unlisted" | "public";
```

Use the type signature above and the integration guide for the owning capability.

## permissions {#permissions}

```ts
permissions: { read: boolean; use: boolean };
```

Use the type signature above and the integration guide for the owning capability.

## createdAt {#createdat}

```ts
createdAt: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PinePublicationIdentity](https://docs.lumencharts.com/charting-library/api/PinePublicationIdentity)
- [PineLibraryLockEntry](https://docs.lumencharts.com/charting-library/api/PineLibraryLockEntry)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PinePublication


---

<!-- Public documentation export; not library implementation source. -->
# PinePublicationIdentity

[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.

## publisher {#publisher}

```ts
publisher: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## version {#version}

```ts
version: number;
```

Use the type signature above and the integration guide for the owning capability.

## kind {#kind}

```ts
kind: PineDocumentKind;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineDocumentKind](https://docs.lumencharts.com/charting-library/api/PineDocumentKind)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PinePublicationIdentity


---

<!-- Public documentation export; not library implementation source. -->
# PinePublicationProvider

[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.

## get {#get}

```ts
get(
    request: PinePublicationIdentity,
    options: { signal: AbortSignal },
  ): Promise<PinePublication>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PinePublicationIdentity` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## publish {#publish}

```ts
publish(
    request: PinePublicationIdentity & {
      source: string;
      integrity: string;
      dependencyLock: readonly PineLibraryLockEntry[];
      visibility: "private" | "unlisted" | "public";
    },
    options: { signal: AbortSignal },
  ): Promise<PinePublication>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PinePublicationIdentity & {       source: string;       integrity: string;       dependencyLock: readonly PineLibraryLockEntry[];       visibility: "private" &#124; "unlisted" &#124; "public";     }` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## Related types

- [PinePublicationIdentity](https://docs.lumencharts.com/charting-library/api/PinePublicationIdentity)
- [PinePublication](https://docs.lumencharts.com/charting-library/api/PinePublication)
- [PineLibraryLockEntry](https://docs.lumencharts.com/charting-library/api/PineLibraryLockEntry)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PinePublicationProvider


---

<!-- Public documentation export; not library implementation source. -->
# PineResolvedLibrary

[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.

## Extends

[PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)

## source {#source}

```ts
source: string;
```

Use the type signature above and the integration guide for the owning capability.

## integrity {#integrity}

```ts
integrity?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineResolvedLibrary


---

<!-- Public documentation export; not library implementation source. -->
# PineScriptCapability

[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.

```ts
export type PineScriptCapability =
  "extended-visuals" | "drawing-objects" | "tables" | "alerts" | "strategies";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineScriptCapability


---

<!-- Public documentation export; not library implementation source. -->
# PineScriptCompileResult

[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.

## analysis {#analysis}

```ts
analysis: {
    alerts: { conditions: PineAlertConditionMeta[]; hasAlertCalls: boolean };
    catalogVersion: string;
    compatibility: { usedBuiltins: string[]; unsupportedBuiltins: string[] };
    declaration: { kind: "indicator" | "library" | "strategy" | "unknown" };
    libraries: {
      dependencies: PineLibraryDependencyAnalysis[];
      imports: Array<
        PineLibraryRequest & {
          alias: string;
          line: number;
          column: number;
          endLine: number;
          endColumn: number;
        }
      >;
      lock: PineLibraryLockEntry[];
    };
    plotBudget: {
      limit: 64;
      used: number;
      calls: Array<Record<string, unknown>>;
    };
  };
```

Use the type signature above and the integration guide for the owning capability.

## declaration {#declaration}

```ts
declaration: {
    behindChart: boolean;
    explicitPlotZOrder: boolean;
    format: string;
    overlay: boolean;
    precision: number | null;
    scale: string;
    title: string;
    type: "indicator" | "strategy";
    usesViewport: boolean;
  };
```

Use the type signature above and the integration guide for the owning capability.

## diagnostics {#diagnostics}

```ts
diagnostics: PineScriptDiagnostic[];
```

Use the type signature above and the integration guide for the owning capability.

## executorVersion {#executorversion}

```ts
executorVersion: string;
```

Use the type signature above and the integration guide for the owning capability.

## inputs {#inputs}

```ts
inputs: Array<Record<string, unknown>>;
```

Use the type signature above and the integration guide for the owning capability.

## metaInfo {#metainfo}

```ts
metaInfo: Record<string, unknown>;
```

Use the type signature above and the integration guide for the owning capability.

## plots {#plots}

```ts
plots: Array<{
    display: {
      dataWindow: boolean;
      pane: boolean;
      priceScale: boolean;
      statusLine: boolean;
    };
    editable: boolean;
    id: string;
    join: boolean;
    kind: string;
    showLast: number | null;
    title: string;
    zOrder: number;
  }>;
```

Use the type signature above and the integration guide for the owning capability.

## requiredCapabilities {#requiredcapabilities}

```ts
requiredCapabilities: PineScriptCapability[];
```

Use the type signature above and the integration guide for the owning capability.

## sourceHash {#sourcehash}

```ts
sourceHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## warnings {#warnings}

```ts
warnings: PineScriptDiagnostic[];
```

Use the type signature above and the integration guide for the owning capability.

## strategyConfig {#strategyconfig}

```ts
strategyConfig?: PineStrategyConfig;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineAlertConditionMeta](https://docs.lumencharts.com/charting-library/api/PineAlertConditionMeta)
- [PineLibraryDependencyAnalysis](https://docs.lumencharts.com/charting-library/api/PineLibraryDependencyAnalysis)
- [PineLibraryRequest](https://docs.lumencharts.com/charting-library/api/PineLibraryRequest)
- [PineLibraryLockEntry](https://docs.lumencharts.com/charting-library/api/PineLibraryLockEntry)
- [PineScriptDiagnostic](https://docs.lumencharts.com/charting-library/api/PineScriptDiagnostic)
- [PineScriptCapability](https://docs.lumencharts.com/charting-library/api/PineScriptCapability)
- [PineStrategyConfig](https://docs.lumencharts.com/charting-library/api/PineStrategyConfig)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineScriptCompileResult


---

<!-- Public documentation export; not library implementation source. -->
# PineScriptDiagnostic

[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.

## code {#code}

```ts
code: string;
```

Use the type signature above and the integration guide for the owning capability.

## column {#column}

```ts
column?: number;
```

Use the type signature above and the integration guide for the owning capability.

## line {#line}

```ts
line?: number;
```

Use the type signature above and the integration guide for the owning capability.

## message {#message}

```ts
message: string;
```

Use the type signature above and the integration guide for the owning capability.

## severity {#severity}

```ts
severity: "error" | "warning";
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineScriptDiagnostic


---

<!-- Public documentation export; not library implementation source. -->
# PineScriptRunOptions

[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.

## signal {#signal}

```ts
signal?: AbortSignal;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineScriptRunOptions


---

<!-- Public documentation export; not library implementation source. -->
# PineScriptStudyOptions

[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.

## inputs {#inputs}

```ts
inputs?: Record<string, StudyInputValue | PineChartQualifiedSource>;
```

Overrides Pine inputs by their declared variable ID. An `input.source()`
value may be a primary series name such as `close` or a same-chart study
output reference returned by the source selector (`&lt;entityId&gt;$&lt;plotIndex&gt;`).

## overrides {#overrides}

```ts
overrides?: Record<string, StudyOverrideValueType>;
```

Use the type signature above and the integration guide for the owning capability.

## placement {#placement}

```ts
placement?: "auto" | "overlay" | "pane";
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)
- [PineChartQualifiedSource](https://docs.lumencharts.com/charting-library/api/PineChartQualifiedSource)
- [StudyOverrideValueType](https://docs.lumencharts.com/charting-library/api/StudyOverrideValueType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineScriptStudyOptions


---

<!-- Public documentation export; not library implementation source. -->
# PineScriptStudyState

[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.

## alertConditions {#alertconditions}

```ts
alertConditions: PineAlertConditionMeta[];
```

Use the type signature above and the integration guide for the owning capability.

## descriptor {#descriptor}

```ts
descriptor: Record<string, unknown>;
```

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.

## error {#error}

```ts
error: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## inputs {#inputs}

```ts
inputs: Record<string, StudyInputValue>;
```

Use the type signature above and the integration guide for the owning capability.

## migration {#migration}

```ts
migration: PineStudyMigrationReport | null;
```

Use the type signature above and the integration guide for the owning capability.

## overrides {#overrides}

```ts
overrides: Record<string, StudyOverrideValueType>;
```

Use the type signature above and the integration guide for the owning capability.

## paneIndex {#paneindex}

```ts
paneIndex: number;
```

Use the type signature above and the integration guide for the owning capability.

## status {#status}

```ts
status: "Undefined" | "Loading" | "Completed" | "Error";
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineAlertConditionMeta](https://docs.lumencharts.com/charting-library/api/PineAlertConditionMeta)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)
- [PineStudyMigrationReport](https://docs.lumencharts.com/charting-library/api/PineStudyMigrationReport)
- [StudyOverrideValueType](https://docs.lumencharts.com/charting-library/api/StudyOverrideValueType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineScriptStudyState


---

<!-- Public documentation export; not library implementation source. -->
# PineScriptWidgetOptions

[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.

## initial_source {#initial_source}

```ts
initial_source?: string;
```

Use the type signature above and the integration guide for the owning capability.

## alert_delivery_provider {#alert_delivery_provider}

```ts
alert_delivery_provider?: PineAlertDeliveryProvider;
```

Use the type signature above and the integration guide for the owning capability.

## alerts {#alerts}

```ts
alerts?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## drawing_objects {#drawing_objects}

```ts
drawing_objects?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## editor_ui {#editor_ui}

```ts
editor_ui?: PineEditorUiOptions;
```

Use the type signature above and the integration guide for the owning capability.

## enabled {#enabled}

```ts
enabled: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## extended_visuals {#extended_visuals}

```ts
extended_visuals?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## worker_url {#worker_url}

```ts
worker_url?: string;
```

Use the type signature above and the integration guide for the owning capability.

## max_source_bytes {#max_source_bytes}

```ts
max_source_bytes?: number;
```

Use the type signature above and the integration guide for the owning capability.

## publication_provider {#publication_provider}

```ts
publication_provider?: PinePublicationProvider;
```

Use the type signature above and the integration guide for the owning capability.

## max_bars {#max_bars}

```ts
max_bars?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_alert_events {#max_alert_events}

```ts
max_alert_events?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_dependency_series {#max_dependency_series}

```ts
max_dependency_series?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_drawing_objects {#max_drawing_objects}

```ts
max_drawing_objects?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_table_cells {#max_table_cells}

```ts
max_table_cells?: number;
```

Use the type signature above and the integration guide for the owning capability.

## tables {#tables}

```ts
tables?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## execution_timeout_ms {#execution_timeout_ms}

```ts
execution_timeout_ms?: number;
```

Use the type signature above and the integration guide for the owning capability.

## realtime_timeout_ms {#realtime_timeout_ms}

```ts
realtime_timeout_ms?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_loop_iterations {#max_loop_iterations}

```ts
max_loop_iterations?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_object_overrides {#max_object_overrides}

```ts
max_object_overrides?: number;
```

Use the type signature above and the integration guide for the owning capability.

## object_interaction {#object_interaction}

```ts
object_interaction?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## library_provider {#library_provider}

```ts
library_provider?: PineLibraryProvider;
```

Use the type signature above and the integration guide for the owning capability.

## max_library_bytes {#max_library_bytes}

```ts
max_library_bytes?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_library_dependencies {#max_library_dependencies}

```ts
max_library_dependencies?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_library_depth {#max_library_depth}

```ts
max_library_depth?: number;
```

Use the type signature above and the integration guide for the owning capability.

## strategies {#strategies}

```ts
strategies?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## max_strategy_orders {#max_strategy_orders}

```ts
max_strategy_orders?: number;
```

Use the type signature above and the integration guide for the owning capability.

## max_strategy_trades {#max_strategy_trades}

```ts
max_strategy_trades?: number;
```

Use the type signature above and the integration guide for the owning capability.

## workspace_provider {#workspace_provider}

```ts
workspace_provider?: PineWorkspaceProvider;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineAlertDeliveryProvider](https://docs.lumencharts.com/charting-library/api/PineAlertDeliveryProvider)
- [PineEditorUiOptions](https://docs.lumencharts.com/charting-library/api/PineEditorUiOptions)
- [PinePublicationProvider](https://docs.lumencharts.com/charting-library/api/PinePublicationProvider)
- [PineLibraryProvider](https://docs.lumencharts.com/charting-library/api/PineLibraryProvider)
- [PineWorkspaceProvider](https://docs.lumencharts.com/charting-library/api/PineWorkspaceProvider)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineScriptWidgetOptions


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyConfig

[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.

## backtestFillLimitsAssumption {#backtestfilllimitsassumption}

```ts
backtestFillLimitsAssumption: number;
```

Use the type signature above and the integration guide for the owning capability.

## initialCapital {#initialcapital}

```ts
initialCapital: number;
```

Use the type signature above and the integration guide for the owning capability.

## currency {#currency}

```ts
currency: string;
```

Use the type signature above and the integration guide for the owning capability.

## defaultQuantityType {#defaultquantitytype}

```ts
defaultQuantityType: string;
```

Use the type signature above and the integration guide for the owning capability.

## defaultQuantityValue {#defaultquantityvalue}

```ts
defaultQuantityValue: number;
```

Use the type signature above and the integration guide for the owning capability.

## pyramiding {#pyramiding}

```ts
pyramiding: number;
```

Use the type signature above and the integration guide for the owning capability.

## commissionType {#commissiontype}

```ts
commissionType: string;
```

Use the type signature above and the integration guide for the owning capability.

## commissionValue {#commissionvalue}

```ts
commissionValue: number;
```

Use the type signature above and the integration guide for the owning capability.

## marginLong {#marginlong}

```ts
marginLong: number;
```

Use the type signature above and the integration guide for the owning capability.

## marginShort {#marginshort}

```ts
marginShort: number;
```

Use the type signature above and the integration guide for the owning capability.

## processOrdersOnClose {#processordersonclose}

```ts
processOrdersOnClose: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## slippage {#slippage}

```ts
slippage: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyConfig


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyOrder

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## side {#side}

```ts
side: "long" | "short";
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
type: "market" | "limit" | "stop" | "stop-limit";
```

Use the type signature above and the integration guide for the owning capability.

## status {#status}

```ts
status: "pending" | "filled" | "cancelled";
```

Use the type signature above and the integration guide for the owning capability.

## quantity {#quantity}

```ts
quantity: number;
```

Use the type signature above and the integration guide for the owning capability.

## createdTime {#createdtime}

```ts
createdTime: number;
```

Use the type signature above and the integration guide for the owning capability.

## filledTime {#filledtime}

```ts
filledTime?: number;
```

Use the type signature above and the integration guide for the owning capability.

## filledPrice {#filledprice}

```ts
filledPrice?: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyOrder


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyReport

[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.

## closedTrades {#closedtrades}

```ts
closedTrades: readonly PineStrategyTrade[];
```

Use the type signature above and the integration guide for the owning capability.

## config {#config}

```ts
config: PineStrategyConfig;
```

Use the type signature above and the integration guide for the owning capability.

## identity {#identity}

```ts
identity: PineStrategyRunIdentity | null;
```

Use the type signature above and the integration guide for the owning capability.

## intrabarCoverage {#intrabarcoverage}

```ts
intrabarCoverage: IntrabarCoverage | null;
```

Use the type signature above and the integration guide for the owning capability.

## openTrades {#opentrades}

```ts
openTrades: readonly PineStrategyTrade[];
```

Use the type signature above and the integration guide for the owning capability.

## orders {#orders}

```ts
orders: readonly PineStrategyOrder[];
```

Use the type signature above and the integration guide for the owning capability.

## summary {#summary}

```ts
summary: PineStrategySummary;
```

Use the type signature above and the integration guide for the owning capability.

## timeline {#timeline}

```ts
timeline: readonly PineStrategyTimelinePoint[] | null;
```

Use the type signature above and the integration guide for the owning capability.

## truncation {#truncation}

```ts
truncation: { orders: number; trades: number };
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineStrategyTrade](https://docs.lumencharts.com/charting-library/api/PineStrategyTrade)
- [PineStrategyConfig](https://docs.lumencharts.com/charting-library/api/PineStrategyConfig)
- [PineStrategyRunIdentity](https://docs.lumencharts.com/charting-library/api/PineStrategyRunIdentity)
- [IntrabarCoverage](https://docs.lumencharts.com/charting-library/api/IntrabarCoverage)
- [PineStrategyOrder](https://docs.lumencharts.com/charting-library/api/PineStrategyOrder)
- [PineStrategySummary](https://docs.lumencharts.com/charting-library/api/PineStrategySummary)
- [PineStrategyTimelinePoint](https://docs.lumencharts.com/charting-library/api/PineStrategyTimelinePoint)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyReport


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyReportChange

[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.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## revision {#revision}

```ts
revision: number;
```

Use the type signature above and the integration guide for the owning capability.

## report {#report}

```ts
report: PineStrategyReport;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [PineStrategyReport](https://docs.lumencharts.com/charting-library/api/PineStrategyReport)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyReportChange


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyRunIdentity

[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.

## contextHash {#contexthash}

```ts
contextHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## executorVersion {#executorversion}

```ts
executorVersion: string;
```

Use the type signature above and the integration guide for the owning capability.

## fromTime {#fromtime}

```ts
fromTime: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## inputHash {#inputhash}

```ts
inputHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## inputs {#inputs}

```ts
inputs: Readonly<Record<string, unknown>>;
```

Use the type signature above and the integration guide for the owning capability.

## resolution {#resolution}

```ts
resolution: string;
```

Use the type signature above and the integration guide for the owning capability.

## settingsHash {#settingshash}

```ts
settingsHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## intrabarHash {#intrabarhash}

```ts
intrabarHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## sourceHash {#sourcehash}

```ts
sourceHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## symbol {#symbol}

```ts
symbol: string;
```

Use the type signature above and the integration guide for the owning capability.

## toTime {#totime}

```ts
toTime: number | null;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyRunIdentity


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyRunSettings

[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.

## backtestFillLimitsAssumption {#backtestfilllimitsassumption}

```ts
backtestFillLimitsAssumption?: number;
```

Use the type signature above and the integration guide for the owning capability.

## commissionType {#commissiontype}

```ts
commissionType?: "percent" | "cash_per_order" | "cash_per_contract";
```

Use the type signature above and the integration guide for the owning capability.

## commissionValue {#commissionvalue}

```ts
commissionValue?: number;
```

Use the type signature above and the integration guide for the owning capability.

## currency {#currency}

```ts
currency?: string;
```

Use the type signature above and the integration guide for the owning capability.

## defaultQuantityType {#defaultquantitytype}

```ts
defaultQuantityType?: "fixed" | "cash" | "percent_of_equity";
```

Use the type signature above and the integration guide for the owning capability.

## defaultQuantityValue {#defaultquantityvalue}

```ts
defaultQuantityValue?: number;
```

Use the type signature above and the integration guide for the owning capability.

## initialCapital {#initialcapital}

```ts
initialCapital?: number;
```

Use the type signature above and the integration guide for the owning capability.

## marginLong {#marginlong}

```ts
marginLong?: number;
```

Use the type signature above and the integration guide for the owning capability.

## marginShort {#marginshort}

```ts
marginShort?: number;
```

Use the type signature above and the integration guide for the owning capability.

## processOrdersOnClose {#processordersonclose}

```ts
processOrdersOnClose?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## pyramiding {#pyramiding}

```ts
pyramiding?: number;
```

Use the type signature above and the integration guide for the owning capability.

## slippage {#slippage}

```ts
slippage?: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyRunSettings


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategySettingsApplyRequest

[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.

## settings {#settings}

```ts
settings: PineStrategyRunSettings;
```

Use the type signature above and the integration guide for the owning capability.

## sourceHash {#sourcehash}

```ts
sourceHash: string;
```

Use the type signature above and the integration guide for the owning capability.

## studyId {#studyid}

```ts
studyId: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineStrategyRunSettings](https://docs.lumencharts.com/charting-library/api/PineStrategyRunSettings)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategySettingsApplyRequest


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategySettingsHost

[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.

## applyStrategySettings {#applystrategysettings}

```ts
applyStrategySettings(
    request: PineStrategySettingsApplyRequest,
    options: { signal: AbortSignal },
  ): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineStrategySettingsApplyRequest` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## Related types

- [PineStrategySettingsApplyRequest](https://docs.lumencharts.com/charting-library/api/PineStrategySettingsApplyRequest)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategySettingsHost


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategySummary

[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.

## averageTrade {#averagetrade}

```ts
averageTrade: number;
```

Use the type signature above and the integration guide for the owning capability.

## breakevenTrades {#breakeventrades}

```ts
breakevenTrades: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## buyAndHoldPercent {#buyandholdpercent}

```ts
buyAndHoldPercent: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## buyAndHoldProfit {#buyandholdprofit}

```ts
buyAndHoldProfit: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## buyAndHoldReturn {#buyandholdreturn}

```ts
buyAndHoldReturn: number;
```

Use the type signature above and the integration guide for the owning capability.

## cagr {#cagr}

```ts
cagr: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## closedTrades {#closedtrades}

```ts
closedTrades: number;
```

Use the type signature above and the integration guide for the owning capability.

## grossLoss {#grossloss}

```ts
grossLoss: number;
```

Use the type signature above and the integration guide for the owning capability.

## grossProfit {#grossprofit}

```ts
grossProfit: number;
```

Use the type signature above and the integration guide for the owning capability.

## losingTrades {#losingtrades}

```ts
losingTrades: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## maxDrawdown {#maxdrawdown}

```ts
maxDrawdown: number;
```

Use the type signature above and the integration guide for the owning capability.

## maxDrawdownPercent {#maxdrawdownpercent}

```ts
maxDrawdownPercent: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## maxRunup {#maxrunup}

```ts
maxRunup: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## maxRunupPercent {#maxrunuppercent}

```ts
maxRunupPercent: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## netProfit {#netprofit}

```ts
netProfit: number;
```

Use the type signature above and the integration guide for the owning capability.

## netProfitPercent {#netprofitpercent}

```ts
netProfitPercent: number;
```

Use the type signature above and the integration guide for the owning capability.

## openTrades {#opentrades}

```ts
openTrades: number;
```

Use the type signature above and the integration guide for the owning capability.

## percentProfitable {#percentprofitable}

```ts
percentProfitable: number;
```

Use the type signature above and the integration guide for the owning capability.

## profitableTrades {#profitabletrades}

```ts
profitableTrades: number;
```

Use the type signature above and the integration guide for the owning capability.

## profitFactor {#profitfactor}

```ts
profitFactor: number;
```

Use the type signature above and the integration guide for the owning capability.

## sharpeRatio {#sharperatio}

```ts
sharpeRatio: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## sortinoRatio {#sortinoratio}

```ts
sortinoRatio: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## strategyOutperformance {#strategyoutperformance}

```ts
strategyOutperformance: number | null;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategySummary


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyTimelinePoint

[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.

## cumulativePnl {#cumulativepnl}

```ts
cumulativePnl: number;
```

Use the type signature above and the integration guide for the owning capability.

## time {#time}

```ts
time: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyTimelinePoint


---

<!-- Public documentation export; not library implementation source. -->
# PineStrategyTrade

[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.

## entryBarIndex {#entrybarindex}

```ts
entryBarIndex: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## entryComment {#entrycomment}

```ts
entryComment?: string;
```

Use the type signature above and the integration guide for the owning capability.

## entryOrderId {#entryorderid}

```ts
entryOrderId: string;
```

Use the type signature above and the integration guide for the owning capability.

## entryPrice {#entryprice}

```ts
entryPrice: number;
```

Use the type signature above and the integration guide for the owning capability.

## entryTime {#entrytime}

```ts
entryTime: number;
```

Use the type signature above and the integration guide for the owning capability.

## exitBarIndex {#exitbarindex}

```ts
exitBarIndex: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## exitComment {#exitcomment}

```ts
exitComment?: string;
```

Use the type signature above and the integration guide for the owning capability.

## exitOrderId {#exitorderid}

```ts
exitOrderId?: string;
```

Use the type signature above and the integration guide for the owning capability.

## exitPrice {#exitprice}

```ts
exitPrice?: number;
```

Use the type signature above and the integration guide for the owning capability.

## exitTime {#exittime}

```ts
exitTime?: number;
```

Use the type signature above and the integration guide for the owning capability.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## maxAdverseExcursion {#maxadverseexcursion}

```ts
maxAdverseExcursion: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## maxFavorableExcursion {#maxfavorableexcursion}

```ts
maxFavorableExcursion: number | null;
```

Use the type signature above and the integration guide for the owning capability.

## profit {#profit}

```ts
profit?: number;
```

Use the type signature above and the integration guide for the owning capability.

## profitPercent {#profitpercent}

```ts
profitPercent?: number;
```

Use the type signature above and the integration guide for the owning capability.

## quantity {#quantity}

```ts
quantity: number;
```

Use the type signature above and the integration guide for the owning capability.

## side {#side}

```ts
side: "long" | "short";
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStrategyTrade


---

<!-- Public documentation export; not library implementation source. -->
# PineStudyMigrationReport

[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.

## sourceHashBefore {#sourcehashbefore}

```ts
sourceHashBefore: string;
```

Use the type signature above and the integration guide for the owning capability.

## sourceHashAfter {#sourcehashafter}

```ts
sourceHashAfter: string;
```

Use the type signature above and the integration guide for the owning capability.

## retainedInputIds {#retainedinputids}

```ts
retainedInputIds: string[];
```

Use the type signature above and the integration guide for the owning capability.

## removedInputIds {#removedinputids}

```ts
removedInputIds: string[];
```

Use the type signature above and the integration guide for the owning capability.

## resetInputIds {#resetinputids}

```ts
resetInputIds: string[];
```

Use the type signature above and the integration guide for the owning capability.

## retainedOverrideKeys {#retainedoverridekeys}

```ts
retainedOverrideKeys: string[];
```

Use the type signature above and the integration guide for the owning capability.

## removedOverrideKeys {#removedoverridekeys}

```ts
removedOverrideKeys: string[];
```

Use the type signature above and the integration guide for the owning capability.

## retainedSourceInputIds {#retainedsourceinputids}

```ts
retainedSourceInputIds: string[];
```

Use the type signature above and the integration guide for the owning capability.

## removedSourceInputIds {#removedsourceinputids}

```ts
removedSourceInputIds: string[];
```

Use the type signature above and the integration guide for the owning capability.

## disabledAlertRuleIds {#disabledalertruleids}

```ts
disabledAlertRuleIds: string[];
```

Use the type signature above and the integration guide for the owning capability.

## diagnostics {#diagnostics}

```ts
diagnostics: PineScriptDiagnostic[];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineScriptDiagnostic](https://docs.lumencharts.com/charting-library/api/PineScriptDiagnostic)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStudyMigrationReport


---

<!-- Public documentation export; not library implementation source. -->
# PineStudyObjectBase

[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.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## objectId {#objectid}

```ts
objectId: string;
```

Use the type signature above and the integration guide for the owning capability.

## kind {#kind}

```ts
kind: "line" | "label" | "box" | "polyline" | "linefill" | "table";
```

Use the type signature above and the integration guide for the owning capability.

## visible {#visible}

```ts
visible: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## locked {#locked}

```ts
locked?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## overridden {#overridden}

```ts
overridden?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## target {#target}

```ts
target: "main" | "study";
```

Use the type signature above and the integration guide for the owning capability.

## order {#order}

```ts
order: number;
```

Use the type signature above and the integration guide for the owning capability.

## sourceRange {#sourcerange}

```ts
sourceRange?: {
    line: number;
    column: number;
    endLine: number;
    endColumn: number;
  };
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStudyObjectBase


---

<!-- Public documentation export; not library implementation source. -->
# PineStudyObjectChange

[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.

## studyId {#studyid}

```ts
studyId: EntityId;
```

Use the type signature above and the integration guide for the owning capability.

## revision {#revision}

```ts
revision: number;
```

Use the type signature above and the integration guide for the owning capability.

## objects {#objects}

```ts
objects: readonly PineStudyObjectSnapshot[];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [PineStudyObjectSnapshot](https://docs.lumencharts.com/charting-library/api/PineStudyObjectSnapshot)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStudyObjectChange


---

<!-- Public documentation export; not library implementation source. -->
# PineStudyObjectSnapshot

[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.

```ts
export type PineStudyObjectSnapshot = PineStudyObjectBase &
  Record<string, unknown>;
```

## Related types

- [PineStudyObjectBase](https://docs.lumencharts.com/charting-library/api/PineStudyObjectBase)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStudyObjectSnapshot


---

<!-- Public documentation export; not library implementation source. -->
# PineStudyResultComposite

[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.

## type {#type}

```ts
type: "composite";
```

Use the type signature above and the integration guide for the owning capability.

## data {#data}

```ts
data: TPineStudyResultSimple[];
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineStudyResultComposite


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceCreateRequest

[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.

## title {#title}

```ts
title: string;
```

Use the type signature above and the integration guide for the owning capability.

## kind {#kind}

```ts
kind: PineDocumentKind;
```

Use the type signature above and the integration guide for the owning capability.

## source {#source}

```ts
source: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineDocumentKind](https://docs.lumencharts.com/charting-library/api/PineDocumentKind)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceCreateRequest


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceDocument

[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.

## Extends

[PineWorkspaceDocumentSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocumentSummary)

## source {#source}

```ts
source: string;
```

Use the type signature above and the integration guide for the owning capability.

## createdAt {#createdat}

```ts
createdAt: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineWorkspaceDocumentSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocumentSummary)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocument


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceDocumentSummary

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title: string;
```

Use the type signature above and the integration guide for the owning capability.

## kind {#kind}

```ts
kind: PineDocumentKind;
```

Use the type signature above and the integration guide for the owning capability.

## revision {#revision}

```ts
revision: string;
```

Use the type signature above and the integration guide for the owning capability.

## updatedAt {#updatedat}

```ts
updatedAt: number;
```

Use the type signature above and the integration guide for the owning capability.

## permissions {#permissions}

```ts
permissions: PineWorkspacePermissions;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineDocumentKind](https://docs.lumencharts.com/charting-library/api/PineDocumentKind)
- [PineWorkspacePermissions](https://docs.lumencharts.com/charting-library/api/PineWorkspacePermissions)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocumentSummary


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceListRequest

[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.

## cursor {#cursor}

```ts
cursor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## limit {#limit}

```ts
limit?: number;
```

Use the type signature above and the integration guide for the owning capability.

## query {#query}

```ts
query?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceListRequest


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspacePage

[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.

## documents {#documents}

```ts
documents: readonly PineWorkspaceDocumentSummary[];
```

Use the type signature above and the integration guide for the owning capability.

## cursor {#cursor}

```ts
cursor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineWorkspaceDocumentSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocumentSummary)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspacePage


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspacePermissions

[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.

## read {#read}

```ts
read: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## update {#update}

```ts
update: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## delete {#delete}

```ts
delete: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## publish {#publish}

```ts
publish: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspacePermissions


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceProvider

[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.

## list {#list}

```ts
list(
    request: PineWorkspaceListRequest,
    options: { signal: AbortSignal },
  ): Promise<PineWorkspacePage>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceListRequest` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## load {#load}

```ts
load(
    request: { id: string },
    options: { signal: AbortSignal },
  ): Promise<PineWorkspaceDocument>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `{ id: string }` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## create {#create}

```ts
create(
    request: PineWorkspaceCreateRequest,
    options: { signal: AbortSignal },
  ): Promise<PineWorkspaceDocument>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceCreateRequest` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## update {#update}

```ts
update(
    request: PineWorkspaceUpdateRequest,
    options: { signal: AbortSignal },
  ): Promise<PineWorkspaceDocument>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceUpdateRequest` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## delete {#delete}

```ts
delete(
    request: { id: string; expectedRevision: string },
    options: { signal: AbortSignal },
  ): Promise<void>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `{ id: string; expectedRevision: string }` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## listRevisions {#listrevisions}

```ts
listRevisions?(
    request: PineWorkspaceRevisionListRequest,
    options: { signal: AbortSignal },
  ): Promise<PineWorkspaceRevisionPage>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `PineWorkspaceRevisionListRequest` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## loadRevision {#loadrevision}

```ts
loadRevision?(
    request: { id: string; revision: string },
    options: { signal: AbortSignal },
  ): Promise<PineWorkspaceRevision>;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `request` | `{ id: string; revision: string }` | Yes |
| `options` | `{ signal: AbortSignal }` | Yes |

## applyStrategySettings {#applystrategysettings}

```ts
applyStrategySettings?: PineStrategySettingsHost["applyStrategySettings"];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineWorkspaceListRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceListRequest)
- [PineWorkspacePage](https://docs.lumencharts.com/charting-library/api/PineWorkspacePage)
- [PineWorkspaceDocument](https://docs.lumencharts.com/charting-library/api/PineWorkspaceDocument)
- [PineWorkspaceCreateRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceCreateRequest)
- [PineWorkspaceUpdateRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceUpdateRequest)
- [PineWorkspaceRevisionListRequest](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionListRequest)
- [PineWorkspaceRevisionPage](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionPage)
- [PineWorkspaceRevision](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevision)
- [PineStrategySettingsHost](https://docs.lumencharts.com/charting-library/api/PineStrategySettingsHost)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceProvider


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceRevision

[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.

## Extends

[PineWorkspaceRevisionSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionSummary)

## source {#source}

```ts
source: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineWorkspaceRevisionSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionSummary)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevision


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceRevisionListRequest

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## cursor {#cursor}

```ts
cursor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## limit {#limit}

```ts
limit?: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionListRequest


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceRevisionPage

[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.

## revisions {#revisions}

```ts
revisions: readonly PineWorkspaceRevisionSummary[];
```

Use the type signature above and the integration guide for the owning capability.

## cursor {#cursor}

```ts
cursor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PineWorkspaceRevisionSummary](https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionSummary)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionPage


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceRevisionSummary

[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.

## revision {#revision}

```ts
revision: string;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title: string;
```

Use the type signature above and the integration guide for the owning capability.

## createdAt {#createdat}

```ts
createdAt: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceRevisionSummary


---

<!-- Public documentation export; not library implementation source. -->
# PineWorkspaceUpdateRequest

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## expectedRevision {#expectedrevision}

```ts
expectedRevision: string;
```

Use the type signature above and the integration guide for the owning capability.

## source {#source}

```ts
source: string;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PineWorkspaceUpdateRequest


---

<!-- Public documentation export; not library implementation source. -->
# PlDisplay

[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.

```ts
export enum PlDisplay {
  Money = 0,
  Pips = 1,
  Percentage = 2,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PlDisplay


---

<!-- Public documentation export; not library implementation source. -->
# PlotShapeId

[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.

```ts
export type PlotShapeId =
  | "shape_arrow_down"
  | "shape_arrow_up"
  | "shape_circle"
  | "shape_cross"
  | "shape_xcross"
  | "shape_diamond"
  | "shape_flag"
  | "shape_square"
  | "shape_label_down"
  | "shape_label_up"
  | "shape_triangle_down"
  | "shape_triangle_up";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PlotShapeId


---

<!-- Public documentation export; not library implementation source. -->
# PlotSymbolSize

[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.

```ts
declare enum PlotSymbolSize {
  Auto = "auto",
  Tiny = "tiny",
  Small = "small",
  Normal = "normal",
  Large = "large",
  Huge = "huge",
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PlotSymbolSize


---

<!-- Public documentation export; not library implementation source. -->
# PlusClickParams

[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.

## Extends

[MouseEventParams](https://docs.lumencharts.com/charting-library/api/MouseEventParams)

## symbol {#symbol}

```ts
symbol: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## price {#price}

```ts
price: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [MouseEventParams](https://docs.lumencharts.com/charting-library/api/MouseEventParams)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PlusClickParams


---

<!-- Public documentation export; not library implementation source. -->
# PnFStylePreferences

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColor {#downcolor}

```ts
downColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## upColorProjection {#upcolorprojection}

```ts
upColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColorProjection {#downcolorprojection}

```ts
downColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PnFStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# PolygonPreferences

[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.

## transparency {#transparency}

```ts
transparency: number;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PolygonPreferences


---

<!-- Public documentation export; not library implementation source. -->
# PositionLineLengthUnit

[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.

```ts
export type PositionLineLengthUnit = "pixel" | "percentage";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PositionLineLengthUnit


---

<!-- Public documentation export; not library implementation source. -->
# PositionPercents

[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.

## x {#x}

```ts
x: number;
```

Use the type signature above and the integration guide for the owning capability.

## y {#y}

```ts
y: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PositionPercents


---

<!-- Public documentation export; not library implementation source. -->
# PricedPoint

[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.

## Extends

[TimePoint](https://docs.lumencharts.com/charting-library/api/TimePoint)

## price {#price}

```ts
price: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [TimePoint](https://docs.lumencharts.com/charting-library/api/TimePoint)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PricedPoint


---

<!-- Public documentation export; not library implementation source. -->
# PriceScaleMode

[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.

```ts
export declare const enum PriceScaleMode {
  Normal = 0,
  Log = 1,
  Percentage = 2,
  IndexedTo100 = 3,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PriceScaleMode


---

<!-- Public documentation export; not library implementation source. -->
# PriceScaleSelectedCurrency

[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.

```ts
export type PriceScaleSelectedCurrency = "Mixed" | string;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PriceScaleSelectedCurrency


---

<!-- Public documentation export; not library implementation source. -->
# PriceSource

[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.

```ts
export type PriceSource = "open" | "high" | "low" | "close";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/PriceSource


---

<!-- Public documentation export; not library implementation source. -->
# QuoteData

[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.

```ts
export type QuoteData = QuoteOkData | QuoteErrorData;
```

## Related types

- [QuoteOkData](https://docs.lumencharts.com/charting-library/api/QuoteOkData)
- [QuoteErrorData](https://docs.lumencharts.com/charting-library/api/QuoteErrorData)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/QuoteData


---

<!-- Public documentation export; not library implementation source. -->
# QuoteDataResponse

[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.

## s {#s}

```ts
s: "ok" | "error";
```

Use the type signature above and the integration guide for the owning capability.

## n {#n}

```ts
n: string;
```

Use the type signature above and the integration guide for the owning capability.

## v {#v}

```ts
v: unknown;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/QuoteDataResponse


---

<!-- Public documentation export; not library implementation source. -->
# QuoteErrorData

[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.

## Extends

[QuoteDataResponse](https://docs.lumencharts.com/charting-library/api/QuoteDataResponse)

## s {#s}

```ts
s: "error";
```

Use the type signature above and the integration guide for the owning capability.

## v {#v}

```ts
v: object;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [QuoteDataResponse](https://docs.lumencharts.com/charting-library/api/QuoteDataResponse)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/QuoteErrorData


---

<!-- Public documentation export; not library implementation source. -->
# QuoteOkData

[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.

## Extends

[QuoteDataResponse](https://docs.lumencharts.com/charting-library/api/QuoteDataResponse)

## s {#s}

```ts
s: "ok";
```

Use the type signature above and the integration guide for the owning capability.

## v {#v}

```ts
v: DatafeedQuoteValues;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [QuoteDataResponse](https://docs.lumencharts.com/charting-library/api/QuoteDataResponse)
- [DatafeedQuoteValues](https://docs.lumencharts.com/charting-library/api/DatafeedQuoteValues)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/QuoteOkData


---

<!-- Public documentation export; not library implementation source. -->
# QuotesCallback

[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.

```ts
export type QuotesCallback = (data: QuoteData[]) => void;
```

## Related types

- [QuoteData](https://docs.lumencharts.com/charting-library/api/QuoteData)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/QuotesCallback


---

<!-- Public documentation export; not library implementation source. -->
# QuotesErrorCallback

[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.

```ts
export type QuotesErrorCallback = (reason: string) => void;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/QuotesErrorCallback


---

<!-- Public documentation export; not library implementation source. -->
# RangeOptions

[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.

## val {#val}

```ts
val: TimeFrameValue;
```

Use the type signature above and the integration guide for the owning capability.

## res {#res}

```ts
res: ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [TimeFrameValue](https://docs.lumencharts.com/charting-library/api/TimeFrameValue)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/RangeOptions


---

<!-- Public documentation export; not library implementation source. -->
# RawStudyMetaInfo

[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.

## Extends

[RawStudyMetaInfoBase](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfoBase)

## id {#id}

```ts
readonly id: RawStudyMetaInfoId;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [RawStudyMetaInfoBase](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfoBase)
- [RawStudyMetaInfoId](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfoId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfo


---

<!-- Public documentation export; not library implementation source. -->
# RawStudyMetaInfoBase

[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.

## description {#description}

```ts
readonly description: string;
```

Use the type signature above and the integration guide for the owning capability.

## shortDescription {#shortdescription}

```ts
readonly shortDescription: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
readonly name?: string;
```

Use the type signature above and the integration guide for the owning capability.

## _metainfoVersion {#_metainfoversion}

```ts
readonly _metainfoVersion?: number;
```

Use the type signature above and the integration guide for the owning capability.

## precision {#precision}

```ts
readonly precision?: number | string;
```

Use the type signature above and the integration guide for the owning capability.

## format {#format}

```ts
readonly format: StudyPlotValueFormat;
```

Use the type signature above and the integration guide for the owning capability.

## is_price_study {#is_price_study}

```ts
readonly is_price_study?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## isCustomIndicator {#iscustomindicator}

```ts
readonly isCustomIndicator?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## linkedToSeries {#linkedtoseries}

```ts
readonly linkedToSeries?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## priceScale {#pricescale}

```ts
readonly priceScale?: StudyTargetPriceScale;
```

Use the type signature above and the integration guide for the owning capability.

## is_hidden_study {#is_hidden_study}

```ts
readonly is_hidden_study?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## defaults {#defaults}

```ts
readonly defaults: Readonly<Partial<StudyDefaults>>;
```

Use the type signature above and the integration guide for the owning capability.

## bands {#bands}

```ts
readonly bands?: readonly Readonly<StudyBandInfo>[];
```

Use the type signature above and the integration guide for the owning capability.

## filledAreas {#filledareas}

```ts
readonly filledAreas?: readonly Readonly<StudyFilledAreaInfo>[];
```

Use the type signature above and the integration guide for the owning capability.

## inputs {#inputs}

```ts
readonly inputs?: StudyInputInfoList;
```

Use the type signature above and the integration guide for the owning capability.

## symbolSource {#symbolsource}

```ts
readonly symbolSource?: SymbolSource;
```

Use the type signature above and the integration guide for the owning capability.

## palettes {#palettes}

```ts
readonly palettes?: MappedObject<Readonly<StudyPalettesInfo>>;
```

Use the type signature above and the integration guide for the owning capability.

## plots {#plots}

```ts
readonly plots?: readonly Readonly<StudyPlotInfo>[];
```

Use the type signature above and the integration guide for the owning capability.

## styles {#styles}

```ts
readonly styles?: MappedObject<Readonly<StudyStylesInfo>>;
```

Use the type signature above and the integration guide for the owning capability.

## ohlcPlots {#ohlcplots}

```ts
readonly ohlcPlots?: MappedObject<Readonly<StudyOhlcStylesInfo>>;
```

Use the type signature above and the integration guide for the owning capability.

## financialPeriod {#financialperiod}

```ts
readonly financialPeriod?: FinancialPeriod;
```

Use the type signature above and the integration guide for the owning capability.

## groupingKey {#groupingkey}

```ts
readonly groupingKey?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotValueFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValueFormat)
- [StudyTargetPriceScale](https://docs.lumencharts.com/charting-library/api/StudyTargetPriceScale)
- [StudyDefaults](https://docs.lumencharts.com/charting-library/api/StudyDefaults)
- [StudyBandInfo](https://docs.lumencharts.com/charting-library/api/StudyBandInfo)
- [StudyFilledAreaInfo](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaInfo)
- [StudyInputInfoList](https://docs.lumencharts.com/charting-library/api/StudyInputInfoList)
- [SymbolSource](https://docs.lumencharts.com/charting-library/api/SymbolSource)
- [MappedObject](https://docs.lumencharts.com/charting-library/api/MappedObject)
- [StudyPalettesInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettesInfo)
- [StudyPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotInfo)
- [StudyStylesInfo](https://docs.lumencharts.com/charting-library/api/StudyStylesInfo)
- [StudyOhlcStylesInfo](https://docs.lumencharts.com/charting-library/api/StudyOhlcStylesInfo)
- [FinancialPeriod](https://docs.lumencharts.com/charting-library/api/FinancialPeriod)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfoBase


---

<!-- Public documentation export; not library implementation source. -->
# RawStudyMetaInfoId

[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.

```ts
export type RawStudyMetaInfoId = Nominal<string, "RawStudyMetaInfoId">;
```

## Related types

- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfoId


---

<!-- Public documentation export; not library implementation source. -->
# RawStudyMetaInformation

[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.

```ts
export type RawStudyMetaInformation = Omit<
  RawStudyMetaInfo,
  "defaults" | "plots"
> & {
  readonly plots?: readonly Readonly<StudyPlotInformation>[];
  readonly defaults?: Readonly<DeepPartial<StudyDefaults>>;
};
```

## Related types

- [RawStudyMetaInfo](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInfo)
- [StudyPlotInformation](https://docs.lumencharts.com/charting-library/api/StudyPlotInformation)
- [DeepPartial](https://docs.lumencharts.com/charting-library/api/DeepPartial)
- [StudyDefaults](https://docs.lumencharts.com/charting-library/api/StudyDefaults)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/RawStudyMetaInformation


---

<!-- Public documentation export; not library implementation source. -->
# RenkoStylePreferences

[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.

## upColor {#upcolor}

```ts
upColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColor {#downcolor}

```ts
downColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderUpColor {#borderupcolor}

```ts
borderUpColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderDownColor {#borderdowncolor}

```ts
borderDownColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## upColorProjection {#upcolorprojection}

```ts
upColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## downColorProjection {#downcolorprojection}

```ts
downColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderUpColorProjection {#borderupcolorprojection}

```ts
borderUpColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderDownColorProjection {#borderdowncolorprojection}

```ts
borderDownColorProjection: string;
```

Use the type signature above and the integration guide for the owning capability.

## wickUpColor {#wickupcolor}

```ts
wickUpColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## wickDownColor {#wickdowncolor}

```ts
wickDownColor: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/RenkoStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# ResolutionString

[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.

```ts
export type ResolutionString = Nominal<string, "ResolutionString">;
```

## Related types

- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ResolutionString


---

<!-- Public documentation export; not library implementation source. -->
# ResolveCallback

[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.

```ts
export type ResolveCallback = (symbolInfo: LibrarySymbolInfo) => void;
```

## Related types

- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ResolveCallback


---

<!-- Public documentation export; not library implementation source. -->
# SaveChartOptions

[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.

## includeDrawings {#includedrawings}

```ts
includeDrawings?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SaveChartOptions


---

<!-- Public documentation export; not library implementation source. -->
# SaveChartToServerOptions

[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.

## chartName {#chartname}

```ts
chartName?: string;
```

Use the type signature above and the integration guide for the owning capability.

## defaultChartName {#defaultchartname}

```ts
defaultChartName?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SaveChartToServerOptions


---

<!-- Public documentation export; not library implementation source. -->
# SavedStateMetaInfo

[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.

## uid {#uid}

```ts
uid: number;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## description {#description}

```ts
description: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SavedStateMetaInfo


---

<!-- Public documentation export; not library implementation source. -->
# SaveLoadChartRecord

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## image_url {#image_url}

```ts
image_url: string;
```

Use the type signature above and the integration guide for the owning capability.

## modified_iso {#modified_iso}

```ts
modified_iso: number;
```

Use the type signature above and the integration guide for the owning capability.

## short_symbol {#short_symbol}

```ts
short_symbol: string;
```

Use the type signature above and the integration guide for the owning capability.

## interval {#interval}

```ts
interval: ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SaveLoadChartRecord


---

<!-- Public documentation export; not library implementation source. -->
# SearchSymbolResultItem

[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.

## symbol {#symbol}

```ts
symbol: string;
```

Use the type signature above and the integration guide for the owning capability.

## full_name {#full_name}

```ts
full_name: string;
```

Use the type signature above and the integration guide for the owning capability.

## description {#description}

```ts
description: string;
```

Use the type signature above and the integration guide for the owning capability.

## exchange {#exchange}

```ts
exchange: string;
```

Use the type signature above and the integration guide for the owning capability.

## ticker {#ticker}

```ts
ticker?: string;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
type: string;
```

Use the type signature above and the integration guide for the owning capability.

## logo_urls {#logo_urls}

```ts
logo_urls?: [string] | [string, string];
```

Use the type signature above and the integration guide for the owning capability.

## exchange_logo {#exchange_logo}

```ts
exchange_logo?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SearchSymbolResultItem


---

<!-- Public documentation export; not library implementation source. -->
# SearchSymbolsCallback

[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.

```ts
export type SearchSymbolsCallback = (items: SearchSymbolResultItem[]) => void;
```

## Related types

- [SearchSymbolResultItem](https://docs.lumencharts.com/charting-library/api/SearchSymbolResultItem)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SearchSymbolsCallback


---

<!-- Public documentation export; not library implementation source. -->
# SelectBarRequestOptions

[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.

## presentation {#presentation}

```ts
readonly presentation?: "normal" | "dim-future";
```

Controls the visual treatment shown while the user chooses a bar.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SelectBarRequestOptions


---

<!-- Public documentation export; not library implementation source. -->
# SeriesEventType

[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.

```ts
export type SeriesEventType = "price_scale_changed";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesEventType


---

<!-- Public documentation export; not library implementation source. -->
# SeriesFieldDescriptor

[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.

## type {#type}

```ts
type: "value";
```

Use the type signature above and the integration guide for the owning capability.

## sourceType {#sourcetype}

```ts
sourceType: "series";
```

Use the type signature above and the integration guide for the owning capability.

## plotTitle {#plottitle}

```ts
plotTitle: string;
```

Use the type signature above and the integration guide for the owning capability.

## sourceTitle {#sourcetitle}

```ts
sourceTitle: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesFieldDescriptor


---

<!-- Public documentation export; not library implementation source. -->
# SeriesFormat

[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.

```ts
export type SeriesFormat = "price" | "volume";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesFormat


---

<!-- Public documentation export; not library implementation source. -->
# SeriesFormatterFactory

[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.

```ts
export type SeriesFormatterFactory = (
  symbolInfo: LibrarySymbolInfo | null,
  minTick: string,
) => ISymbolValueFormatter | null;
```

## Related types

- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)
- [ISymbolValueFormatter](https://docs.lumencharts.com/charting-library/api/ISymbolValueFormatter)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesFormatterFactory


---

<!-- Public documentation export; not library implementation source. -->
# SeriesPreferencesMap

[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.

## [ChartStyle.VolumeFootprint] {#-5b-chartstyle-2e-volumefootprint-5d-}

```ts
[ChartStyle.VolumeFootprint]: VolumeFootprintPreferences;
```

**Beta.** Volume footprint preferences.

## [ChartStyle.Bar] {#-5b-chartstyle-2e-bar-5d-}

```ts
[ChartStyle.Bar]: BarStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Candle] {#-5b-chartstyle-2e-candle-5d-}

```ts
[ChartStyle.Candle]: CandleStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Line] {#-5b-chartstyle-2e-line-5d-}

```ts
[ChartStyle.Line]: LineStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.LineWithMarkers] {#-5b-chartstyle-2e-linewithmarkers-5d-}

```ts
[ChartStyle.LineWithMarkers]: LineStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Stepline] {#-5b-chartstyle-2e-stepline-5d-}

```ts
[ChartStyle.Stepline]: LineStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Area] {#-5b-chartstyle-2e-area-5d-}

```ts
[ChartStyle.Area]: AreaStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.HLCArea] {#-5b-chartstyle-2e-hlcarea-5d-}

```ts
[ChartStyle.HLCArea]: HLCAreaStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Renko] {#-5b-chartstyle-2e-renko-5d-}

```ts
[ChartStyle.Renko]: RenkoStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Kagi] {#-5b-chartstyle-2e-kagi-5d-}

```ts
[ChartStyle.Kagi]: KagiStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.PnF] {#-5b-chartstyle-2e-pnf-5d-}

```ts
[ChartStyle.PnF]: PnFStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.LineBreak] {#-5b-chartstyle-2e-linebreak-5d-}

```ts
[ChartStyle.LineBreak]: LineBreakStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.HeikinAshi] {#-5b-chartstyle-2e-heikinashi-5d-}

```ts
[ChartStyle.HeikinAshi]: HeikinAshiStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.HollowCandle] {#-5b-chartstyle-2e-hollowcandle-5d-}

```ts
[ChartStyle.HollowCandle]: HollowCandleStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Baseline] {#-5b-chartstyle-2e-baseline-5d-}

```ts
[ChartStyle.Baseline]: BaselineStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.HiLo] {#-5b-chartstyle-2e-hilo-5d-}

```ts
[ChartStyle.HiLo]: HiLoStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## [ChartStyle.Column] {#-5b-chartstyle-2e-column-5d-}

```ts
[ChartStyle.Column]: ColumnStylePreferences;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [BarStylePreferences](https://docs.lumencharts.com/charting-library/api/BarStylePreferences)
- [CandleStylePreferences](https://docs.lumencharts.com/charting-library/api/CandleStylePreferences)
- [LineStylePreferences](https://docs.lumencharts.com/charting-library/api/LineStylePreferences)
- [AreaStylePreferences](https://docs.lumencharts.com/charting-library/api/AreaStylePreferences)
- [HLCAreaStylePreferences](https://docs.lumencharts.com/charting-library/api/HLCAreaStylePreferences)
- [RenkoStylePreferences](https://docs.lumencharts.com/charting-library/api/RenkoStylePreferences)
- [KagiStylePreferences](https://docs.lumencharts.com/charting-library/api/KagiStylePreferences)
- [PnFStylePreferences](https://docs.lumencharts.com/charting-library/api/PnFStylePreferences)
- [LineBreakStylePreferences](https://docs.lumencharts.com/charting-library/api/LineBreakStylePreferences)
- [HeikinAshiStylePreferences](https://docs.lumencharts.com/charting-library/api/HeikinAshiStylePreferences)
- [HollowCandleStylePreferences](https://docs.lumencharts.com/charting-library/api/HollowCandleStylePreferences)
- [BaselineStylePreferences](https://docs.lumencharts.com/charting-library/api/BaselineStylePreferences)
- [HiLoStylePreferences](https://docs.lumencharts.com/charting-library/api/HiLoStylePreferences)
- [ColumnStylePreferences](https://docs.lumencharts.com/charting-library/api/ColumnStylePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesPreferencesMap


---

<!-- Public documentation export; not library implementation source. -->
# SeriesPriceScale

[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.

```ts
export type SeriesPriceScale = "new-left" | "new-right" | "no-scale" | EntityId;
```

## Related types

- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesPriceScale


---

<!-- Public documentation export; not library implementation source. -->
# SeriesStatusViewSymbolTextSource

[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.

```ts
export type SeriesStatusViewSymbolTextSource =
  "ticker" | "description" | "ticker-and-description" | "long-description";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesStatusViewSymbolTextSource


---

<!-- Public documentation export; not library implementation source. -->
# SeriesType

[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.

```ts
export declare const enum SeriesType {
  Bars = 0,
  Candles = 1,
  Line = 2,
  Area = 3,
  HeikenAshi = 8,
  HollowCandles = 9,
  Baseline = 10,
  HiLo = 12,
  Column = 13,
  LineWithMarkers = 14,
  Stepline = 15,
  HLCArea = 16,
  
  VolumeFootprint = 17,
  Renko = 4,
  Kagi = 5,
  PointAndFigure = 6,
  LineBreak = 7,
}
```

- `VolumeFootprint`: **Beta.** The volume footprint chart type. Requires the `chart_style_volume_footprint` feature.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SeriesType


---

<!-- Public documentation export; not library implementation source. -->
# ServerTimeCallback

[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.

```ts
export type ServerTimeCallback = (serverTime: number) => void;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ServerTimeCallback


---

<!-- Public documentation export; not library implementation source. -->
# SetResolutionOptions

[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.

## dataReady {#dataready}

```ts
dataReady?: () => void;
```

Use the type signature above and the integration guide for the owning capability.

## doNotActivateChart {#donotactivatechart}

```ts
doNotActivateChart?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SetResolutionOptions


---

<!-- Public documentation export; not library implementation source. -->
# SetSymbolOptions

[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.

## dataReady {#dataready}

```ts
dataReady?: () => void;
```

Use the type signature above and the integration guide for the owning capability.

## doNotActivateChart {#donotactivatechart}

```ts
doNotActivateChart?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SetSymbolOptions


---

<!-- Public documentation export; not library implementation source. -->
# SetVisibleRangeOptions

[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.

## applyDefaultRightMargin {#applydefaultrightmargin}

```ts
applyDefaultRightMargin?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## percentRightMargin {#percentrightmargin}

```ts
percentRightMargin?: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SetVisibleRangeOptions


---

<!-- Public documentation export; not library implementation source. -->
# SetVisibleTimeRange

[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.

```ts
export type SetVisibleTimeRange = Omit<VisibleTimeRange, "to"> &
  Partial<Pick<VisibleTimeRange, "to">>;
```

## Related types

- [VisibleTimeRange](https://docs.lumencharts.com/charting-library/api/VisibleTimeRange)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SetVisibleTimeRange


---

<!-- Public documentation export; not library implementation source. -->
# ShapePoint

[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.

```ts
export type ShapePoint = StickedPoint | PricedPoint | TimePoint;
```

## Related types

- [StickedPoint](https://docs.lumencharts.com/charting-library/api/StickedPoint)
- [PricedPoint](https://docs.lumencharts.com/charting-library/api/PricedPoint)
- [TimePoint](https://docs.lumencharts.com/charting-library/api/TimePoint)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ShapePoint


---

<!-- Public documentation export; not library implementation source. -->
# ShapesGroupId

[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.

```ts
export type ShapesGroupId = Nominal<string, "ShapesGroupId">;
```

## Related types

- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ShapesGroupId


---

<!-- Public documentation export; not library implementation source. -->
# SingleChartLayoutType

[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.

```ts
export type SingleChartLayoutType = "s";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SingleChartLayoutType


---

<!-- Public documentation export; not library implementation source. -->
# StickedPoint

[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.

## Extends

[TimePoint](https://docs.lumencharts.com/charting-library/api/TimePoint)

## channel {#channel}

```ts
channel: "open" | "high" | "low" | "close";
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [TimePoint](https://docs.lumencharts.com/charting-library/api/TimePoint)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StickedPoint


---

<!-- Public documentation export; not library implementation source. -->
# StudyArrowsPlotInfo

[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.

## Extends

[StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

## type {#type}

```ts
readonly type: StudyPlotType.Arrows;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyArrowsPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyArrowsPlotPreferences

[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.

## Extends

[StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)

## colorup {#colorup}

```ts
colorup: string;
```

Use the type signature above and the integration guide for the owning capability.

## colordown {#colordown}

```ts
colordown: string;
```

Use the type signature above and the integration guide for the owning capability.

## minHeight {#minheight}

```ts
minHeight?: number;
```

Use the type signature above and the integration guide for the owning capability.

## maxHeight {#maxheight}

```ts
maxHeight?: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyArrowsPlotPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyAvailableConstSources

[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.

```ts
export type StudyAvailableConstSources =
  "open" | "high" | "low" | "close" | "hl2" | "hlc3" | "ohlc4" | "hlcc4";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyAvailableConstSources


---

<!-- Public documentation export; not library implementation source. -->
# StudyBandBackgroundPreferences

[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.

## backgroundColor {#backgroundcolor}

```ts
backgroundColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## transparency {#transparency}

```ts
transparency: number;
```

Use the type signature above and the integration guide for the owning capability.

## fillBackground {#fillbackground}

```ts
fillBackground: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBandBackgroundPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyBandInfo

[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.

## id {#id}

```ts
readonly id?: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
readonly name: string;
```

Use the type signature above and the integration guide for the owning capability.

## isHidden {#ishidden}

```ts
readonly isHidden?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## zorder {#zorder}

```ts
readonly zorder?: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBandInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyBandPreferences

[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.

```ts
export interface StudyBandPreferences extends StudyBandStyle, StudyBandInfo {}
```

## Related types

- [StudyBandStyle](https://docs.lumencharts.com/charting-library/api/StudyBandStyle)
- [StudyBandInfo](https://docs.lumencharts.com/charting-library/api/StudyBandInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBandPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyBandStyle

[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.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## linestyle {#linestyle}

```ts
linestyle: number;
```

Use the type signature above and the integration guide for the owning capability.

## linewidth {#linewidth}

```ts
linewidth: number;
```

Use the type signature above and the integration guide for the owning capability.

## value {#value}

```ts
value: number;
```

Use the type signature above and the integration guide for the owning capability.

## visible {#visible}

```ts
visible: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBandStyle


---

<!-- Public documentation export; not library implementation source. -->
# StudyBarColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.BarColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBarColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyBarTimeInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.BarTime;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: number;
```

Use the type signature above and the integration guide for the owning capability.

## max {#max}

```ts
readonly max: number;
```

Use the type signature above and the integration guide for the owning capability.

## min {#min}

```ts
readonly min: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBarTimeInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyBgColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.BgColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBgColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyBooleanInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Bool;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyBooleanInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyCandleBorderColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo), [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.CandleBorderColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyCandleBorderColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyCandleWickColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo), [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.CandleWickColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyCandleWickColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyCharsPlotInfo

[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.

## Extends

[StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

## type {#type}

```ts
readonly type: StudyPlotType.Chars;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyCharsPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyCharsPlotPreferences

[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.

## Extends

[StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)

## char {#char}

```ts
char?: string;
```

Use the type signature above and the integration guide for the owning capability.

## location {#location}

```ts
location: MarkLocation;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## textColor {#textcolor}

```ts
textColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)
- [MarkLocation](https://docs.lumencharts.com/charting-library/api/MarkLocation)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyCharsPlotPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo), [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.Colorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyColorInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Color;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyColorInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyDataOffsetPlotInfo

[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.

## Extends

[StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.DataOffset;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyDataOffsetPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyDataPlotInfo

[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.

## Extends

[StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.Data;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyDataPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyDefaults

[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.

## areaBackground {#areabackground}

```ts
areaBackground: StudyBandBackgroundPreferences;
```

Use the type signature above and the integration guide for the owning capability.

## bandsBackground {#bandsbackground}

```ts
bandsBackground: StudyBandBackgroundPreferences;
```

Use the type signature above and the integration guide for the owning capability.

## bands {#bands}

```ts
bands: readonly Required<StudyBandStyle>[];
```

Use the type signature above and the integration guide for the owning capability.

## filledAreasStyle {#filledareasstyle}

```ts
filledAreasStyle: MappedObject<StudyFilledAreaStyle>;
```

Use the type signature above and the integration guide for the owning capability.

## inputs {#inputs}

```ts
inputs: StudyInputsSimple;
```

Use the type signature above and the integration guide for the owning capability.

## palettes {#palettes}

```ts
palettes: MappedObject<StudyPaletteStyle>;
```

Use the type signature above and the integration guide for the owning capability.

## precision {#precision}

```ts
precision: number | string;
```

Use the type signature above and the integration guide for the owning capability.

## styles {#styles}

```ts
styles: MappedObject<StudyPlotPreferences>;
```

Use the type signature above and the integration guide for the owning capability.

## ohlcPlots {#ohlcplots}

```ts
ohlcPlots: MappedObject<StudyOhlcPlotPreferences>;
```

Use the type signature above and the integration guide for the owning capability.

## graphics {#graphics}

```ts
graphics: StudyGraphicsDefaults;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyBandBackgroundPreferences](https://docs.lumencharts.com/charting-library/api/StudyBandBackgroundPreferences)
- [StudyBandStyle](https://docs.lumencharts.com/charting-library/api/StudyBandStyle)
- [MappedObject](https://docs.lumencharts.com/charting-library/api/MappedObject)
- [StudyFilledAreaStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyle)
- [StudyInputsSimple](https://docs.lumencharts.com/charting-library/api/StudyInputsSimple)
- [StudyPaletteStyle](https://docs.lumencharts.com/charting-library/api/StudyPaletteStyle)
- [StudyPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotPreferences)
- [StudyOhlcPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotPreferences)
- [StudyGraphicsDefaults](https://docs.lumencharts.com/charting-library/api/StudyGraphicsDefaults)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyDefaults


---

<!-- Public documentation export; not library implementation source. -->
# StudyDownColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo), [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.DownColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyDownColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyEventType

[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.

```ts
export type StudyEventType =
  "create" | "remove" | "price_scale_changed" | "paste_study";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyEventType


---

<!-- Public documentation export; not library implementation source. -->
# StudyFieldDescriptor

[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.

## type {#type}

```ts
type: "value";
```

Use the type signature above and the integration guide for the owning capability.

## sourceType {#sourcetype}

```ts
sourceType: "study";
```

Use the type signature above and the integration guide for the owning capability.

## sourceId {#sourceid}

```ts
sourceId: string;
```

Use the type signature above and the integration guide for the owning capability.

## sourceTitle {#sourcetitle}

```ts
sourceTitle: string;
```

Use the type signature above and the integration guide for the owning capability.

## plotTitle {#plottitle}

```ts
plotTitle: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyFieldDescriptor


---

<!-- Public documentation export; not library implementation source. -->
# StudyFilledAreaGradientColorStyle

[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.

## Extends

[StudyFilledAreaStyleBase](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyleBase)

## fillType {#filltype}

```ts
fillType: "gradient";
```

Use the type signature above and the integration guide for the owning capability.

## topColor {#topcolor}

```ts
topColor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## bottomColor {#bottomcolor}

```ts
bottomColor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## topValue {#topvalue}

```ts
topValue?: number;
```

Use the type signature above and the integration guide for the owning capability.

## bottomValue {#bottomvalue}

```ts
bottomValue?: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyFilledAreaStyleBase](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyleBase)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyFilledAreaGradientColorStyle


---

<!-- Public documentation export; not library implementation source. -->
# StudyFilledAreaInfo

[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.

## id {#id}

```ts
readonly id: string;
```

Use the type signature above and the integration guide for the owning capability.

## objAId {#objaid}

```ts
readonly objAId: string;
```

Use the type signature above and the integration guide for the owning capability.

## objBId {#objbid}

```ts
readonly objBId: string;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
readonly title: string;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
readonly type: FilledAreaType;
```

Use the type signature above and the integration guide for the owning capability.

## fillgaps {#fillgaps}

```ts
readonly fillgaps?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## zorder {#zorder}

```ts
readonly zorder?: number;
```

Use the type signature above and the integration guide for the owning capability.

## isHidden {#ishidden}

```ts
readonly isHidden?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## palette {#palette}

```ts
readonly palette?: string;
```

Use the type signature above and the integration guide for the owning capability.

## topValue {#topvalue}

```ts
readonly topValue?: number;
```

Use the type signature above and the integration guide for the owning capability.

## bottomValue {#bottomvalue}

```ts
readonly bottomValue?: number;
```

Use the type signature above and the integration guide for the owning capability.

## topColor {#topcolor}

```ts
readonly topColor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## bottomColor {#bottomcolor}

```ts
readonly bottomColor?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fillToIntersection {#filltointersection}

```ts
readonly fillToIntersection?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [FilledAreaType](https://docs.lumencharts.com/charting-library/api/FilledAreaType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyFilledAreaInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyFilledAreaSolidColorStyle

[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.

## Extends

[StudyFilledAreaStyleBase](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyleBase)

## fillType {#filltype}

```ts
fillType: undefined;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyFilledAreaStyleBase](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyleBase)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyFilledAreaSolidColorStyle


---

<!-- Public documentation export; not library implementation source. -->
# StudyFilledAreaStyle

[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.

```ts
export type StudyFilledAreaStyle =
  StudyFilledAreaSolidColorStyle | StudyFilledAreaGradientColorStyle;
```

## Related types

- [StudyFilledAreaSolidColorStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaSolidColorStyle)
- [StudyFilledAreaGradientColorStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaGradientColorStyle)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyle


---

<!-- Public documentation export; not library implementation source. -->
# StudyFilledAreaStyleBase

[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.

## visible {#visible}

```ts
visible: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## transparency {#transparency}

```ts
transparency: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyleBase


---

<!-- Public documentation export; not library implementation source. -->
# StudyGraphicsDefaults

[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.

## horizlines {#horizlines}

```ts
horizlines?: ValueByStyleId<HorizLinePreferences>;
```

Use the type signature above and the integration guide for the owning capability.

## polygons {#polygons}

```ts
polygons?: ValueByStyleId<PolygonPreferences>;
```

Use the type signature above and the integration guide for the owning capability.

## hhists {#hhists}

```ts
hhists?: ValueByStyleId<HHistPreferences>;
```

Use the type signature above and the integration guide for the owning capability.

## vertlines {#vertlines}

```ts
vertlines?: ValueByStyleId<VertLinePreferences>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ValueByStyleId](https://docs.lumencharts.com/charting-library/api/ValueByStyleId)
- [HorizLinePreferences](https://docs.lumencharts.com/charting-library/api/HorizLinePreferences)
- [PolygonPreferences](https://docs.lumencharts.com/charting-library/api/PolygonPreferences)
- [HHistPreferences](https://docs.lumencharts.com/charting-library/api/HHistPreferences)
- [VertLinePreferences](https://docs.lumencharts.com/charting-library/api/VertLinePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyGraphicsDefaults


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputBaseInfo

[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.

## id {#id}

```ts
readonly id: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
readonly name: string;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval?: StudyInputValue;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
readonly type: StudyInputType;
```

Use the type signature above and the integration guide for the owning capability.

## confirm {#confirm}

```ts
readonly confirm?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## isHidden {#ishidden}

```ts
readonly isHidden?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## visible {#visible}

```ts
readonly visible?: string;
```

Use the type signature above and the integration guide for the owning capability.

## hideWhenPlotsHidden {#hidewhenplotshidden}

```ts
readonly hideWhenPlotsHidden?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)
- [StudyInputType](https://docs.lumencharts.com/charting-library/api/StudyInputType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputId

[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.

```ts
export type StudyInputId = Nominal<string, "StudyInputId">;
```

## Related types

- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputId


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputInfo

[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.

```ts
export type StudyInputInfo =
  | StudyBooleanInputInfo
  | StudyTextInputInfo
  | StudySymbolInputInfo
  | StudyResolutionInputInfo
  | StudySessionInputInfo
  | StudySourceInputInfo
  | StudyNumericInputInfo
  | StudyPriceInputInfo
  | StudyColorInputInfo
  | StudyTimeInputInfo
  | StudyBarTimeInputInfo
  | StudyTextareaInputInfo;
```

## Related types

- [StudyBooleanInputInfo](https://docs.lumencharts.com/charting-library/api/StudyBooleanInputInfo)
- [StudyTextInputInfo](https://docs.lumencharts.com/charting-library/api/StudyTextInputInfo)
- [StudySymbolInputInfo](https://docs.lumencharts.com/charting-library/api/StudySymbolInputInfo)
- [StudyResolutionInputInfo](https://docs.lumencharts.com/charting-library/api/StudyResolutionInputInfo)
- [StudySessionInputInfo](https://docs.lumencharts.com/charting-library/api/StudySessionInputInfo)
- [StudySourceInputInfo](https://docs.lumencharts.com/charting-library/api/StudySourceInputInfo)
- [StudyNumericInputInfo](https://docs.lumencharts.com/charting-library/api/StudyNumericInputInfo)
- [StudyPriceInputInfo](https://docs.lumencharts.com/charting-library/api/StudyPriceInputInfo)
- [StudyColorInputInfo](https://docs.lumencharts.com/charting-library/api/StudyColorInputInfo)
- [StudyTimeInputInfo](https://docs.lumencharts.com/charting-library/api/StudyTimeInputInfo)
- [StudyBarTimeInputInfo](https://docs.lumencharts.com/charting-library/api/StudyBarTimeInputInfo)
- [StudyTextareaInputInfo](https://docs.lumencharts.com/charting-library/api/StudyTextareaInputInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputInfoList

[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.

```ts
export type StudyInputInfoList = readonly Readonly<StudyInputInfo>[];
```

## Related types

- [StudyInputInfo](https://docs.lumencharts.com/charting-library/api/StudyInputInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputInfoList


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputInformation

[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.

## id {#id}

```ts
id: StudyInputId;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
type: string;
```

Use the type signature above and the integration guide for the owning capability.

## localizedName {#localizedname}

```ts
localizedName: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputId](https://docs.lumencharts.com/charting-library/api/StudyInputId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputInformation


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputOptionsTitles

[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.

## signature {#signature}

```ts
[option: string]: string;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `option` | `string` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputOptionsTitles


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputsSimple

[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.

## signature {#signature}

```ts
[inputId: string]: StudyInputValue;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `inputId` | `string` | Yes |

## Related types

- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputsSimple


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputType

[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.

```ts
export declare const enum StudyInputType {
  Integer = "integer",
  Float = "float",
  Price = "price",
  Bool = "bool",
  Text = "text",
  Symbol = "symbol",
  Session = "session",
  Source = "source",
  Resolution = "resolution",
  Time = "time",
  BarTime = "bar_time",
  Color = "color",
  Textarea = "text_area",
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputType


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputValue

[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.

```ts
export type StudyInputValue = string | number | boolean;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputValue


---

<!-- Public documentation export; not library implementation source. -->
# StudyInputValueItem

[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.

## id {#id}

```ts
id: StudyInputId;
```

Use the type signature above and the integration guide for the owning capability.

## value {#value}

```ts
value: StudyInputValue;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputId](https://docs.lumencharts.com/charting-library/api/StudyInputId)
- [StudyInputValue](https://docs.lumencharts.com/charting-library/api/StudyInputValue)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyInputValueItem


---

<!-- Public documentation export; not library implementation source. -->
# StudyLinePlotInfo

[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.

## Extends

[StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

## type {#type}

```ts
readonly type: StudyPlotType.Line;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyLinePlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyLinePlotPreferences

[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.

## Extends

[StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)

## plottype {#plottype}

```ts
plottype: LineStudyPlotStyle;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## linestyle {#linestyle}

```ts
linestyle: LineStyle;
```

Use the type signature above and the integration guide for the owning capability.

## linewidth {#linewidth}

```ts
linewidth: number;
```

Use the type signature above and the integration guide for the owning capability.

## trackPrice {#trackprice}

```ts
trackPrice: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## showLast {#showlast}

```ts
readonly showLast?: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)
- [LineStudyPlotStyle](https://docs.lumencharts.com/charting-library/api/LineStudyPlotStyle)
- [LineStyle](https://docs.lumencharts.com/charting-library/api/LineStyle)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyLinePlotPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyMetaInfo

[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.

```ts
export type StudyMetaInfo = DeepWriteable<RawStudyMetaInformation> & {
  id: string;
};
```

## Related types

- [DeepWriteable](https://docs.lumencharts.com/charting-library/api/DeepWriteable)
- [RawStudyMetaInformation](https://docs.lumencharts.com/charting-library/api/RawStudyMetaInformation)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyMetaInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyNumericInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type:
    StudyInputType.Integer | StudyInputType.Float | StudyInputType.Price;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: number;
```

Use the type signature above and the integration guide for the owning capability.

## max {#max}

```ts
readonly max?: number;
```

Use the type signature above and the integration guide for the owning capability.

## min {#min}

```ts
readonly min?: number;
```

Use the type signature above and the integration guide for the owning capability.

## step {#step}

```ts
readonly step?: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyNumericInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyOhlcColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo), [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.OhlcColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOhlcColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyOhlcPlotBarsStylePreferences

[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.

## Extends

[StudyOhlcPlotBaseStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBaseStylePreferences)

## plottype {#plottype}

```ts
plottype: OhlcStudyPlotStyle.OhlcBars;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyOhlcPlotBaseStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBaseStylePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBarsStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyOhlcPlotBaseStylePreferences

[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.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## display {#display}

```ts
display: StudyPlotDisplayMode;
```

Use the type signature above and the integration guide for the owning capability.

## visible {#visible}

```ts
visible?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotDisplayMode](https://docs.lumencharts.com/charting-library/api/StudyPlotDisplayMode)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBaseStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyOhlcPlotCandlesStylePreferences

[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.

## Extends

[StudyOhlcPlotBaseStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBaseStylePreferences)

## plottype {#plottype}

```ts
plottype: OhlcStudyPlotStyle.OhlcCandles;
```

Use the type signature above and the integration guide for the owning capability.

## drawWick {#drawwick}

```ts
drawWick: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## drawBorder {#drawborder}

```ts
drawBorder: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## wickColor {#wickcolor}

```ts
wickColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## borderColor {#bordercolor}

```ts
borderColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyOhlcPlotBaseStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBaseStylePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotCandlesStylePreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyOhlcPlotInfo

[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.

## Extends

[StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type:
    | StudyPlotType.OhlcOpen
    | StudyPlotType.OhlcHigh
    | StudyPlotType.OhlcLow
    | StudyPlotType.OhlcClose;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyOhlcPlotPreferences

[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.

```ts
export type StudyOhlcPlotPreferences =
  StudyOhlcPlotBarsStylePreferences | StudyOhlcPlotCandlesStylePreferences;
```

## Related types

- [StudyOhlcPlotBarsStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotBarsStylePreferences)
- [StudyOhlcPlotCandlesStylePreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotCandlesStylePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyOhlcStylesInfo

[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.

## title {#title}

```ts
readonly title: string;
```

Use the type signature above and the integration guide for the owning capability.

## isHidden {#ishidden}

```ts
readonly isHidden?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## drawBorder {#drawborder}

```ts
readonly drawBorder?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## showLast {#showlast}

```ts
readonly showLast?: number;
```

Use the type signature above and the integration guide for the owning capability.

## format {#format}

```ts
readonly format?: Partial<StudyPlotValuePrecisionFormat>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotValuePrecisionFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValuePrecisionFormat)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOhlcStylesInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyOrDrawingAddedToChartEventParams

[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.

## value {#value}

```ts
value: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOrDrawingAddedToChartEventParams


---

<!-- Public documentation export; not library implementation source. -->
# StudyOverrides

[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.

## 52 week high/low.high source {#52-20-week-20-high-2f-low-2e-high-20-source}

```ts
"52 week high/low.high source": string;
```

Use the type signature above and the integration guide for the owning capability.

## 52 week high/low.low source {#52-20-week-20-high-2f-low-2e-low-20-source}

```ts
"52 week high/low.low source": string;
```

Use the type signature above and the integration guide for the owning capability.

## accelerator oscillator.plot.display {#accelerator-20-oscillator-2e-plot-2e-display}

```ts
"accelerator oscillator.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## accelerator oscillator.plot.linestyle {#accelerator-20-oscillator-2e-plot-2e-linestyle}

```ts
"accelerator oscillator.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## accelerator oscillator.plot.linewidth {#accelerator-20-oscillator-2e-plot-2e-linewidth}

```ts
"accelerator oscillator.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## accelerator oscillator.plot.plottype {#accelerator-20-oscillator-2e-plot-2e-plottype}

```ts
"accelerator oscillator.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## accelerator oscillator.plot.trackprice {#accelerator-20-oscillator-2e-plot-2e-trackprice}

```ts
"accelerator oscillator.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## accelerator oscillator.plot.transparency {#accelerator-20-oscillator-2e-plot-2e-transparency}

```ts
"accelerator oscillator.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## accelerator oscillator.plot.color {#accelerator-20-oscillator-2e-plot-2e-color}

```ts
"accelerator oscillator.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## accumulation/distribution.plot.display {#accumulation-2f-distribution-2e-plot-2e-display}

```ts
"accumulation/distribution.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulation/distribution.plot.linestyle {#accumulation-2f-distribution-2e-plot-2e-linestyle}

```ts
"accumulation/distribution.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulation/distribution.plot.linewidth {#accumulation-2f-distribution-2e-plot-2e-linewidth}

```ts
"accumulation/distribution.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulation/distribution.plot.plottype {#accumulation-2f-distribution-2e-plot-2e-plottype}

```ts
"accumulation/distribution.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## accumulation/distribution.plot.trackprice {#accumulation-2f-distribution-2e-plot-2e-trackprice}

```ts
"accumulation/distribution.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## accumulation/distribution.plot.transparency {#accumulation-2f-distribution-2e-plot-2e-transparency}

```ts
"accumulation/distribution.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulation/distribution.plot.color {#accumulation-2f-distribution-2e-plot-2e-color}

```ts
"accumulation/distribution.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.asi.display {#accumulative-20-swing-20-index-2e-asi-2e-display}

```ts
"accumulative swing index.asi.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.asi.linestyle {#accumulative-20-swing-20-index-2e-asi-2e-linestyle}

```ts
"accumulative swing index.asi.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.asi.linewidth {#accumulative-20-swing-20-index-2e-asi-2e-linewidth}

```ts
"accumulative swing index.asi.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.asi.plottype {#accumulative-20-swing-20-index-2e-asi-2e-plottype}

```ts
"accumulative swing index.asi.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.asi.trackprice {#accumulative-20-swing-20-index-2e-asi-2e-trackprice}

```ts
"accumulative swing index.asi.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.asi.transparency {#accumulative-20-swing-20-index-2e-asi-2e-transparency}

```ts
"accumulative swing index.asi.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.asi.color {#accumulative-20-swing-20-index-2e-asi-2e-color}

```ts
"accumulative swing index.asi.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## accumulative swing index.limit move value {#accumulative-20-swing-20-index-2e-limit-20-move-20-value}

```ts
"accumulative swing index.limit move value": number;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.plot.display {#advance-2f-decline-2e-plot-2e-display}

```ts
"advance/decline.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.plot.linestyle {#advance-2f-decline-2e-plot-2e-linestyle}

```ts
"advance/decline.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.plot.linewidth {#advance-2f-decline-2e-plot-2e-linewidth}

```ts
"advance/decline.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.plot.plottype {#advance-2f-decline-2e-plot-2e-plottype}

```ts
"advance/decline.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.plot.trackprice {#advance-2f-decline-2e-plot-2e-trackprice}

```ts
"advance/decline.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.plot.transparency {#advance-2f-decline-2e-plot-2e-transparency}

```ts
"advance/decline.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.plot.color {#advance-2f-decline-2e-plot-2e-color}

```ts
"advance/decline.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## advance/decline.length {#advance-2f-decline-2e-length}

```ts
"advance/decline.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.vwap.display {#anchored-20-vwap-2e-vwap-2e-display}

```ts
"anchored vwap.vwap.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.vwap.color {#anchored-20-vwap-2e-vwap-2e-color}

```ts
"anchored vwap.vwap.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.vwap.linestyle {#anchored-20-vwap-2e-vwap-2e-linestyle}

```ts
"anchored vwap.vwap.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.vwap.linewidth {#anchored-20-vwap-2e-vwap-2e-linewidth}

```ts
"anchored vwap.vwap.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.vwap.plottype {#anchored-20-vwap-2e-vwap-2e-plottype}

```ts
"anchored vwap.vwap.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.vwap.trackprice {#anchored-20-vwap-2e-vwap-2e-trackprice}

```ts
"anchored vwap.vwap.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.vwap.transparency {#anchored-20-vwap-2e-vwap-2e-transparency}

```ts
"anchored vwap.vwap.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.start time {#anchored-20-vwap-2e-start-20-time}

```ts
"anchored vwap.start time": number;
```

Use the type signature above and the integration guide for the owning capability.

## anchored vwap.source {#anchored-20-vwap-2e-source}

```ts
"anchored vwap.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.plot.display {#arnaud-20-legoux-20-moving-20-average-2e-plot-2e-display}

```ts
"arnaud legoux moving average.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.plot.linestyle {#arnaud-20-legoux-20-moving-20-average-2e-plot-2e-linestyle}

```ts
"arnaud legoux moving average.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.plot.linewidth {#arnaud-20-legoux-20-moving-20-average-2e-plot-2e-linewidth}

```ts
"arnaud legoux moving average.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.plot.plottype {#arnaud-20-legoux-20-moving-20-average-2e-plot-2e-plottype}

```ts
"arnaud legoux moving average.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.plot.trackprice {#arnaud-20-legoux-20-moving-20-average-2e-plot-2e-trackprice}

```ts
"arnaud legoux moving average.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.plot.transparency {#arnaud-20-legoux-20-moving-20-average-2e-plot-2e-transparency}

```ts
"arnaud legoux moving average.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.plot.color {#arnaud-20-legoux-20-moving-20-average-2e-plot-2e-color}

```ts
"arnaud legoux moving average.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.window size {#arnaud-20-legoux-20-moving-20-average-2e-window-20-size}

```ts
"arnaud legoux moving average.window size": number;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.offset {#arnaud-20-legoux-20-moving-20-average-2e-offset}

```ts
"arnaud legoux moving average.offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## arnaud legoux moving average.sigma {#arnaud-20-legoux-20-moving-20-average-2e-sigma}

```ts
"arnaud legoux moving average.sigma": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.upper.display {#aroon-2e-upper-2e-display}

```ts
"aroon.upper.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.upper.linestyle {#aroon-2e-upper-2e-linestyle}

```ts
"aroon.upper.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.upper.linewidth {#aroon-2e-upper-2e-linewidth}

```ts
"aroon.upper.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.upper.plottype {#aroon-2e-upper-2e-plottype}

```ts
"aroon.upper.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.upper.trackprice {#aroon-2e-upper-2e-trackprice}

```ts
"aroon.upper.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.upper.transparency {#aroon-2e-upper-2e-transparency}

```ts
"aroon.upper.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.upper.color {#aroon-2e-upper-2e-color}

```ts
"aroon.upper.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.lower.display {#aroon-2e-lower-2e-display}

```ts
"aroon.lower.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.lower.linestyle {#aroon-2e-lower-2e-linestyle}

```ts
"aroon.lower.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.lower.linewidth {#aroon-2e-lower-2e-linewidth}

```ts
"aroon.lower.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.lower.plottype {#aroon-2e-lower-2e-plottype}

```ts
"aroon.lower.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.lower.trackprice {#aroon-2e-lower-2e-trackprice}

```ts
"aroon.lower.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.lower.transparency {#aroon-2e-lower-2e-transparency}

```ts
"aroon.lower.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.lower.color {#aroon-2e-lower-2e-color}

```ts
"aroon.lower.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## aroon.length {#aroon-2e-length}

```ts
"aroon.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx.display {#average-20-directional-20-index-2e-adx-2e-display}

```ts
"average directional index.adx.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx.linestyle {#average-20-directional-20-index-2e-adx-2e-linestyle}

```ts
"average directional index.adx.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx.linewidth {#average-20-directional-20-index-2e-adx-2e-linewidth}

```ts
"average directional index.adx.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx.plottype {#average-20-directional-20-index-2e-adx-2e-plottype}

```ts
"average directional index.adx.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx.trackprice {#average-20-directional-20-index-2e-adx-2e-trackprice}

```ts
"average directional index.adx.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx.transparency {#average-20-directional-20-index-2e-adx-2e-transparency}

```ts
"average directional index.adx.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx.color {#average-20-directional-20-index-2e-adx-2e-color}

```ts
"average directional index.adx.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.adx smoothing {#average-20-directional-20-index-2e-adx-20-smoothing}

```ts
"average directional index.adx smoothing": number;
```

Use the type signature above and the integration guide for the owning capability.

## average directional index.di length {#average-20-directional-20-index-2e-di-20-length}

```ts
"average directional index.di length": number;
```

Use the type signature above and the integration guide for the owning capability.

## average price.plot.display {#average-20-price-2e-plot-2e-display}

```ts
"average price.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## average price.plot.linestyle {#average-20-price-2e-plot-2e-linestyle}

```ts
"average price.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## average price.plot.linewidth {#average-20-price-2e-plot-2e-linewidth}

```ts
"average price.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## average price.plot.plottype {#average-20-price-2e-plot-2e-plottype}

```ts
"average price.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## average price.plot.trackprice {#average-20-price-2e-plot-2e-trackprice}

```ts
"average price.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## average price.plot.transparency {#average-20-price-2e-plot-2e-transparency}

```ts
"average price.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## average price.plot.color {#average-20-price-2e-plot-2e-color}

```ts
"average price.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.plot.display {#average-20-true-20-range-2e-plot-2e-display}

```ts
"average true range.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.plot.linestyle {#average-20-true-20-range-2e-plot-2e-linestyle}

```ts
"average true range.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.plot.linewidth {#average-20-true-20-range-2e-plot-2e-linewidth}

```ts
"average true range.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.plot.plottype {#average-20-true-20-range-2e-plot-2e-plottype}

```ts
"average true range.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.plot.trackprice {#average-20-true-20-range-2e-plot-2e-trackprice}

```ts
"average true range.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.plot.transparency {#average-20-true-20-range-2e-plot-2e-transparency}

```ts
"average true range.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.plot.color {#average-20-true-20-range-2e-plot-2e-color}

```ts
"average true range.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## average true range.length {#average-20-true-20-range-2e-length}

```ts
"average true range.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## awesome oscillator.plot.display {#awesome-20-oscillator-2e-plot-2e-display}

```ts
"awesome oscillator.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## awesome oscillator.plot.linestyle {#awesome-20-oscillator-2e-plot-2e-linestyle}

```ts
"awesome oscillator.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## awesome oscillator.plot.linewidth {#awesome-20-oscillator-2e-plot-2e-linewidth}

```ts
"awesome oscillator.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## awesome oscillator.plot.plottype {#awesome-20-oscillator-2e-plot-2e-plottype}

```ts
"awesome oscillator.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## awesome oscillator.plot.trackprice {#awesome-20-oscillator-2e-plot-2e-trackprice}

```ts
"awesome oscillator.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## awesome oscillator.plot.transparency {#awesome-20-oscillator-2e-plot-2e-transparency}

```ts
"awesome oscillator.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## awesome oscillator.plot.color {#awesome-20-oscillator-2e-plot-2e-color}

```ts
"awesome oscillator.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## balance of power.plot.display {#balance-20-of-20-power-2e-plot-2e-display}

```ts
"balance of power.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## balance of power.plot.linestyle {#balance-20-of-20-power-2e-plot-2e-linestyle}

```ts
"balance of power.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## balance of power.plot.linewidth {#balance-20-of-20-power-2e-plot-2e-linewidth}

```ts
"balance of power.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## balance of power.plot.plottype {#balance-20-of-20-power-2e-plot-2e-plottype}

```ts
"balance of power.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## balance of power.plot.trackprice {#balance-20-of-20-power-2e-plot-2e-trackprice}

```ts
"balance of power.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## balance of power.plot.transparency {#balance-20-of-20-power-2e-plot-2e-transparency}

```ts
"balance of power.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## balance of power.plot.color {#balance-20-of-20-power-2e-plot-2e-color}

```ts
"balance of power.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.plots background.color {#bollinger-20-bands-2e-plots-20-background-2e-color}

```ts
"bollinger bands.plots background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.plots background.transparency {#bollinger-20-bands-2e-plots-20-background-2e-transparency}

```ts
"bollinger bands.plots background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.plots background.visible {#bollinger-20-bands-2e-plots-20-background-2e-visible}

```ts
"bollinger bands.plots background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.median.display {#bollinger-20-bands-2e-median-2e-display}

```ts
"bollinger bands.median.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.median.linestyle {#bollinger-20-bands-2e-median-2e-linestyle}

```ts
"bollinger bands.median.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.median.linewidth {#bollinger-20-bands-2e-median-2e-linewidth}

```ts
"bollinger bands.median.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.median.plottype {#bollinger-20-bands-2e-median-2e-plottype}

```ts
"bollinger bands.median.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.median.trackprice {#bollinger-20-bands-2e-median-2e-trackprice}

```ts
"bollinger bands.median.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.median.transparency {#bollinger-20-bands-2e-median-2e-transparency}

```ts
"bollinger bands.median.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.median.color {#bollinger-20-bands-2e-median-2e-color}

```ts
"bollinger bands.median.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.upper.display {#bollinger-20-bands-2e-upper-2e-display}

```ts
"bollinger bands.upper.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.upper.linestyle {#bollinger-20-bands-2e-upper-2e-linestyle}

```ts
"bollinger bands.upper.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.upper.linewidth {#bollinger-20-bands-2e-upper-2e-linewidth}

```ts
"bollinger bands.upper.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.upper.plottype {#bollinger-20-bands-2e-upper-2e-plottype}

```ts
"bollinger bands.upper.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.upper.trackprice {#bollinger-20-bands-2e-upper-2e-trackprice}

```ts
"bollinger bands.upper.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.upper.transparency {#bollinger-20-bands-2e-upper-2e-transparency}

```ts
"bollinger bands.upper.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.upper.color {#bollinger-20-bands-2e-upper-2e-color}

```ts
"bollinger bands.upper.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.lower.display {#bollinger-20-bands-2e-lower-2e-display}

```ts
"bollinger bands.lower.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.lower.linestyle {#bollinger-20-bands-2e-lower-2e-linestyle}

```ts
"bollinger bands.lower.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.lower.linewidth {#bollinger-20-bands-2e-lower-2e-linewidth}

```ts
"bollinger bands.lower.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.lower.plottype {#bollinger-20-bands-2e-lower-2e-plottype}

```ts
"bollinger bands.lower.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.lower.trackprice {#bollinger-20-bands-2e-lower-2e-trackprice}

```ts
"bollinger bands.lower.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.lower.transparency {#bollinger-20-bands-2e-lower-2e-transparency}

```ts
"bollinger bands.lower.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.lower.color {#bollinger-20-bands-2e-lower-2e-color}

```ts
"bollinger bands.lower.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.length {#bollinger-20-bands-2e-length}

```ts
"bollinger bands.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands.mult {#bollinger-20-bands-2e-mult}

```ts
"bollinger bands.mult": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.hlines background.color {#bollinger-20-bands-20--25-b-2e-hlines-20-background-2e-color}

```ts
"bollinger bands %b.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.hlines background.transparency {#bollinger-20-bands-20--25-b-2e-hlines-20-background-2e-transparency}

```ts
"bollinger bands %b.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.hlines background.visible {#bollinger-20-bands-20--25-b-2e-hlines-20-background-2e-visible}

```ts
"bollinger bands %b.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.upperlimit.color {#bollinger-20-bands-20--25-b-2e-upperlimit-2e-color}

```ts
"bollinger bands %b.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.upperlimit.linestyle {#bollinger-20-bands-20--25-b-2e-upperlimit-2e-linestyle}

```ts
"bollinger bands %b.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.upperlimit.linewidth {#bollinger-20-bands-20--25-b-2e-upperlimit-2e-linewidth}

```ts
"bollinger bands %b.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.upperlimit.visible {#bollinger-20-bands-20--25-b-2e-upperlimit-2e-visible}

```ts
"bollinger bands %b.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.upperlimit.value {#bollinger-20-bands-20--25-b-2e-upperlimit-2e-value}

```ts
"bollinger bands %b.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.lowerlimit.color {#bollinger-20-bands-20--25-b-2e-lowerlimit-2e-color}

```ts
"bollinger bands %b.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.lowerlimit.linestyle {#bollinger-20-bands-20--25-b-2e-lowerlimit-2e-linestyle}

```ts
"bollinger bands %b.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.lowerlimit.linewidth {#bollinger-20-bands-20--25-b-2e-lowerlimit-2e-linewidth}

```ts
"bollinger bands %b.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.lowerlimit.visible {#bollinger-20-bands-20--25-b-2e-lowerlimit-2e-visible}

```ts
"bollinger bands %b.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.lowerlimit.value {#bollinger-20-bands-20--25-b-2e-lowerlimit-2e-value}

```ts
"bollinger bands %b.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.plot.display {#bollinger-20-bands-20--25-b-2e-plot-2e-display}

```ts
"bollinger bands %b.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.plot.linestyle {#bollinger-20-bands-20--25-b-2e-plot-2e-linestyle}

```ts
"bollinger bands %b.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.plot.linewidth {#bollinger-20-bands-20--25-b-2e-plot-2e-linewidth}

```ts
"bollinger bands %b.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.plot.plottype {#bollinger-20-bands-20--25-b-2e-plot-2e-plottype}

```ts
"bollinger bands %b.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.plot.trackprice {#bollinger-20-bands-20--25-b-2e-plot-2e-trackprice}

```ts
"bollinger bands %b.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.plot.transparency {#bollinger-20-bands-20--25-b-2e-plot-2e-transparency}

```ts
"bollinger bands %b.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.plot.color {#bollinger-20-bands-20--25-b-2e-plot-2e-color}

```ts
"bollinger bands %b.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.length {#bollinger-20-bands-20--25-b-2e-length}

```ts
"bollinger bands %b.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands %b.mult {#bollinger-20-bands-20--25-b-2e-mult}

```ts
"bollinger bands %b.mult": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.plot.display {#bollinger-20-bands-20-width-2e-plot-2e-display}

```ts
"bollinger bands width.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.plot.linestyle {#bollinger-20-bands-20-width-2e-plot-2e-linestyle}

```ts
"bollinger bands width.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.plot.linewidth {#bollinger-20-bands-20-width-2e-plot-2e-linewidth}

```ts
"bollinger bands width.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.plot.plottype {#bollinger-20-bands-20-width-2e-plot-2e-plottype}

```ts
"bollinger bands width.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.plot.trackprice {#bollinger-20-bands-20-width-2e-plot-2e-trackprice}

```ts
"bollinger bands width.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.plot.transparency {#bollinger-20-bands-20-width-2e-plot-2e-transparency}

```ts
"bollinger bands width.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.plot.color {#bollinger-20-bands-20-width-2e-plot-2e-color}

```ts
"bollinger bands width.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.length {#bollinger-20-bands-20-width-2e-length}

```ts
"bollinger bands width.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## bollinger bands width.mult {#bollinger-20-bands-20-width-2e-mult}

```ts
"bollinger bands width.mult": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.zero.color {#chaikin-20-money-20-flow-2e-zero-2e-color}

```ts
"chaikin money flow.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.zero.linestyle {#chaikin-20-money-20-flow-2e-zero-2e-linestyle}

```ts
"chaikin money flow.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.zero.linewidth {#chaikin-20-money-20-flow-2e-zero-2e-linewidth}

```ts
"chaikin money flow.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.zero.visible {#chaikin-20-money-20-flow-2e-zero-2e-visible}

```ts
"chaikin money flow.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.zero.value {#chaikin-20-money-20-flow-2e-zero-2e-value}

```ts
"chaikin money flow.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.plot.display {#chaikin-20-money-20-flow-2e-plot-2e-display}

```ts
"chaikin money flow.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.plot.linestyle {#chaikin-20-money-20-flow-2e-plot-2e-linestyle}

```ts
"chaikin money flow.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.plot.linewidth {#chaikin-20-money-20-flow-2e-plot-2e-linewidth}

```ts
"chaikin money flow.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.plot.plottype {#chaikin-20-money-20-flow-2e-plot-2e-plottype}

```ts
"chaikin money flow.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.plot.trackprice {#chaikin-20-money-20-flow-2e-plot-2e-trackprice}

```ts
"chaikin money flow.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.plot.transparency {#chaikin-20-money-20-flow-2e-plot-2e-transparency}

```ts
"chaikin money flow.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.plot.color {#chaikin-20-money-20-flow-2e-plot-2e-color}

```ts
"chaikin money flow.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin money flow.length {#chaikin-20-money-20-flow-2e-length}

```ts
"chaikin money flow.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.zero.color {#chaikin-20-oscillator-2e-zero-2e-color}

```ts
"chaikin oscillator.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.zero.linestyle {#chaikin-20-oscillator-2e-zero-2e-linestyle}

```ts
"chaikin oscillator.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.zero.linewidth {#chaikin-20-oscillator-2e-zero-2e-linewidth}

```ts
"chaikin oscillator.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.zero.visible {#chaikin-20-oscillator-2e-zero-2e-visible}

```ts
"chaikin oscillator.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.zero.value {#chaikin-20-oscillator-2e-zero-2e-value}

```ts
"chaikin oscillator.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.plot.display {#chaikin-20-oscillator-2e-plot-2e-display}

```ts
"chaikin oscillator.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.plot.linestyle {#chaikin-20-oscillator-2e-plot-2e-linestyle}

```ts
"chaikin oscillator.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.plot.linewidth {#chaikin-20-oscillator-2e-plot-2e-linewidth}

```ts
"chaikin oscillator.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.plot.plottype {#chaikin-20-oscillator-2e-plot-2e-plottype}

```ts
"chaikin oscillator.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.plot.trackprice {#chaikin-20-oscillator-2e-plot-2e-trackprice}

```ts
"chaikin oscillator.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.plot.transparency {#chaikin-20-oscillator-2e-plot-2e-transparency}

```ts
"chaikin oscillator.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.plot.color {#chaikin-20-oscillator-2e-plot-2e-color}

```ts
"chaikin oscillator.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.short {#chaikin-20-oscillator-2e-short}

```ts
"chaikin oscillator.short": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin oscillator.long {#chaikin-20-oscillator-2e-long}

```ts
"chaikin oscillator.long": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.zero.color {#chaikin-20-volatility-2e-zero-2e-color}

```ts
"chaikin volatility.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.zero.linestyle {#chaikin-20-volatility-2e-zero-2e-linestyle}

```ts
"chaikin volatility.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.zero.linewidth {#chaikin-20-volatility-2e-zero-2e-linewidth}

```ts
"chaikin volatility.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.zero.visible {#chaikin-20-volatility-2e-zero-2e-visible}

```ts
"chaikin volatility.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.zero.value {#chaikin-20-volatility-2e-zero-2e-value}

```ts
"chaikin volatility.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.plot.display {#chaikin-20-volatility-2e-plot-2e-display}

```ts
"chaikin volatility.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.plot.linestyle {#chaikin-20-volatility-2e-plot-2e-linestyle}

```ts
"chaikin volatility.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.plot.linewidth {#chaikin-20-volatility-2e-plot-2e-linewidth}

```ts
"chaikin volatility.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.plot.plottype {#chaikin-20-volatility-2e-plot-2e-plottype}

```ts
"chaikin volatility.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.plot.trackprice {#chaikin-20-volatility-2e-plot-2e-trackprice}

```ts
"chaikin volatility.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.plot.transparency {#chaikin-20-volatility-2e-plot-2e-transparency}

```ts
"chaikin volatility.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.plot.color {#chaikin-20-volatility-2e-plot-2e-color}

```ts
"chaikin volatility.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.periods {#chaikin-20-volatility-2e-periods}

```ts
"chaikin volatility.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## chaikin volatility.rate of change lookback {#chaikin-20-volatility-2e-rate-20-of-20-change-20-lookback}

```ts
"chaikin volatility.rate of change lookback": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.long.display {#chande-20-kroll-20-stop-2e-long-2e-display}

```ts
"chande kroll stop.long.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.long.linestyle {#chande-20-kroll-20-stop-2e-long-2e-linestyle}

```ts
"chande kroll stop.long.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.long.linewidth {#chande-20-kroll-20-stop-2e-long-2e-linewidth}

```ts
"chande kroll stop.long.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.long.plottype {#chande-20-kroll-20-stop-2e-long-2e-plottype}

```ts
"chande kroll stop.long.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.long.trackprice {#chande-20-kroll-20-stop-2e-long-2e-trackprice}

```ts
"chande kroll stop.long.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.long.transparency {#chande-20-kroll-20-stop-2e-long-2e-transparency}

```ts
"chande kroll stop.long.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.long.color {#chande-20-kroll-20-stop-2e-long-2e-color}

```ts
"chande kroll stop.long.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.short.display {#chande-20-kroll-20-stop-2e-short-2e-display}

```ts
"chande kroll stop.short.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.short.linestyle {#chande-20-kroll-20-stop-2e-short-2e-linestyle}

```ts
"chande kroll stop.short.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.short.linewidth {#chande-20-kroll-20-stop-2e-short-2e-linewidth}

```ts
"chande kroll stop.short.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.short.plottype {#chande-20-kroll-20-stop-2e-short-2e-plottype}

```ts
"chande kroll stop.short.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.short.trackprice {#chande-20-kroll-20-stop-2e-short-2e-trackprice}

```ts
"chande kroll stop.short.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.short.transparency {#chande-20-kroll-20-stop-2e-short-2e-transparency}

```ts
"chande kroll stop.short.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.short.color {#chande-20-kroll-20-stop-2e-short-2e-color}

```ts
"chande kroll stop.short.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.p {#chande-20-kroll-20-stop-2e-p}

```ts
"chande kroll stop.p": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.x {#chande-20-kroll-20-stop-2e-x}

```ts
"chande kroll stop.x": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande kroll stop.q {#chande-20-kroll-20-stop-2e-q}

```ts
"chande kroll stop.q": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.plot.display {#chande-20-momentum-20-oscillator-2e-plot-2e-display}

```ts
"chande momentum oscillator.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.plot.linestyle {#chande-20-momentum-20-oscillator-2e-plot-2e-linestyle}

```ts
"chande momentum oscillator.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.plot.linewidth {#chande-20-momentum-20-oscillator-2e-plot-2e-linewidth}

```ts
"chande momentum oscillator.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.plot.plottype {#chande-20-momentum-20-oscillator-2e-plot-2e-plottype}

```ts
"chande momentum oscillator.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.plot.trackprice {#chande-20-momentum-20-oscillator-2e-plot-2e-trackprice}

```ts
"chande momentum oscillator.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.plot.transparency {#chande-20-momentum-20-oscillator-2e-plot-2e-transparency}

```ts
"chande momentum oscillator.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.plot.color {#chande-20-momentum-20-oscillator-2e-plot-2e-color}

```ts
"chande momentum oscillator.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## chande momentum oscillator.length {#chande-20-momentum-20-oscillator-2e-length}

```ts
"chande momentum oscillator.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## chop zone.plot.display {#chop-20-zone-2e-plot-2e-display}

```ts
"chop zone.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## chop zone.plot.linestyle {#chop-20-zone-2e-plot-2e-linestyle}

```ts
"chop zone.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## chop zone.plot.linewidth {#chop-20-zone-2e-plot-2e-linewidth}

```ts
"chop zone.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## chop zone.plot.plottype {#chop-20-zone-2e-plot-2e-plottype}

```ts
"chop zone.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## chop zone.plot.trackprice {#chop-20-zone-2e-plot-2e-trackprice}

```ts
"chop zone.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## chop zone.plot.transparency {#chop-20-zone-2e-plot-2e-transparency}

```ts
"chop zone.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## chop zone.plot.color {#chop-20-zone-2e-plot-2e-color}

```ts
"chop zone.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.hlines background.color {#choppiness-20-index-2e-hlines-20-background-2e-color}

```ts
"choppiness index.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.hlines background.transparency {#choppiness-20-index-2e-hlines-20-background-2e-transparency}

```ts
"choppiness index.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.hlines background.visible {#choppiness-20-index-2e-hlines-20-background-2e-visible}

```ts
"choppiness index.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.upperlimit.color {#choppiness-20-index-2e-upperlimit-2e-color}

```ts
"choppiness index.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.upperlimit.linestyle {#choppiness-20-index-2e-upperlimit-2e-linestyle}

```ts
"choppiness index.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.upperlimit.linewidth {#choppiness-20-index-2e-upperlimit-2e-linewidth}

```ts
"choppiness index.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.upperlimit.visible {#choppiness-20-index-2e-upperlimit-2e-visible}

```ts
"choppiness index.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.upperlimit.value {#choppiness-20-index-2e-upperlimit-2e-value}

```ts
"choppiness index.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.lowerlimit.color {#choppiness-20-index-2e-lowerlimit-2e-color}

```ts
"choppiness index.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.lowerlimit.linestyle {#choppiness-20-index-2e-lowerlimit-2e-linestyle}

```ts
"choppiness index.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.lowerlimit.linewidth {#choppiness-20-index-2e-lowerlimit-2e-linewidth}

```ts
"choppiness index.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.lowerlimit.visible {#choppiness-20-index-2e-lowerlimit-2e-visible}

```ts
"choppiness index.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.lowerlimit.value {#choppiness-20-index-2e-lowerlimit-2e-value}

```ts
"choppiness index.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.plot.display {#choppiness-20-index-2e-plot-2e-display}

```ts
"choppiness index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.plot.linestyle {#choppiness-20-index-2e-plot-2e-linestyle}

```ts
"choppiness index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.plot.linewidth {#choppiness-20-index-2e-plot-2e-linewidth}

```ts
"choppiness index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.plot.plottype {#choppiness-20-index-2e-plot-2e-plottype}

```ts
"choppiness index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.plot.trackprice {#choppiness-20-index-2e-plot-2e-trackprice}

```ts
"choppiness index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.plot.transparency {#choppiness-20-index-2e-plot-2e-transparency}

```ts
"choppiness index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.plot.color {#choppiness-20-index-2e-plot-2e-color}

```ts
"choppiness index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## choppiness index.length {#choppiness-20-index-2e-length}

```ts
"choppiness index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.hlines background.color {#commodity-20-channel-20-index-2e-hlines-20-background-2e-color}

```ts
"commodity channel index.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.hlines background.transparency {#commodity-20-channel-20-index-2e-hlines-20-background-2e-transparency}

```ts
"commodity channel index.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.hlines background.visible {#commodity-20-channel-20-index-2e-hlines-20-background-2e-visible}

```ts
"commodity channel index.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.upperlimit.color {#commodity-20-channel-20-index-2e-upperlimit-2e-color}

```ts
"commodity channel index.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.upperlimit.linestyle {#commodity-20-channel-20-index-2e-upperlimit-2e-linestyle}

```ts
"commodity channel index.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.upperlimit.linewidth {#commodity-20-channel-20-index-2e-upperlimit-2e-linewidth}

```ts
"commodity channel index.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.upperlimit.visible {#commodity-20-channel-20-index-2e-upperlimit-2e-visible}

```ts
"commodity channel index.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.upperlimit.value {#commodity-20-channel-20-index-2e-upperlimit-2e-value}

```ts
"commodity channel index.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.lowerlimit.color {#commodity-20-channel-20-index-2e-lowerlimit-2e-color}

```ts
"commodity channel index.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.lowerlimit.linestyle {#commodity-20-channel-20-index-2e-lowerlimit-2e-linestyle}

```ts
"commodity channel index.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.lowerlimit.linewidth {#commodity-20-channel-20-index-2e-lowerlimit-2e-linewidth}

```ts
"commodity channel index.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.lowerlimit.visible {#commodity-20-channel-20-index-2e-lowerlimit-2e-visible}

```ts
"commodity channel index.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.lowerlimit.value {#commodity-20-channel-20-index-2e-lowerlimit-2e-value}

```ts
"commodity channel index.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.plot.display {#commodity-20-channel-20-index-2e-plot-2e-display}

```ts
"commodity channel index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.plot.linestyle {#commodity-20-channel-20-index-2e-plot-2e-linestyle}

```ts
"commodity channel index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.plot.linewidth {#commodity-20-channel-20-index-2e-plot-2e-linewidth}

```ts
"commodity channel index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.plot.plottype {#commodity-20-channel-20-index-2e-plot-2e-plottype}

```ts
"commodity channel index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.plot.trackprice {#commodity-20-channel-20-index-2e-plot-2e-trackprice}

```ts
"commodity channel index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.plot.transparency {#commodity-20-channel-20-index-2e-plot-2e-transparency}

```ts
"commodity channel index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.plot.color {#commodity-20-channel-20-index-2e-plot-2e-color}

```ts
"commodity channel index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothed ma.display {#commodity-20-channel-20-index-2e-smoothed-20-ma-2e-display}

```ts
"commodity channel index.smoothed ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothed ma.linestyle {#commodity-20-channel-20-index-2e-smoothed-20-ma-2e-linestyle}

```ts
"commodity channel index.smoothed ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothed ma.linewidth {#commodity-20-channel-20-index-2e-smoothed-20-ma-2e-linewidth}

```ts
"commodity channel index.smoothed ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothed ma.plottype {#commodity-20-channel-20-index-2e-smoothed-20-ma-2e-plottype}

```ts
"commodity channel index.smoothed ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothed ma.trackprice {#commodity-20-channel-20-index-2e-smoothed-20-ma-2e-trackprice}

```ts
"commodity channel index.smoothed ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothed ma.transparency {#commodity-20-channel-20-index-2e-smoothed-20-ma-2e-transparency}

```ts
"commodity channel index.smoothed ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.length {#commodity-20-channel-20-index-2e-length}

```ts
"commodity channel index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothing line {#commodity-20-channel-20-index-2e-smoothing-20-line}

```ts
"commodity channel index.smoothing line": string;
```

Use the type signature above and the integration guide for the owning capability.

## commodity channel index.smoothing length {#commodity-20-channel-20-index-2e-smoothing-20-length}

```ts
"commodity channel index.smoothing length": number;
```

Use the type signature above and the integration guide for the owning capability.

## compare.plot.display {#compare-2e-plot-2e-display}

```ts
"compare.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## compare.plot.linestyle {#compare-2e-plot-2e-linestyle}

```ts
"compare.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## compare.plot.linewidth {#compare-2e-plot-2e-linewidth}

```ts
"compare.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## compare.plot.plottype {#compare-2e-plot-2e-plottype}

```ts
"compare.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## compare.plot.trackprice {#compare-2e-plot-2e-trackprice}

```ts
"compare.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## compare.plot.transparency {#compare-2e-plot-2e-transparency}

```ts
"compare.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## compare.plot.color {#compare-2e-plot-2e-color}

```ts
"compare.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## compare.source {#compare-2e-source}

```ts
"compare.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## compare.symbol {#compare-2e-symbol}

```ts
"compare.symbol": string;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.hlines background.color {#connors-20-rsi-2e-hlines-20-background-2e-color}

```ts
"connors rsi.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.hlines background.transparency {#connors-20-rsi-2e-hlines-20-background-2e-transparency}

```ts
"connors rsi.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.hlines background.visible {#connors-20-rsi-2e-hlines-20-background-2e-visible}

```ts
"connors rsi.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.upperlimit.color {#connors-20-rsi-2e-upperlimit-2e-color}

```ts
"connors rsi.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.upperlimit.linestyle {#connors-20-rsi-2e-upperlimit-2e-linestyle}

```ts
"connors rsi.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.upperlimit.linewidth {#connors-20-rsi-2e-upperlimit-2e-linewidth}

```ts
"connors rsi.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.upperlimit.visible {#connors-20-rsi-2e-upperlimit-2e-visible}

```ts
"connors rsi.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.upperlimit.value {#connors-20-rsi-2e-upperlimit-2e-value}

```ts
"connors rsi.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.lowerlimit.color {#connors-20-rsi-2e-lowerlimit-2e-color}

```ts
"connors rsi.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.lowerlimit.linestyle {#connors-20-rsi-2e-lowerlimit-2e-linestyle}

```ts
"connors rsi.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.lowerlimit.linewidth {#connors-20-rsi-2e-lowerlimit-2e-linewidth}

```ts
"connors rsi.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.lowerlimit.visible {#connors-20-rsi-2e-lowerlimit-2e-visible}

```ts
"connors rsi.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.lowerlimit.value {#connors-20-rsi-2e-lowerlimit-2e-value}

```ts
"connors rsi.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.crsi.display {#connors-20-rsi-2e-crsi-2e-display}

```ts
"connors rsi.crsi.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.crsi.linestyle {#connors-20-rsi-2e-crsi-2e-linestyle}

```ts
"connors rsi.crsi.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.crsi.linewidth {#connors-20-rsi-2e-crsi-2e-linewidth}

```ts
"connors rsi.crsi.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.crsi.plottype {#connors-20-rsi-2e-crsi-2e-plottype}

```ts
"connors rsi.crsi.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.crsi.trackprice {#connors-20-rsi-2e-crsi-2e-trackprice}

```ts
"connors rsi.crsi.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.crsi.transparency {#connors-20-rsi-2e-crsi-2e-transparency}

```ts
"connors rsi.crsi.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.crsi.color {#connors-20-rsi-2e-crsi-2e-color}

```ts
"connors rsi.crsi.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.rsi length {#connors-20-rsi-2e-rsi-20-length}

```ts
"connors rsi.rsi length": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.updown length {#connors-20-rsi-2e-updown-20-length}

```ts
"connors rsi.updown length": number;
```

Use the type signature above and the integration guide for the owning capability.

## connors rsi.roc length {#connors-20-rsi-2e-roc-20-length}

```ts
"connors rsi.roc length": number;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.plot.display {#coppock-20-curve-2e-plot-2e-display}

```ts
"coppock curve.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.plot.linestyle {#coppock-20-curve-2e-plot-2e-linestyle}

```ts
"coppock curve.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.plot.linewidth {#coppock-20-curve-2e-plot-2e-linewidth}

```ts
"coppock curve.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.plot.plottype {#coppock-20-curve-2e-plot-2e-plottype}

```ts
"coppock curve.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.plot.trackprice {#coppock-20-curve-2e-plot-2e-trackprice}

```ts
"coppock curve.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.plot.transparency {#coppock-20-curve-2e-plot-2e-transparency}

```ts
"coppock curve.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.plot.color {#coppock-20-curve-2e-plot-2e-color}

```ts
"coppock curve.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.wma length {#coppock-20-curve-2e-wma-20-length}

```ts
"coppock curve.wma length": number;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.long roc length {#coppock-20-curve-2e-long-20-roc-20-length}

```ts
"coppock curve.long roc length": number;
```

Use the type signature above and the integration guide for the owning capability.

## coppock curve.short roc length {#coppock-20-curve-2e-short-20-roc-20-length}

```ts
"coppock curve.short roc length": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.plot.display {#correlation-20---20-log-2e-plot-2e-display}

```ts
"correlation - log.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.plot.linestyle {#correlation-20---20-log-2e-plot-2e-linestyle}

```ts
"correlation - log.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.plot.linewidth {#correlation-20---20-log-2e-plot-2e-linewidth}

```ts
"correlation - log.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.plot.plottype {#correlation-20---20-log-2e-plot-2e-plottype}

```ts
"correlation - log.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.plot.trackprice {#correlation-20---20-log-2e-plot-2e-trackprice}

```ts
"correlation - log.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.plot.transparency {#correlation-20---20-log-2e-plot-2e-transparency}

```ts
"correlation - log.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.plot.color {#correlation-20---20-log-2e-plot-2e-color}

```ts
"correlation - log.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.instrument 1 {#correlation-20---20-log-2e-instrument-20-1}

```ts
"correlation - log.instrument 1": string;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.instrument 2 {#correlation-20---20-log-2e-instrument-20-2}

```ts
"correlation - log.instrument 2": string;
```

Use the type signature above and the integration guide for the owning capability.

## correlation - log.periods {#correlation-20---20-log-2e-periods}

```ts
"correlation - log.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.plot.display {#correlation-20-coefficient-2e-plot-2e-display}

```ts
"correlation coefficient.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.plot.linestyle {#correlation-20-coefficient-2e-plot-2e-linestyle}

```ts
"correlation coefficient.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.plot.linewidth {#correlation-20-coefficient-2e-plot-2e-linewidth}

```ts
"correlation coefficient.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.plot.plottype {#correlation-20-coefficient-2e-plot-2e-plottype}

```ts
"correlation coefficient.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.plot.trackprice {#correlation-20-coefficient-2e-plot-2e-trackprice}

```ts
"correlation coefficient.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.plot.transparency {#correlation-20-coefficient-2e-plot-2e-transparency}

```ts
"correlation coefficient.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.plot.color {#correlation-20-coefficient-2e-plot-2e-color}

```ts
"correlation coefficient.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.sym {#correlation-20-coefficient-2e-sym}

```ts
"correlation coefficient.sym": string;
```

Use the type signature above and the integration guide for the owning capability.

## correlation coefficient.length {#correlation-20-coefficient-2e-length}

```ts
"correlation coefficient.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.zero.color {#detrended-20-price-20-oscillator-2e-zero-2e-color}

```ts
"detrended price oscillator.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.zero.linestyle {#detrended-20-price-20-oscillator-2e-zero-2e-linestyle}

```ts
"detrended price oscillator.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.zero.linewidth {#detrended-20-price-20-oscillator-2e-zero-2e-linewidth}

```ts
"detrended price oscillator.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.zero.visible {#detrended-20-price-20-oscillator-2e-zero-2e-visible}

```ts
"detrended price oscillator.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.zero.value {#detrended-20-price-20-oscillator-2e-zero-2e-value}

```ts
"detrended price oscillator.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.dpo.display {#detrended-20-price-20-oscillator-2e-dpo-2e-display}

```ts
"detrended price oscillator.dpo.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.dpo.linestyle {#detrended-20-price-20-oscillator-2e-dpo-2e-linestyle}

```ts
"detrended price oscillator.dpo.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.dpo.linewidth {#detrended-20-price-20-oscillator-2e-dpo-2e-linewidth}

```ts
"detrended price oscillator.dpo.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.dpo.plottype {#detrended-20-price-20-oscillator-2e-dpo-2e-plottype}

```ts
"detrended price oscillator.dpo.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.dpo.trackprice {#detrended-20-price-20-oscillator-2e-dpo-2e-trackprice}

```ts
"detrended price oscillator.dpo.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.dpo.transparency {#detrended-20-price-20-oscillator-2e-dpo-2e-transparency}

```ts
"detrended price oscillator.dpo.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.dpo.color {#detrended-20-price-20-oscillator-2e-dpo-2e-color}

```ts
"detrended price oscillator.dpo.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.period {#detrended-20-price-20-oscillator-2e-period}

```ts
"detrended price oscillator.period": number;
```

Use the type signature above and the integration guide for the owning capability.

## detrended price oscillator.iscentered {#detrended-20-price-20-oscillator-2e-iscentered}

```ts
"detrended price oscillator.iscentered": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.+di.display {#directional-20-movement-2e--2b-di-2e-display}

```ts
"directional movement.+di.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.+di.linestyle {#directional-20-movement-2e--2b-di-2e-linestyle}

```ts
"directional movement.+di.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.+di.linewidth {#directional-20-movement-2e--2b-di-2e-linewidth}

```ts
"directional movement.+di.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.+di.plottype {#directional-20-movement-2e--2b-di-2e-plottype}

```ts
"directional movement.+di.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.+di.trackprice {#directional-20-movement-2e--2b-di-2e-trackprice}

```ts
"directional movement.+di.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.+di.transparency {#directional-20-movement-2e--2b-di-2e-transparency}

```ts
"directional movement.+di.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.+di.color {#directional-20-movement-2e--2b-di-2e-color}

```ts
"directional movement.+di.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.-di.display {#directional-20-movement-2e--di-2e-display}

```ts
"directional movement.-di.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.-di.linestyle {#directional-20-movement-2e--di-2e-linestyle}

```ts
"directional movement.-di.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.-di.linewidth {#directional-20-movement-2e--di-2e-linewidth}

```ts
"directional movement.-di.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.-di.plottype {#directional-20-movement-2e--di-2e-plottype}

```ts
"directional movement.-di.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.-di.trackprice {#directional-20-movement-2e--di-2e-trackprice}

```ts
"directional movement.-di.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.-di.transparency {#directional-20-movement-2e--di-2e-transparency}

```ts
"directional movement.-di.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.-di.color {#directional-20-movement-2e--di-2e-color}

```ts
"directional movement.-di.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx.display {#directional-20-movement-2e-adx-2e-display}

```ts
"directional movement.adx.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx.linestyle {#directional-20-movement-2e-adx-2e-linestyle}

```ts
"directional movement.adx.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx.linewidth {#directional-20-movement-2e-adx-2e-linewidth}

```ts
"directional movement.adx.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx.plottype {#directional-20-movement-2e-adx-2e-plottype}

```ts
"directional movement.adx.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx.trackprice {#directional-20-movement-2e-adx-2e-trackprice}

```ts
"directional movement.adx.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx.transparency {#directional-20-movement-2e-adx-2e-transparency}

```ts
"directional movement.adx.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx.color {#directional-20-movement-2e-adx-2e-color}

```ts
"directional movement.adx.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.dx.display {#directional-20-movement-2e-dx-2e-display}

```ts
"directional movement.dx.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.dx.linestyle {#directional-20-movement-2e-dx-2e-linestyle}

```ts
"directional movement.dx.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.dx.linewidth {#directional-20-movement-2e-dx-2e-linewidth}

```ts
"directional movement.dx.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.dx.plottype {#directional-20-movement-2e-dx-2e-plottype}

```ts
"directional movement.dx.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.dx.trackprice {#directional-20-movement-2e-dx-2e-trackprice}

```ts
"directional movement.dx.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.dx.transparency {#directional-20-movement-2e-dx-2e-transparency}

```ts
"directional movement.dx.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.dx.color {#directional-20-movement-2e-dx-2e-color}

```ts
"directional movement.dx.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adxr.display {#directional-20-movement-2e-adxr-2e-display}

```ts
"directional movement.adxr.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adxr.linestyle {#directional-20-movement-2e-adxr-2e-linestyle}

```ts
"directional movement.adxr.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adxr.linewidth {#directional-20-movement-2e-adxr-2e-linewidth}

```ts
"directional movement.adxr.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adxr.plottype {#directional-20-movement-2e-adxr-2e-plottype}

```ts
"directional movement.adxr.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adxr.trackprice {#directional-20-movement-2e-adxr-2e-trackprice}

```ts
"directional movement.adxr.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adxr.transparency {#directional-20-movement-2e-adxr-2e-transparency}

```ts
"directional movement.adxr.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adxr.color {#directional-20-movement-2e-adxr-2e-color}

```ts
"directional movement.adxr.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.di length {#directional-20-movement-2e-di-20-length}

```ts
"directional movement.di length": number;
```

Use the type signature above and the integration guide for the owning capability.

## directional movement.adx smoothing {#directional-20-movement-2e-adx-20-smoothing}

```ts
"directional movement.adx smoothing": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.plots background.color {#donchian-20-channels-2e-plots-20-background-2e-color}

```ts
"donchian channels.plots background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.plots background.transparency {#donchian-20-channels-2e-plots-20-background-2e-transparency}

```ts
"donchian channels.plots background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.plots background.visible {#donchian-20-channels-2e-plots-20-background-2e-visible}

```ts
"donchian channels.plots background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.lower.display {#donchian-20-channels-2e-lower-2e-display}

```ts
"donchian channels.lower.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.lower.linestyle {#donchian-20-channels-2e-lower-2e-linestyle}

```ts
"donchian channels.lower.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.lower.linewidth {#donchian-20-channels-2e-lower-2e-linewidth}

```ts
"donchian channels.lower.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.lower.plottype {#donchian-20-channels-2e-lower-2e-plottype}

```ts
"donchian channels.lower.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.lower.trackprice {#donchian-20-channels-2e-lower-2e-trackprice}

```ts
"donchian channels.lower.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.lower.transparency {#donchian-20-channels-2e-lower-2e-transparency}

```ts
"donchian channels.lower.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.lower.color {#donchian-20-channels-2e-lower-2e-color}

```ts
"donchian channels.lower.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.upper.display {#donchian-20-channels-2e-upper-2e-display}

```ts
"donchian channels.upper.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.upper.linestyle {#donchian-20-channels-2e-upper-2e-linestyle}

```ts
"donchian channels.upper.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.upper.linewidth {#donchian-20-channels-2e-upper-2e-linewidth}

```ts
"donchian channels.upper.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.upper.plottype {#donchian-20-channels-2e-upper-2e-plottype}

```ts
"donchian channels.upper.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.upper.trackprice {#donchian-20-channels-2e-upper-2e-trackprice}

```ts
"donchian channels.upper.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.upper.transparency {#donchian-20-channels-2e-upper-2e-transparency}

```ts
"donchian channels.upper.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.upper.color {#donchian-20-channels-2e-upper-2e-color}

```ts
"donchian channels.upper.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.basis.display {#donchian-20-channels-2e-basis-2e-display}

```ts
"donchian channels.basis.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.basis.linestyle {#donchian-20-channels-2e-basis-2e-linestyle}

```ts
"donchian channels.basis.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.basis.linewidth {#donchian-20-channels-2e-basis-2e-linewidth}

```ts
"donchian channels.basis.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.basis.plottype {#donchian-20-channels-2e-basis-2e-plottype}

```ts
"donchian channels.basis.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.basis.trackprice {#donchian-20-channels-2e-basis-2e-trackprice}

```ts
"donchian channels.basis.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.basis.transparency {#donchian-20-channels-2e-basis-2e-transparency}

```ts
"donchian channels.basis.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.basis.color {#donchian-20-channels-2e-basis-2e-color}

```ts
"donchian channels.basis.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## donchian channels.length {#donchian-20-channels-2e-length}

```ts
"donchian channels.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.plot.display {#double-20-ema-2e-plot-2e-display}

```ts
"double ema.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.plot.linestyle {#double-20-ema-2e-plot-2e-linestyle}

```ts
"double ema.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.plot.linewidth {#double-20-ema-2e-plot-2e-linewidth}

```ts
"double ema.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.plot.plottype {#double-20-ema-2e-plot-2e-plottype}

```ts
"double ema.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.plot.trackprice {#double-20-ema-2e-plot-2e-trackprice}

```ts
"double ema.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.plot.transparency {#double-20-ema-2e-plot-2e-transparency}

```ts
"double ema.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.plot.color {#double-20-ema-2e-plot-2e-color}

```ts
"double ema.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## double ema.length {#double-20-ema-2e-length}

```ts
"double ema.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:plot.display {#ema-20-cross-2e-short-3a-plot-2e-display}

```ts
"ema cross.short:plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:plot.linestyle {#ema-20-cross-2e-short-3a-plot-2e-linestyle}

```ts
"ema cross.short:plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:plot.linewidth {#ema-20-cross-2e-short-3a-plot-2e-linewidth}

```ts
"ema cross.short:plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:plot.plottype {#ema-20-cross-2e-short-3a-plot-2e-plottype}

```ts
"ema cross.short:plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:plot.trackprice {#ema-20-cross-2e-short-3a-plot-2e-trackprice}

```ts
"ema cross.short:plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:plot.transparency {#ema-20-cross-2e-short-3a-plot-2e-transparency}

```ts
"ema cross.short:plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:plot.color {#ema-20-cross-2e-short-3a-plot-2e-color}

```ts
"ema cross.short:plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:plot.display {#ema-20-cross-2e-long-3a-plot-2e-display}

```ts
"ema cross.long:plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:plot.linestyle {#ema-20-cross-2e-long-3a-plot-2e-linestyle}

```ts
"ema cross.long:plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:plot.linewidth {#ema-20-cross-2e-long-3a-plot-2e-linewidth}

```ts
"ema cross.long:plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:plot.plottype {#ema-20-cross-2e-long-3a-plot-2e-plottype}

```ts
"ema cross.long:plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:plot.trackprice {#ema-20-cross-2e-long-3a-plot-2e-trackprice}

```ts
"ema cross.long:plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:plot.transparency {#ema-20-cross-2e-long-3a-plot-2e-transparency}

```ts
"ema cross.long:plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:plot.color {#ema-20-cross-2e-long-3a-plot-2e-color}

```ts
"ema cross.long:plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.crosses.display {#ema-20-cross-2e-crosses-2e-display}

```ts
"ema cross.crosses.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.crosses.linestyle {#ema-20-cross-2e-crosses-2e-linestyle}

```ts
"ema cross.crosses.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.crosses.linewidth {#ema-20-cross-2e-crosses-2e-linewidth}

```ts
"ema cross.crosses.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.crosses.plottype {#ema-20-cross-2e-crosses-2e-plottype}

```ts
"ema cross.crosses.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.crosses.trackprice {#ema-20-cross-2e-crosses-2e-trackprice}

```ts
"ema cross.crosses.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.crosses.transparency {#ema-20-cross-2e-crosses-2e-transparency}

```ts
"ema cross.crosses.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.crosses.color {#ema-20-cross-2e-crosses-2e-color}

```ts
"ema cross.crosses.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.short:input {#ema-20-cross-2e-short-3a-input}

```ts
"ema cross.short:input": number;
```

Use the type signature above and the integration guide for the owning capability.

## ema cross.long:input {#ema-20-cross-2e-long-3a-input}

```ts
"ema cross.long:input": number;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.plot.display {#ease-20-of-20-movement-2e-plot-2e-display}

```ts
"ease of movement.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.plot.linestyle {#ease-20-of-20-movement-2e-plot-2e-linestyle}

```ts
"ease of movement.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.plot.linewidth {#ease-20-of-20-movement-2e-plot-2e-linewidth}

```ts
"ease of movement.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.plot.plottype {#ease-20-of-20-movement-2e-plot-2e-plottype}

```ts
"ease of movement.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.plot.trackprice {#ease-20-of-20-movement-2e-plot-2e-trackprice}

```ts
"ease of movement.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.plot.transparency {#ease-20-of-20-movement-2e-plot-2e-transparency}

```ts
"ease of movement.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.plot.color {#ease-20-of-20-movement-2e-plot-2e-color}

```ts
"ease of movement.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.divisor {#ease-20-of-20-movement-2e-divisor}

```ts
"ease of movement.divisor": number;
```

Use the type signature above and the integration guide for the owning capability.

## ease of movement.length {#ease-20-of-20-movement-2e-length}

```ts
"ease of movement.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.zero.color {#elders-20-force-20-index-2e-zero-2e-color}

```ts
"elder's force index.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.zero.linestyle {#elders-20-force-20-index-2e-zero-2e-linestyle}

```ts
"elder's force index.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.zero.linewidth {#elders-20-force-20-index-2e-zero-2e-linewidth}

```ts
"elder's force index.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.zero.visible {#elders-20-force-20-index-2e-zero-2e-visible}

```ts
"elder's force index.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.zero.value {#elders-20-force-20-index-2e-zero-2e-value}

```ts
"elder's force index.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.plot.display {#elders-20-force-20-index-2e-plot-2e-display}

```ts
"elder's force index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.plot.linestyle {#elders-20-force-20-index-2e-plot-2e-linestyle}

```ts
"elder's force index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.plot.linewidth {#elders-20-force-20-index-2e-plot-2e-linewidth}

```ts
"elder's force index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.plot.plottype {#elders-20-force-20-index-2e-plot-2e-plottype}

```ts
"elder's force index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.plot.trackprice {#elders-20-force-20-index-2e-plot-2e-trackprice}

```ts
"elder's force index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.plot.transparency {#elders-20-force-20-index-2e-plot-2e-transparency}

```ts
"elder's force index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.plot.color {#elders-20-force-20-index-2e-plot-2e-color}

```ts
"elder's force index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## elders force index.length {#elders-20-force-20-index-2e-length}

```ts
"elder's force index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.plots background.color {#envelopes-2e-plots-20-background-2e-color}

```ts
"envelopes.plots background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.plots background.transparency {#envelopes-2e-plots-20-background-2e-transparency}

```ts
"envelopes.plots background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.plots background.visible {#envelopes-2e-plots-20-background-2e-visible}

```ts
"envelopes.plots background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.average.display {#envelopes-2e-average-2e-display}

```ts
"envelopes.average.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.average.linestyle {#envelopes-2e-average-2e-linestyle}

```ts
"envelopes.average.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.average.linewidth {#envelopes-2e-average-2e-linewidth}

```ts
"envelopes.average.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.average.plottype {#envelopes-2e-average-2e-plottype}

```ts
"envelopes.average.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.average.trackprice {#envelopes-2e-average-2e-trackprice}

```ts
"envelopes.average.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.average.transparency {#envelopes-2e-average-2e-transparency}

```ts
"envelopes.average.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.average.color {#envelopes-2e-average-2e-color}

```ts
"envelopes.average.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper.display {#envelopes-2e-upper-2e-display}

```ts
"envelopes.upper.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper.linestyle {#envelopes-2e-upper-2e-linestyle}

```ts
"envelopes.upper.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper.linewidth {#envelopes-2e-upper-2e-linewidth}

```ts
"envelopes.upper.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper.plottype {#envelopes-2e-upper-2e-plottype}

```ts
"envelopes.upper.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper.trackprice {#envelopes-2e-upper-2e-trackprice}

```ts
"envelopes.upper.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper.transparency {#envelopes-2e-upper-2e-transparency}

```ts
"envelopes.upper.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper.color {#envelopes-2e-upper-2e-color}

```ts
"envelopes.upper.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower.display {#envelopes-2e-lower-2e-display}

```ts
"envelopes.lower.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower.linestyle {#envelopes-2e-lower-2e-linestyle}

```ts
"envelopes.lower.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower.linewidth {#envelopes-2e-lower-2e-linewidth}

```ts
"envelopes.lower.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower.plottype {#envelopes-2e-lower-2e-plottype}

```ts
"envelopes.lower.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower.trackprice {#envelopes-2e-lower-2e-trackprice}

```ts
"envelopes.lower.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower.transparency {#envelopes-2e-lower-2e-transparency}

```ts
"envelopes.lower.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower.color {#envelopes-2e-lower-2e-color}

```ts
"envelopes.lower.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.length {#envelopes-2e-length}

```ts
"envelopes.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.upper percentage {#envelopes-2e-upper-20-percentage}

```ts
"envelopes.upper percentage": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.lower percentage {#envelopes-2e-lower-20-percentage}

```ts
"envelopes.lower percentage": number;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.method {#envelopes-2e-method}

```ts
"envelopes.method": string;
```

Use the type signature above and the integration guide for the owning capability.

## envelopes.source {#envelopes-2e-source}

```ts
"envelopes.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.level:band.color {#fisher-20-transform-2e-level-3a-band-2e-color}

```ts
"fisher transform.level:band.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.level:band.linestyle {#fisher-20-transform-2e-level-3a-band-2e-linestyle}

```ts
"fisher transform.level:band.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.level:band.linewidth {#fisher-20-transform-2e-level-3a-band-2e-linewidth}

```ts
"fisher transform.level:band.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.level:band.visible {#fisher-20-transform-2e-level-3a-band-2e-visible}

```ts
"fisher transform.level:band.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.level:band.value {#fisher-20-transform-2e-level-3a-band-2e-value}

```ts
"fisher transform.level:band.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.fisher.display {#fisher-20-transform-2e-fisher-2e-display}

```ts
"fisher transform.fisher.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.fisher.linestyle {#fisher-20-transform-2e-fisher-2e-linestyle}

```ts
"fisher transform.fisher.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.fisher.linewidth {#fisher-20-transform-2e-fisher-2e-linewidth}

```ts
"fisher transform.fisher.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.fisher.plottype {#fisher-20-transform-2e-fisher-2e-plottype}

```ts
"fisher transform.fisher.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.fisher.trackprice {#fisher-20-transform-2e-fisher-2e-trackprice}

```ts
"fisher transform.fisher.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.fisher.transparency {#fisher-20-transform-2e-fisher-2e-transparency}

```ts
"fisher transform.fisher.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.fisher.color {#fisher-20-transform-2e-fisher-2e-color}

```ts
"fisher transform.fisher.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.trigger.display {#fisher-20-transform-2e-trigger-2e-display}

```ts
"fisher transform.trigger.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.trigger.linestyle {#fisher-20-transform-2e-trigger-2e-linestyle}

```ts
"fisher transform.trigger.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.trigger.linewidth {#fisher-20-transform-2e-trigger-2e-linewidth}

```ts
"fisher transform.trigger.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.trigger.plottype {#fisher-20-transform-2e-trigger-2e-plottype}

```ts
"fisher transform.trigger.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.trigger.trackprice {#fisher-20-transform-2e-trigger-2e-trackprice}

```ts
"fisher transform.trigger.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.trigger.transparency {#fisher-20-transform-2e-trigger-2e-transparency}

```ts
"fisher transform.trigger.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.trigger.color {#fisher-20-transform-2e-trigger-2e-color}

```ts
"fisher transform.trigger.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## fisher transform.length {#fisher-20-transform-2e-length}

```ts
"fisher transform.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing poc.color {#fixed-20-range-2e-developing-20-poc-2e-color}

```ts
"fixed range.developing poc.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing poc.linestyle {#fixed-20-range-2e-developing-20-poc-2e-linestyle}

```ts
"fixed range.developing poc.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing poc.linewidth {#fixed-20-range-2e-developing-20-poc-2e-linewidth}

```ts
"fixed range.developing poc.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing poc.plottype {#fixed-20-range-2e-developing-20-poc-2e-plottype}

```ts
"fixed range.developing poc.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing poc.trackprice {#fixed-20-range-2e-developing-20-poc-2e-trackprice}

```ts
"fixed range.developing poc.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing poc.transparency {#fixed-20-range-2e-developing-20-poc-2e-transparency}

```ts
"fixed range.developing poc.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing poc.display {#fixed-20-range-2e-developing-20-poc-2e-display}

```ts
"fixed range.developing poc.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va high.color {#fixed-20-range-2e-developing-20-va-20-high-2e-color}

```ts
"fixed range.developing va high.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va high.linestyle {#fixed-20-range-2e-developing-20-va-20-high-2e-linestyle}

```ts
"fixed range.developing va high.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va high.linewidth {#fixed-20-range-2e-developing-20-va-20-high-2e-linewidth}

```ts
"fixed range.developing va high.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va high.plottype {#fixed-20-range-2e-developing-20-va-20-high-2e-plottype}

```ts
"fixed range.developing va high.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va high.trackprice {#fixed-20-range-2e-developing-20-va-20-high-2e-trackprice}

```ts
"fixed range.developing va high.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va high.transparency {#fixed-20-range-2e-developing-20-va-20-high-2e-transparency}

```ts
"fixed range.developing va high.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va high.display {#fixed-20-range-2e-developing-20-va-20-high-2e-display}

```ts
"fixed range.developing va high.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va low.color {#fixed-20-range-2e-developing-20-va-20-low-2e-color}

```ts
"fixed range.developing va low.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va low.linestyle {#fixed-20-range-2e-developing-20-va-20-low-2e-linestyle}

```ts
"fixed range.developing va low.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va low.linewidth {#fixed-20-range-2e-developing-20-va-20-low-2e-linewidth}

```ts
"fixed range.developing va low.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va low.plottype {#fixed-20-range-2e-developing-20-va-20-low-2e-plottype}

```ts
"fixed range.developing va low.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va low.trackprice {#fixed-20-range-2e-developing-20-va-20-low-2e-trackprice}

```ts
"fixed range.developing va low.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va low.transparency {#fixed-20-range-2e-developing-20-va-20-low-2e-transparency}

```ts
"fixed range.developing va low.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.developing va low.display {#fixed-20-range-2e-developing-20-va-20-low-2e-display}

```ts
"fixed range.developing va low.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.first bar time {#fixed-20-range-2e-first-20-bar-20-time}

```ts
"fixed range.first bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.last bar time {#fixed-20-range-2e-last-20-bar-20-time}

```ts
"fixed range.last bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.row size {#fixed-20-range-2e-row-20-size}

```ts
"fixed range.row size": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.rows layout {#fixed-20-range-2e-rows-20-layout}

```ts
"fixed range.rows layout": string;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.subscriberealtime {#fixed-20-range-2e-subscriberealtime}

```ts
"fixed range.subscriberealtime": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.value area volume {#fixed-20-range-2e-value-20-area-20-volume}

```ts
"fixed range.value area volume": number;
```

Use the type signature above and the integration guide for the owning capability.

## fixed range.volume {#fixed-20-range-2e-volume}

```ts
"fixed range.volume": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1.display {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-2e-display}

```ts
"guppy multiple moving average.trader ema 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1.color {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-2e-color}

```ts
"guppy multiple moving average.trader ema 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1.linestyle {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-2e-linestyle}

```ts
"guppy multiple moving average.trader ema 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1.linewidth {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-2e-linewidth}

```ts
"guppy multiple moving average.trader ema 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1.plottype {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-2e-plottype}

```ts
"guppy multiple moving average.trader ema 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1.trackprice {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-2e-trackprice}

```ts
"guppy multiple moving average.trader ema 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1.transparency {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-2e-transparency}

```ts
"guppy multiple moving average.trader ema 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2.display {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-2e-display}

```ts
"guppy multiple moving average.trader ema 2.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2.color {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-2e-color}

```ts
"guppy multiple moving average.trader ema 2.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2.linestyle {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-2e-linestyle}

```ts
"guppy multiple moving average.trader ema 2.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2.linewidth {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-2e-linewidth}

```ts
"guppy multiple moving average.trader ema 2.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2.plottype {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-2e-plottype}

```ts
"guppy multiple moving average.trader ema 2.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2.trackprice {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-2e-trackprice}

```ts
"guppy multiple moving average.trader ema 2.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2.transparency {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-2e-transparency}

```ts
"guppy multiple moving average.trader ema 2.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3.display {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-2e-display}

```ts
"guppy multiple moving average.trader ema 3.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3.color {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-2e-color}

```ts
"guppy multiple moving average.trader ema 3.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3.linestyle {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-2e-linestyle}

```ts
"guppy multiple moving average.trader ema 3.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3.linewidth {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-2e-linewidth}

```ts
"guppy multiple moving average.trader ema 3.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3.plottype {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-2e-plottype}

```ts
"guppy multiple moving average.trader ema 3.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3.trackprice {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-2e-trackprice}

```ts
"guppy multiple moving average.trader ema 3.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3.transparency {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-2e-transparency}

```ts
"guppy multiple moving average.trader ema 3.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4.display {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-2e-display}

```ts
"guppy multiple moving average.trader ema 4.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4.color {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-2e-color}

```ts
"guppy multiple moving average.trader ema 4.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4.linestyle {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-2e-linestyle}

```ts
"guppy multiple moving average.trader ema 4.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4.linewidth {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-2e-linewidth}

```ts
"guppy multiple moving average.trader ema 4.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4.plottype {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-2e-plottype}

```ts
"guppy multiple moving average.trader ema 4.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4.trackprice {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-2e-trackprice}

```ts
"guppy multiple moving average.trader ema 4.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4.transparency {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-2e-transparency}

```ts
"guppy multiple moving average.trader ema 4.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5.display {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-2e-display}

```ts
"guppy multiple moving average.trader ema 5.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5.color {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-2e-color}

```ts
"guppy multiple moving average.trader ema 5.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5.linestyle {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-2e-linestyle}

```ts
"guppy multiple moving average.trader ema 5.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5.linewidth {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-2e-linewidth}

```ts
"guppy multiple moving average.trader ema 5.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5.plottype {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-2e-plottype}

```ts
"guppy multiple moving average.trader ema 5.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5.trackprice {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-2e-trackprice}

```ts
"guppy multiple moving average.trader ema 5.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5.transparency {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-2e-transparency}

```ts
"guppy multiple moving average.trader ema 5.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6.display {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-2e-display}

```ts
"guppy multiple moving average.trader ema 6.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6.color {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-2e-color}

```ts
"guppy multiple moving average.trader ema 6.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6.linestyle {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-2e-linestyle}

```ts
"guppy multiple moving average.trader ema 6.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6.linewidth {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-2e-linewidth}

```ts
"guppy multiple moving average.trader ema 6.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6.plottype {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-2e-plottype}

```ts
"guppy multiple moving average.trader ema 6.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6.trackprice {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-2e-trackprice}

```ts
"guppy multiple moving average.trader ema 6.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6.transparency {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-2e-transparency}

```ts
"guppy multiple moving average.trader ema 6.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1.display {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-2e-display}

```ts
"guppy multiple moving average.investor ema 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1.color {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-2e-color}

```ts
"guppy multiple moving average.investor ema 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1.linestyle {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-2e-linestyle}

```ts
"guppy multiple moving average.investor ema 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1.linewidth {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-2e-linewidth}

```ts
"guppy multiple moving average.investor ema 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1.plottype {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-2e-plottype}

```ts
"guppy multiple moving average.investor ema 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1.trackprice {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-2e-trackprice}

```ts
"guppy multiple moving average.investor ema 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1.transparency {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-2e-transparency}

```ts
"guppy multiple moving average.investor ema 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2.display {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-2e-display}

```ts
"guppy multiple moving average.investor ema 2.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2.color {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-2e-color}

```ts
"guppy multiple moving average.investor ema 2.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2.linestyle {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-2e-linestyle}

```ts
"guppy multiple moving average.investor ema 2.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2.linewidth {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-2e-linewidth}

```ts
"guppy multiple moving average.investor ema 2.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2.plottype {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-2e-plottype}

```ts
"guppy multiple moving average.investor ema 2.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2.trackprice {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-2e-trackprice}

```ts
"guppy multiple moving average.investor ema 2.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2.transparency {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-2e-transparency}

```ts
"guppy multiple moving average.investor ema 2.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3.display {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-2e-display}

```ts
"guppy multiple moving average.investor ema 3.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3.color {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-2e-color}

```ts
"guppy multiple moving average.investor ema 3.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3.linestyle {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-2e-linestyle}

```ts
"guppy multiple moving average.investor ema 3.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3.linewidth {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-2e-linewidth}

```ts
"guppy multiple moving average.investor ema 3.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3.plottype {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-2e-plottype}

```ts
"guppy multiple moving average.investor ema 3.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3.trackprice {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-2e-trackprice}

```ts
"guppy multiple moving average.investor ema 3.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3.transparency {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-2e-transparency}

```ts
"guppy multiple moving average.investor ema 3.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4.display {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-2e-display}

```ts
"guppy multiple moving average.investor ema 4.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4.color {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-2e-color}

```ts
"guppy multiple moving average.investor ema 4.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4.linestyle {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-2e-linestyle}

```ts
"guppy multiple moving average.investor ema 4.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4.linewidth {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-2e-linewidth}

```ts
"guppy multiple moving average.investor ema 4.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4.plottype {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-2e-plottype}

```ts
"guppy multiple moving average.investor ema 4.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4.trackprice {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-2e-trackprice}

```ts
"guppy multiple moving average.investor ema 4.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4.transparency {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-2e-transparency}

```ts
"guppy multiple moving average.investor ema 4.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5.display {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-2e-display}

```ts
"guppy multiple moving average.investor ema 5.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5.color {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-2e-color}

```ts
"guppy multiple moving average.investor ema 5.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5.linestyle {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-2e-linestyle}

```ts
"guppy multiple moving average.investor ema 5.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5.linewidth {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-2e-linewidth}

```ts
"guppy multiple moving average.investor ema 5.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5.plottype {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-2e-plottype}

```ts
"guppy multiple moving average.investor ema 5.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5.trackprice {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-2e-trackprice}

```ts
"guppy multiple moving average.investor ema 5.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5.transparency {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-2e-transparency}

```ts
"guppy multiple moving average.investor ema 5.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6.display {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-2e-display}

```ts
"guppy multiple moving average.investor ema 6.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6.color {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-2e-color}

```ts
"guppy multiple moving average.investor ema 6.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6.linestyle {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-2e-linestyle}

```ts
"guppy multiple moving average.investor ema 6.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6.linewidth {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-2e-linewidth}

```ts
"guppy multiple moving average.investor ema 6.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6.plottype {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-2e-plottype}

```ts
"guppy multiple moving average.investor ema 6.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6.trackprice {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-2e-trackprice}

```ts
"guppy multiple moving average.investor ema 6.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6.transparency {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-2e-transparency}

```ts
"guppy multiple moving average.investor ema 6.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 1 length {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-1-20-length}

```ts
"guppy multiple moving average.trader ema 1 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 2 length {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-2-20-length}

```ts
"guppy multiple moving average.trader ema 2 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 3 length {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-3-20-length}

```ts
"guppy multiple moving average.trader ema 3 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 4 length {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-4-20-length}

```ts
"guppy multiple moving average.trader ema 4 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 5 length {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-5-20-length}

```ts
"guppy multiple moving average.trader ema 5 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.trader ema 6 length {#guppy-20-multiple-20-moving-20-average-2e-trader-20-ema-20-6-20-length}

```ts
"guppy multiple moving average.trader ema 6 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 1 length {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-1-20-length}

```ts
"guppy multiple moving average.investor ema 1 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 2 length {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-2-20-length}

```ts
"guppy multiple moving average.investor ema 2 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 3 length {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-3-20-length}

```ts
"guppy multiple moving average.investor ema 3 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 4 length {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-4-20-length}

```ts
"guppy multiple moving average.investor ema 4 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 5 length {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-5-20-length}

```ts
"guppy multiple moving average.investor ema 5 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## guppy multiple moving average.investor ema 6 length {#guppy-20-multiple-20-moving-20-average-2e-investor-20-ema-20-6-20-length}

```ts
"guppy multiple moving average.investor ema 6 length": number;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.plot.display {#historical-20-volatility-2e-plot-2e-display}

```ts
"historical volatility.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.plot.linestyle {#historical-20-volatility-2e-plot-2e-linestyle}

```ts
"historical volatility.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.plot.linewidth {#historical-20-volatility-2e-plot-2e-linewidth}

```ts
"historical volatility.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.plot.plottype {#historical-20-volatility-2e-plot-2e-plottype}

```ts
"historical volatility.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.plot.trackprice {#historical-20-volatility-2e-plot-2e-trackprice}

```ts
"historical volatility.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.plot.transparency {#historical-20-volatility-2e-plot-2e-transparency}

```ts
"historical volatility.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.plot.color {#historical-20-volatility-2e-plot-2e-color}

```ts
"historical volatility.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## historical volatility.length {#historical-20-volatility-2e-length}

```ts
"historical volatility.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.plot.display {#hull-20-moving-20-average-2e-plot-2e-display}

```ts
"hull moving average.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.plot.linestyle {#hull-20-moving-20-average-2e-plot-2e-linestyle}

```ts
"hull moving average.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.plot.linewidth {#hull-20-moving-20-average-2e-plot-2e-linewidth}

```ts
"hull moving average.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.plot.plottype {#hull-20-moving-20-average-2e-plot-2e-plottype}

```ts
"hull moving average.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.plot.trackprice {#hull-20-moving-20-average-2e-plot-2e-trackprice}

```ts
"hull moving average.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.plot.transparency {#hull-20-moving-20-average-2e-plot-2e-transparency}

```ts
"hull moving average.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.plot.color {#hull-20-moving-20-average-2e-plot-2e-color}

```ts
"hull moving average.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## hull moving average.length {#hull-20-moving-20-average-2e-length}

```ts
"hull moving average.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.plots background.color {#ichimoku-20-cloud-2e-plots-20-background-2e-color}

```ts
"ichimoku cloud.plots background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.plots background.transparency {#ichimoku-20-cloud-2e-plots-20-background-2e-transparency}

```ts
"ichimoku cloud.plots background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.plots background.visible {#ichimoku-20-cloud-2e-plots-20-background-2e-visible}

```ts
"ichimoku cloud.plots background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line.display {#ichimoku-20-cloud-2e-conversion-20-line-2e-display}

```ts
"ichimoku cloud.conversion line.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line.linestyle {#ichimoku-20-cloud-2e-conversion-20-line-2e-linestyle}

```ts
"ichimoku cloud.conversion line.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line.linewidth {#ichimoku-20-cloud-2e-conversion-20-line-2e-linewidth}

```ts
"ichimoku cloud.conversion line.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line.plottype {#ichimoku-20-cloud-2e-conversion-20-line-2e-plottype}

```ts
"ichimoku cloud.conversion line.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line.trackprice {#ichimoku-20-cloud-2e-conversion-20-line-2e-trackprice}

```ts
"ichimoku cloud.conversion line.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line.transparency {#ichimoku-20-cloud-2e-conversion-20-line-2e-transparency}

```ts
"ichimoku cloud.conversion line.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line.color {#ichimoku-20-cloud-2e-conversion-20-line-2e-color}

```ts
"ichimoku cloud.conversion line.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line.display {#ichimoku-20-cloud-2e-base-20-line-2e-display}

```ts
"ichimoku cloud.base line.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line.linestyle {#ichimoku-20-cloud-2e-base-20-line-2e-linestyle}

```ts
"ichimoku cloud.base line.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line.linewidth {#ichimoku-20-cloud-2e-base-20-line-2e-linewidth}

```ts
"ichimoku cloud.base line.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line.plottype {#ichimoku-20-cloud-2e-base-20-line-2e-plottype}

```ts
"ichimoku cloud.base line.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line.trackprice {#ichimoku-20-cloud-2e-base-20-line-2e-trackprice}

```ts
"ichimoku cloud.base line.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line.transparency {#ichimoku-20-cloud-2e-base-20-line-2e-transparency}

```ts
"ichimoku cloud.base line.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line.color {#ichimoku-20-cloud-2e-base-20-line-2e-color}

```ts
"ichimoku cloud.base line.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span.display {#ichimoku-20-cloud-2e-lagging-20-span-2e-display}

```ts
"ichimoku cloud.lagging span.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span.linestyle {#ichimoku-20-cloud-2e-lagging-20-span-2e-linestyle}

```ts
"ichimoku cloud.lagging span.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span.linewidth {#ichimoku-20-cloud-2e-lagging-20-span-2e-linewidth}

```ts
"ichimoku cloud.lagging span.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span.plottype {#ichimoku-20-cloud-2e-lagging-20-span-2e-plottype}

```ts
"ichimoku cloud.lagging span.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span.trackprice {#ichimoku-20-cloud-2e-lagging-20-span-2e-trackprice}

```ts
"ichimoku cloud.lagging span.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span.transparency {#ichimoku-20-cloud-2e-lagging-20-span-2e-transparency}

```ts
"ichimoku cloud.lagging span.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span.color {#ichimoku-20-cloud-2e-lagging-20-span-2e-color}

```ts
"ichimoku cloud.lagging span.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span a.display {#ichimoku-20-cloud-2e-leading-20-span-20-a-2e-display}

```ts
"ichimoku cloud.leading span a.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span a.linestyle {#ichimoku-20-cloud-2e-leading-20-span-20-a-2e-linestyle}

```ts
"ichimoku cloud.leading span a.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span a.linewidth {#ichimoku-20-cloud-2e-leading-20-span-20-a-2e-linewidth}

```ts
"ichimoku cloud.leading span a.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span a.plottype {#ichimoku-20-cloud-2e-leading-20-span-20-a-2e-plottype}

```ts
"ichimoku cloud.leading span a.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span a.trackprice {#ichimoku-20-cloud-2e-leading-20-span-20-a-2e-trackprice}

```ts
"ichimoku cloud.leading span a.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span a.transparency {#ichimoku-20-cloud-2e-leading-20-span-20-a-2e-transparency}

```ts
"ichimoku cloud.leading span a.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span a.color {#ichimoku-20-cloud-2e-leading-20-span-20-a-2e-color}

```ts
"ichimoku cloud.leading span a.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span b.display {#ichimoku-20-cloud-2e-leading-20-span-20-b-2e-display}

```ts
"ichimoku cloud.leading span b.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span b.linestyle {#ichimoku-20-cloud-2e-leading-20-span-20-b-2e-linestyle}

```ts
"ichimoku cloud.leading span b.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span b.linewidth {#ichimoku-20-cloud-2e-leading-20-span-20-b-2e-linewidth}

```ts
"ichimoku cloud.leading span b.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span b.plottype {#ichimoku-20-cloud-2e-leading-20-span-20-b-2e-plottype}

```ts
"ichimoku cloud.leading span b.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span b.trackprice {#ichimoku-20-cloud-2e-leading-20-span-20-b-2e-trackprice}

```ts
"ichimoku cloud.leading span b.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span b.transparency {#ichimoku-20-cloud-2e-leading-20-span-20-b-2e-transparency}

```ts
"ichimoku cloud.leading span b.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span b.color {#ichimoku-20-cloud-2e-leading-20-span-20-b-2e-color}

```ts
"ichimoku cloud.leading span b.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.conversion line periods {#ichimoku-20-cloud-2e-conversion-20-line-20-periods}

```ts
"ichimoku cloud.conversion line periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.base line periods {#ichimoku-20-cloud-2e-base-20-line-20-periods}

```ts
"ichimoku cloud.base line periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading span periods {#ichimoku-20-cloud-2e-leading-20-span-20-periods}

```ts
"ichimoku cloud.leading span periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.lagging span periods {#ichimoku-20-cloud-2e-lagging-20-span-20-periods}

```ts
"ichimoku cloud.lagging span periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## ichimoku cloud.leading shift periods {#ichimoku-20-cloud-2e-leading-20-shift-20-periods}

```ts
"ichimoku cloud.leading shift periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.plots background.color {#keltner-20-channels-2e-plots-20-background-2e-color}

```ts
"keltner channels.plots background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.plots background.transparency {#keltner-20-channels-2e-plots-20-background-2e-transparency}

```ts
"keltner channels.plots background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.plots background.visible {#keltner-20-channels-2e-plots-20-background-2e-visible}

```ts
"keltner channels.plots background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.upper.display {#keltner-20-channels-2e-upper-2e-display}

```ts
"keltner channels.upper.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.upper.linestyle {#keltner-20-channels-2e-upper-2e-linestyle}

```ts
"keltner channels.upper.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.upper.linewidth {#keltner-20-channels-2e-upper-2e-linewidth}

```ts
"keltner channels.upper.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.upper.plottype {#keltner-20-channels-2e-upper-2e-plottype}

```ts
"keltner channels.upper.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.upper.trackprice {#keltner-20-channels-2e-upper-2e-trackprice}

```ts
"keltner channels.upper.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.upper.transparency {#keltner-20-channels-2e-upper-2e-transparency}

```ts
"keltner channels.upper.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.upper.color {#keltner-20-channels-2e-upper-2e-color}

```ts
"keltner channels.upper.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.middle.display {#keltner-20-channels-2e-middle-2e-display}

```ts
"keltner channels.middle.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.middle.linestyle {#keltner-20-channels-2e-middle-2e-linestyle}

```ts
"keltner channels.middle.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.middle.linewidth {#keltner-20-channels-2e-middle-2e-linewidth}

```ts
"keltner channels.middle.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.middle.plottype {#keltner-20-channels-2e-middle-2e-plottype}

```ts
"keltner channels.middle.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.middle.trackprice {#keltner-20-channels-2e-middle-2e-trackprice}

```ts
"keltner channels.middle.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.middle.transparency {#keltner-20-channels-2e-middle-2e-transparency}

```ts
"keltner channels.middle.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.middle.color {#keltner-20-channels-2e-middle-2e-color}

```ts
"keltner channels.middle.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.lower.display {#keltner-20-channels-2e-lower-2e-display}

```ts
"keltner channels.lower.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.lower.linestyle {#keltner-20-channels-2e-lower-2e-linestyle}

```ts
"keltner channels.lower.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.lower.linewidth {#keltner-20-channels-2e-lower-2e-linewidth}

```ts
"keltner channels.lower.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.lower.plottype {#keltner-20-channels-2e-lower-2e-plottype}

```ts
"keltner channels.lower.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.lower.trackprice {#keltner-20-channels-2e-lower-2e-trackprice}

```ts
"keltner channels.lower.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.lower.transparency {#keltner-20-channels-2e-lower-2e-transparency}

```ts
"keltner channels.lower.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.lower.color {#keltner-20-channels-2e-lower-2e-color}

```ts
"keltner channels.lower.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.usetruerange {#keltner-20-channels-2e-usetruerange}

```ts
"keltner channels.usetruerange": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.length {#keltner-20-channels-2e-length}

```ts
"keltner channels.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## keltner channels.mult {#keltner-20-channels-2e-mult}

```ts
"keltner channels.mult": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.plot.display {#klinger-20-oscillator-2e-plot-2e-display}

```ts
"klinger oscillator.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.plot.linestyle {#klinger-20-oscillator-2e-plot-2e-linestyle}

```ts
"klinger oscillator.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.plot.linewidth {#klinger-20-oscillator-2e-plot-2e-linewidth}

```ts
"klinger oscillator.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.plot.plottype {#klinger-20-oscillator-2e-plot-2e-plottype}

```ts
"klinger oscillator.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.plot.trackprice {#klinger-20-oscillator-2e-plot-2e-trackprice}

```ts
"klinger oscillator.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.plot.transparency {#klinger-20-oscillator-2e-plot-2e-transparency}

```ts
"klinger oscillator.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.plot.color {#klinger-20-oscillator-2e-plot-2e-color}

```ts
"klinger oscillator.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.signal.display {#klinger-20-oscillator-2e-signal-2e-display}

```ts
"klinger oscillator.signal.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.signal.linestyle {#klinger-20-oscillator-2e-signal-2e-linestyle}

```ts
"klinger oscillator.signal.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.signal.linewidth {#klinger-20-oscillator-2e-signal-2e-linewidth}

```ts
"klinger oscillator.signal.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.signal.plottype {#klinger-20-oscillator-2e-signal-2e-plottype}

```ts
"klinger oscillator.signal.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.signal.trackprice {#klinger-20-oscillator-2e-signal-2e-trackprice}

```ts
"klinger oscillator.signal.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.signal.transparency {#klinger-20-oscillator-2e-signal-2e-transparency}

```ts
"klinger oscillator.signal.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## klinger oscillator.signal.color {#klinger-20-oscillator-2e-signal-2e-color}

```ts
"klinger oscillator.signal.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.zero.color {#know-20-sure-20-thing-2e-zero-2e-color}

```ts
"know sure thing.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.zero.linestyle {#know-20-sure-20-thing-2e-zero-2e-linestyle}

```ts
"know sure thing.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.zero.linewidth {#know-20-sure-20-thing-2e-zero-2e-linewidth}

```ts
"know sure thing.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.zero.visible {#know-20-sure-20-thing-2e-zero-2e-visible}

```ts
"know sure thing.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.zero.value {#know-20-sure-20-thing-2e-zero-2e-value}

```ts
"know sure thing.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.kst.display {#know-20-sure-20-thing-2e-kst-2e-display}

```ts
"know sure thing.kst.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.kst.linestyle {#know-20-sure-20-thing-2e-kst-2e-linestyle}

```ts
"know sure thing.kst.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.kst.linewidth {#know-20-sure-20-thing-2e-kst-2e-linewidth}

```ts
"know sure thing.kst.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.kst.plottype {#know-20-sure-20-thing-2e-kst-2e-plottype}

```ts
"know sure thing.kst.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.kst.trackprice {#know-20-sure-20-thing-2e-kst-2e-trackprice}

```ts
"know sure thing.kst.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.kst.transparency {#know-20-sure-20-thing-2e-kst-2e-transparency}

```ts
"know sure thing.kst.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.kst.color {#know-20-sure-20-thing-2e-kst-2e-color}

```ts
"know sure thing.kst.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.signal.display {#know-20-sure-20-thing-2e-signal-2e-display}

```ts
"know sure thing.signal.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.signal.linestyle {#know-20-sure-20-thing-2e-signal-2e-linestyle}

```ts
"know sure thing.signal.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.signal.linewidth {#know-20-sure-20-thing-2e-signal-2e-linewidth}

```ts
"know sure thing.signal.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.signal.plottype {#know-20-sure-20-thing-2e-signal-2e-plottype}

```ts
"know sure thing.signal.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.signal.trackprice {#know-20-sure-20-thing-2e-signal-2e-trackprice}

```ts
"know sure thing.signal.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.signal.transparency {#know-20-sure-20-thing-2e-signal-2e-transparency}

```ts
"know sure thing.signal.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.signal.color {#know-20-sure-20-thing-2e-signal-2e-color}

```ts
"know sure thing.signal.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.roclen1 {#know-20-sure-20-thing-2e-roclen1}

```ts
"know sure thing.roclen1": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.roclen2 {#know-20-sure-20-thing-2e-roclen2}

```ts
"know sure thing.roclen2": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.roclen3 {#know-20-sure-20-thing-2e-roclen3}

```ts
"know sure thing.roclen3": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.roclen4 {#know-20-sure-20-thing-2e-roclen4}

```ts
"know sure thing.roclen4": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.smalen1 {#know-20-sure-20-thing-2e-smalen1}

```ts
"know sure thing.smalen1": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.smalen2 {#know-20-sure-20-thing-2e-smalen2}

```ts
"know sure thing.smalen2": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.smalen3 {#know-20-sure-20-thing-2e-smalen3}

```ts
"know sure thing.smalen3": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.smalen4 {#know-20-sure-20-thing-2e-smalen4}

```ts
"know sure thing.smalen4": number;
```

Use the type signature above and the integration guide for the owning capability.

## know sure thing.siglen {#know-20-sure-20-thing-2e-siglen}

```ts
"know sure thing.siglen": number;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.plot.display {#least-20-squares-20-moving-20-average-2e-plot-2e-display}

```ts
"least squares moving average.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.plot.linestyle {#least-20-squares-20-moving-20-average-2e-plot-2e-linestyle}

```ts
"least squares moving average.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.plot.linewidth {#least-20-squares-20-moving-20-average-2e-plot-2e-linewidth}

```ts
"least squares moving average.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.plot.plottype {#least-20-squares-20-moving-20-average-2e-plot-2e-plottype}

```ts
"least squares moving average.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.plot.trackprice {#least-20-squares-20-moving-20-average-2e-plot-2e-trackprice}

```ts
"least squares moving average.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.plot.transparency {#least-20-squares-20-moving-20-average-2e-plot-2e-transparency}

```ts
"least squares moving average.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.plot.color {#least-20-squares-20-moving-20-average-2e-plot-2e-color}

```ts
"least squares moving average.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.length {#least-20-squares-20-moving-20-average-2e-length}

```ts
"least squares moving average.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## least squares moving average.offset {#least-20-squares-20-moving-20-average-2e-offset}

```ts
"least squares moving average.offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.plot.display {#linear-20-regression-20-curve-2e-plot-2e-display}

```ts
"linear regression curve.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.plot.linestyle {#linear-20-regression-20-curve-2e-plot-2e-linestyle}

```ts
"linear regression curve.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.plot.linewidth {#linear-20-regression-20-curve-2e-plot-2e-linewidth}

```ts
"linear regression curve.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.plot.plottype {#linear-20-regression-20-curve-2e-plot-2e-plottype}

```ts
"linear regression curve.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.plot.trackprice {#linear-20-regression-20-curve-2e-plot-2e-trackprice}

```ts
"linear regression curve.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.plot.transparency {#linear-20-regression-20-curve-2e-plot-2e-transparency}

```ts
"linear regression curve.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.plot.color {#linear-20-regression-20-curve-2e-plot-2e-color}

```ts
"linear regression curve.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression curve.length {#linear-20-regression-20-curve-2e-length}

```ts
"linear regression curve.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.plot.display {#linear-20-regression-20-slope-2e-plot-2e-display}

```ts
"linear regression slope.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.plot.linestyle {#linear-20-regression-20-slope-2e-plot-2e-linestyle}

```ts
"linear regression slope.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.plot.linewidth {#linear-20-regression-20-slope-2e-plot-2e-linewidth}

```ts
"linear regression slope.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.plot.plottype {#linear-20-regression-20-slope-2e-plot-2e-plottype}

```ts
"linear regression slope.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.plot.trackprice {#linear-20-regression-20-slope-2e-plot-2e-trackprice}

```ts
"linear regression slope.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.plot.transparency {#linear-20-regression-20-slope-2e-plot-2e-transparency}

```ts
"linear regression slope.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.plot.color {#linear-20-regression-20-slope-2e-plot-2e-color}

```ts
"linear regression slope.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## linear regression slope.periods {#linear-20-regression-20-slope-2e-periods}

```ts
"linear regression slope.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:plot.display {#ma-20-cross-2e-short-3a-plot-2e-display}

```ts
"ma cross.short:plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:plot.linestyle {#ma-20-cross-2e-short-3a-plot-2e-linestyle}

```ts
"ma cross.short:plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:plot.linewidth {#ma-20-cross-2e-short-3a-plot-2e-linewidth}

```ts
"ma cross.short:plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:plot.plottype {#ma-20-cross-2e-short-3a-plot-2e-plottype}

```ts
"ma cross.short:plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:plot.trackprice {#ma-20-cross-2e-short-3a-plot-2e-trackprice}

```ts
"ma cross.short:plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:plot.transparency {#ma-20-cross-2e-short-3a-plot-2e-transparency}

```ts
"ma cross.short:plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:plot.color {#ma-20-cross-2e-short-3a-plot-2e-color}

```ts
"ma cross.short:plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:plot.display {#ma-20-cross-2e-long-3a-plot-2e-display}

```ts
"ma cross.long:plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:plot.linestyle {#ma-20-cross-2e-long-3a-plot-2e-linestyle}

```ts
"ma cross.long:plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:plot.linewidth {#ma-20-cross-2e-long-3a-plot-2e-linewidth}

```ts
"ma cross.long:plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:plot.plottype {#ma-20-cross-2e-long-3a-plot-2e-plottype}

```ts
"ma cross.long:plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:plot.trackprice {#ma-20-cross-2e-long-3a-plot-2e-trackprice}

```ts
"ma cross.long:plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:plot.transparency {#ma-20-cross-2e-long-3a-plot-2e-transparency}

```ts
"ma cross.long:plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:plot.color {#ma-20-cross-2e-long-3a-plot-2e-color}

```ts
"ma cross.long:plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.crosses.display {#ma-20-cross-2e-crosses-2e-display}

```ts
"ma cross.crosses.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.crosses.linestyle {#ma-20-cross-2e-crosses-2e-linestyle}

```ts
"ma cross.crosses.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.crosses.linewidth {#ma-20-cross-2e-crosses-2e-linewidth}

```ts
"ma cross.crosses.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.crosses.plottype {#ma-20-cross-2e-crosses-2e-plottype}

```ts
"ma cross.crosses.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.crosses.trackprice {#ma-20-cross-2e-crosses-2e-trackprice}

```ts
"ma cross.crosses.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.crosses.transparency {#ma-20-cross-2e-crosses-2e-transparency}

```ts
"ma cross.crosses.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.crosses.color {#ma-20-cross-2e-crosses-2e-color}

```ts
"ma cross.crosses.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.short:input {#ma-20-cross-2e-short-3a-input}

```ts
"ma cross.short:input": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma cross.long:input {#ma-20-cross-2e-long-3a-input}

```ts
"ma cross.long:input": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ma.display {#ma-20-with-20-ema-20-cross-2e-ma-2e-display}

```ts
"ma with ema cross.ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ma.linestyle {#ma-20-with-20-ema-20-cross-2e-ma-2e-linestyle}

```ts
"ma with ema cross.ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ma.linewidth {#ma-20-with-20-ema-20-cross-2e-ma-2e-linewidth}

```ts
"ma with ema cross.ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ma.plottype {#ma-20-with-20-ema-20-cross-2e-ma-2e-plottype}

```ts
"ma with ema cross.ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ma.trackprice {#ma-20-with-20-ema-20-cross-2e-ma-2e-trackprice}

```ts
"ma with ema cross.ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ma.transparency {#ma-20-with-20-ema-20-cross-2e-ma-2e-transparency}

```ts
"ma with ema cross.ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ma.color {#ma-20-with-20-ema-20-cross-2e-ma-2e-color}

```ts
"ma with ema cross.ma.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ema.display {#ma-20-with-20-ema-20-cross-2e-ema-2e-display}

```ts
"ma with ema cross.ema.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ema.linestyle {#ma-20-with-20-ema-20-cross-2e-ema-2e-linestyle}

```ts
"ma with ema cross.ema.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ema.linewidth {#ma-20-with-20-ema-20-cross-2e-ema-2e-linewidth}

```ts
"ma with ema cross.ema.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ema.plottype {#ma-20-with-20-ema-20-cross-2e-ema-2e-plottype}

```ts
"ma with ema cross.ema.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ema.trackprice {#ma-20-with-20-ema-20-cross-2e-ema-2e-trackprice}

```ts
"ma with ema cross.ema.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ema.transparency {#ma-20-with-20-ema-20-cross-2e-ema-2e-transparency}

```ts
"ma with ema cross.ema.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.ema.color {#ma-20-with-20-ema-20-cross-2e-ema-2e-color}

```ts
"ma with ema cross.ema.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.crosses.display {#ma-20-with-20-ema-20-cross-2e-crosses-2e-display}

```ts
"ma with ema cross.crosses.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.crosses.linestyle {#ma-20-with-20-ema-20-cross-2e-crosses-2e-linestyle}

```ts
"ma with ema cross.crosses.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.crosses.linewidth {#ma-20-with-20-ema-20-cross-2e-crosses-2e-linewidth}

```ts
"ma with ema cross.crosses.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.crosses.plottype {#ma-20-with-20-ema-20-cross-2e-crosses-2e-plottype}

```ts
"ma with ema cross.crosses.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.crosses.trackprice {#ma-20-with-20-ema-20-cross-2e-crosses-2e-trackprice}

```ts
"ma with ema cross.crosses.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.crosses.transparency {#ma-20-with-20-ema-20-cross-2e-crosses-2e-transparency}

```ts
"ma with ema cross.crosses.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.crosses.color {#ma-20-with-20-ema-20-cross-2e-crosses-2e-color}

```ts
"ma with ema cross.crosses.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.length ma {#ma-20-with-20-ema-20-cross-2e-length-20-ma}

```ts
"ma with ema cross.length ma": number;
```

Use the type signature above and the integration guide for the owning capability.

## ma with ema cross.length ema {#ma-20-with-20-ema-20-cross-2e-length-20-ema}

```ts
"ma with ema cross.length ema": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.histogram.display {#macd-2e-histogram-2e-display}

```ts
"macd.histogram.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.histogram.linestyle {#macd-2e-histogram-2e-linestyle}

```ts
"macd.histogram.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.histogram.linewidth {#macd-2e-histogram-2e-linewidth}

```ts
"macd.histogram.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.histogram.plottype {#macd-2e-histogram-2e-plottype}

```ts
"macd.histogram.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## macd.histogram.trackprice {#macd-2e-histogram-2e-trackprice}

```ts
"macd.histogram.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## macd.histogram.transparency {#macd-2e-histogram-2e-transparency}

```ts
"macd.histogram.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.histogram.color {#macd-2e-histogram-2e-color}

```ts
"macd.histogram.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## macd.macd.display {#macd-2e-macd-2e-display}

```ts
"macd.macd.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.macd.linestyle {#macd-2e-macd-2e-linestyle}

```ts
"macd.macd.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.macd.linewidth {#macd-2e-macd-2e-linewidth}

```ts
"macd.macd.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.macd.plottype {#macd-2e-macd-2e-plottype}

```ts
"macd.macd.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## macd.macd.trackprice {#macd-2e-macd-2e-trackprice}

```ts
"macd.macd.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## macd.macd.transparency {#macd-2e-macd-2e-transparency}

```ts
"macd.macd.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.macd.color {#macd-2e-macd-2e-color}

```ts
"macd.macd.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signal.display {#macd-2e-signal-2e-display}

```ts
"macd.signal.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signal.linestyle {#macd-2e-signal-2e-linestyle}

```ts
"macd.signal.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signal.linewidth {#macd-2e-signal-2e-linewidth}

```ts
"macd.signal.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signal.plottype {#macd-2e-signal-2e-plottype}

```ts
"macd.signal.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signal.trackprice {#macd-2e-signal-2e-trackprice}

```ts
"macd.signal.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signal.transparency {#macd-2e-signal-2e-transparency}

```ts
"macd.signal.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signal.color {#macd-2e-signal-2e-color}

```ts
"macd.signal.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## macd.fastlength {#macd-2e-fastlength}

```ts
"macd.fastlength": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.slowlength {#macd-2e-slowlength}

```ts
"macd.slowlength": number;
```

Use the type signature above and the integration guide for the owning capability.

## macd.source {#macd-2e-source}

```ts
"macd.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## macd.signallength {#macd-2e-signallength}

```ts
"macd.signallength": number;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.majority rule.display {#majority-20-rule-2e-majority-20-rule-2e-display}

```ts
"majority rule.majority rule.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.majority rule.linestyle {#majority-20-rule-2e-majority-20-rule-2e-linestyle}

```ts
"majority rule.majority rule.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.majority rule.linewidth {#majority-20-rule-2e-majority-20-rule-2e-linewidth}

```ts
"majority rule.majority rule.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.majority rule.plottype {#majority-20-rule-2e-majority-20-rule-2e-plottype}

```ts
"majority rule.majority rule.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.majority rule.trackprice {#majority-20-rule-2e-majority-20-rule-2e-trackprice}

```ts
"majority rule.majority rule.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.majority rule.transparency {#majority-20-rule-2e-majority-20-rule-2e-transparency}

```ts
"majority rule.majority rule.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.majority rule.color {#majority-20-rule-2e-majority-20-rule-2e-color}

```ts
"majority rule.majority rule.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## majority rule.rolling period {#majority-20-rule-2e-rolling-20-period}

```ts
"majority rule.rolling period": number;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.plot.display {#mass-20-index-2e-plot-2e-display}

```ts
"mass index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.plot.linestyle {#mass-20-index-2e-plot-2e-linestyle}

```ts
"mass index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.plot.linewidth {#mass-20-index-2e-plot-2e-linewidth}

```ts
"mass index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.plot.plottype {#mass-20-index-2e-plot-2e-plottype}

```ts
"mass index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.plot.trackprice {#mass-20-index-2e-plot-2e-trackprice}

```ts
"mass index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.plot.transparency {#mass-20-index-2e-plot-2e-transparency}

```ts
"mass index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.plot.color {#mass-20-index-2e-plot-2e-color}

```ts
"mass index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## mass index.length {#mass-20-index-2e-length}

```ts
"mass index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.plot.display {#mcginley-20-dynamic-2e-plot-2e-display}

```ts
"mcginley dynamic.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.plot.linestyle {#mcginley-20-dynamic-2e-plot-2e-linestyle}

```ts
"mcginley dynamic.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.plot.linewidth {#mcginley-20-dynamic-2e-plot-2e-linewidth}

```ts
"mcginley dynamic.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.plot.plottype {#mcginley-20-dynamic-2e-plot-2e-plottype}

```ts
"mcginley dynamic.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.plot.trackprice {#mcginley-20-dynamic-2e-plot-2e-trackprice}

```ts
"mcginley dynamic.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.plot.transparency {#mcginley-20-dynamic-2e-plot-2e-transparency}

```ts
"mcginley dynamic.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.plot.color {#mcginley-20-dynamic-2e-plot-2e-color}

```ts
"mcginley dynamic.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## mcginley dynamic.length {#mcginley-20-dynamic-2e-length}

```ts
"mcginley dynamic.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## median price.plot.display {#median-20-price-2e-plot-2e-display}

```ts
"median price.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## median price.plot.linestyle {#median-20-price-2e-plot-2e-linestyle}

```ts
"median price.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## median price.plot.linewidth {#median-20-price-2e-plot-2e-linewidth}

```ts
"median price.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## median price.plot.plottype {#median-20-price-2e-plot-2e-plottype}

```ts
"median price.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## median price.plot.trackprice {#median-20-price-2e-plot-2e-trackprice}

```ts
"median price.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## median price.plot.transparency {#median-20-price-2e-plot-2e-transparency}

```ts
"median price.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## median price.plot.color {#median-20-price-2e-plot-2e-color}

```ts
"median price.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.zero.color {#momentum-2e-zero-2e-color}

```ts
"momentum.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.zero.linestyle {#momentum-2e-zero-2e-linestyle}

```ts
"momentum.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.zero.linewidth {#momentum-2e-zero-2e-linewidth}

```ts
"momentum.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.zero.visible {#momentum-2e-zero-2e-visible}

```ts
"momentum.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.zero.value {#momentum-2e-zero-2e-value}

```ts
"momentum.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.mom.display {#momentum-2e-mom-2e-display}

```ts
"momentum.mom.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.mom.linestyle {#momentum-2e-mom-2e-linestyle}

```ts
"momentum.mom.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.mom.linewidth {#momentum-2e-mom-2e-linewidth}

```ts
"momentum.mom.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.mom.plottype {#momentum-2e-mom-2e-plottype}

```ts
"momentum.mom.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.mom.trackprice {#momentum-2e-mom-2e-trackprice}

```ts
"momentum.mom.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.mom.transparency {#momentum-2e-mom-2e-transparency}

```ts
"momentum.mom.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.mom.color {#momentum-2e-mom-2e-color}

```ts
"momentum.mom.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.length {#momentum-2e-length}

```ts
"momentum.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## momentum.source {#momentum-2e-source}

```ts
"momentum.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.hlines background.color {#money-20-flow-20-index-2e-hlines-20-background-2e-color}

```ts
"money flow index.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.hlines background.transparency {#money-20-flow-20-index-2e-hlines-20-background-2e-transparency}

```ts
"money flow index.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.hlines background.visible {#money-20-flow-20-index-2e-hlines-20-background-2e-visible}

```ts
"money flow index.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.upperlimit.color {#money-20-flow-20-index-2e-upperlimit-2e-color}

```ts
"money flow index.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.upperlimit.linestyle {#money-20-flow-20-index-2e-upperlimit-2e-linestyle}

```ts
"money flow index.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.upperlimit.linewidth {#money-20-flow-20-index-2e-upperlimit-2e-linewidth}

```ts
"money flow index.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.upperlimit.visible {#money-20-flow-20-index-2e-upperlimit-2e-visible}

```ts
"money flow index.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.upperlimit.value {#money-20-flow-20-index-2e-upperlimit-2e-value}

```ts
"money flow index.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.lowerlimit.color {#money-20-flow-20-index-2e-lowerlimit-2e-color}

```ts
"money flow index.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.lowerlimit.linestyle {#money-20-flow-20-index-2e-lowerlimit-2e-linestyle}

```ts
"money flow index.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.lowerlimit.linewidth {#money-20-flow-20-index-2e-lowerlimit-2e-linewidth}

```ts
"money flow index.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.lowerlimit.visible {#money-20-flow-20-index-2e-lowerlimit-2e-visible}

```ts
"money flow index.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.lowerlimit.value {#money-20-flow-20-index-2e-lowerlimit-2e-value}

```ts
"money flow index.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.plot.display {#money-20-flow-20-index-2e-plot-2e-display}

```ts
"money flow index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.plot.linestyle {#money-20-flow-20-index-2e-plot-2e-linestyle}

```ts
"money flow index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.plot.linewidth {#money-20-flow-20-index-2e-plot-2e-linewidth}

```ts
"money flow index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.plot.plottype {#money-20-flow-20-index-2e-plot-2e-plottype}

```ts
"money flow index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.plot.trackprice {#money-20-flow-20-index-2e-plot-2e-trackprice}

```ts
"money flow index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.plot.transparency {#money-20-flow-20-index-2e-plot-2e-transparency}

```ts
"money flow index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.plot.color {#money-20-flow-20-index-2e-plot-2e-color}

```ts
"money flow index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## money flow index.length {#money-20-flow-20-index-2e-length}

```ts
"money flow index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.plot.display {#moving-20-average-2e-plot-2e-display}

```ts
"moving average.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.plot.linestyle {#moving-20-average-2e-plot-2e-linestyle}

```ts
"moving average.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.plot.linewidth {#moving-20-average-2e-plot-2e-linewidth}

```ts
"moving average.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.plot.plottype {#moving-20-average-2e-plot-2e-plottype}

```ts
"moving average.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.plot.trackprice {#moving-20-average-2e-plot-2e-trackprice}

```ts
"moving average.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.plot.transparency {#moving-20-average-2e-plot-2e-transparency}

```ts
"moving average.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.plot.color {#moving-20-average-2e-plot-2e-color}

```ts
"moving average.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothed ma.display {#moving-20-average-2e-smoothed-20-ma-2e-display}

```ts
"moving average.smoothed ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothed ma.linestyle {#moving-20-average-2e-smoothed-20-ma-2e-linestyle}

```ts
"moving average.smoothed ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothed ma.linewidth {#moving-20-average-2e-smoothed-20-ma-2e-linewidth}

```ts
"moving average.smoothed ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothed ma.plottype {#moving-20-average-2e-smoothed-20-ma-2e-plottype}

```ts
"moving average.smoothed ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothed ma.trackprice {#moving-20-average-2e-smoothed-20-ma-2e-trackprice}

```ts
"moving average.smoothed ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothed ma.transparency {#moving-20-average-2e-smoothed-20-ma-2e-transparency}

```ts
"moving average.smoothed ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.other symbol {#moving-20-average-2e-other-20-symbol}

```ts
"moving average.other symbol": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.length {#moving-20-average-2e-length}

```ts
"moving average.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.source {#moving-20-average-2e-source}

```ts
"moving average.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.offset {#moving-20-average-2e-offset}

```ts
"moving average.offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothing line {#moving-20-average-2e-smoothing-20-line}

```ts
"moving average.smoothing line": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average.smoothing length {#moving-20-average-2e-smoothing-20-length}

```ts
"moving average.smoothing length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.plot 1.display {#moving-20-average-20-adaptive-2e-plot-20-1-2e-display}

```ts
"moving average adaptive.plot 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.plot 1.linestyle {#moving-20-average-20-adaptive-2e-plot-20-1-2e-linestyle}

```ts
"moving average adaptive.plot 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.plot 1.linewidth {#moving-20-average-20-adaptive-2e-plot-20-1-2e-linewidth}

```ts
"moving average adaptive.plot 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.plot 1.plottype {#moving-20-average-20-adaptive-2e-plot-20-1-2e-plottype}

```ts
"moving average adaptive.plot 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.plot 1.transparency {#moving-20-average-20-adaptive-2e-plot-20-1-2e-transparency}

```ts
"moving average adaptive.plot 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.plot 1.trackprice {#moving-20-average-20-adaptive-2e-plot-20-1-2e-trackprice}

```ts
"moving average adaptive.plot 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.plot 1.color {#moving-20-average-20-adaptive-2e-plot-20-1-2e-color}

```ts
"moving average adaptive.plot 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average adaptive.period {#moving-20-average-20-adaptive-2e-period}

```ts
"moving average adaptive.period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.plots background.color {#moving-20-average-20-channel-2e-plots-20-background-2e-color}

```ts
"moving average channel.plots background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.plots background.transparency {#moving-20-average-20-channel-2e-plots-20-background-2e-transparency}

```ts
"moving average channel.plots background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.plots background.visible {#moving-20-average-20-channel-2e-plots-20-background-2e-visible}

```ts
"moving average channel.plots background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper.display {#moving-20-average-20-channel-2e-upper-2e-display}

```ts
"moving average channel.upper.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper.linestyle {#moving-20-average-20-channel-2e-upper-2e-linestyle}

```ts
"moving average channel.upper.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper.linewidth {#moving-20-average-20-channel-2e-upper-2e-linewidth}

```ts
"moving average channel.upper.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper.plottype {#moving-20-average-20-channel-2e-upper-2e-plottype}

```ts
"moving average channel.upper.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper.trackprice {#moving-20-average-20-channel-2e-upper-2e-trackprice}

```ts
"moving average channel.upper.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper.transparency {#moving-20-average-20-channel-2e-upper-2e-transparency}

```ts
"moving average channel.upper.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper.color {#moving-20-average-20-channel-2e-upper-2e-color}

```ts
"moving average channel.upper.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower.display {#moving-20-average-20-channel-2e-lower-2e-display}

```ts
"moving average channel.lower.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower.linestyle {#moving-20-average-20-channel-2e-lower-2e-linestyle}

```ts
"moving average channel.lower.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower.linewidth {#moving-20-average-20-channel-2e-lower-2e-linewidth}

```ts
"moving average channel.lower.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower.plottype {#moving-20-average-20-channel-2e-lower-2e-plottype}

```ts
"moving average channel.lower.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower.trackprice {#moving-20-average-20-channel-2e-lower-2e-trackprice}

```ts
"moving average channel.lower.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower.transparency {#moving-20-average-20-channel-2e-lower-2e-transparency}

```ts
"moving average channel.lower.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower.color {#moving-20-average-20-channel-2e-lower-2e-color}

```ts
"moving average channel.lower.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper length {#moving-20-average-20-channel-2e-upper-20-length}

```ts
"moving average channel.upper length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower length {#moving-20-average-20-channel-2e-lower-20-length}

```ts
"moving average channel.lower length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.upper offset {#moving-20-average-20-channel-2e-upper-20-offset}

```ts
"moving average channel.upper offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average channel.lower offset {#moving-20-average-20-channel-2e-lower-20-offset}

```ts
"moving average channel.lower offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 1.display {#moving-20-average-20-double-2e-plot-20-1-2e-display}

```ts
"moving average double.plot 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 1.linestyle {#moving-20-average-20-double-2e-plot-20-1-2e-linestyle}

```ts
"moving average double.plot 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 1.linewidth {#moving-20-average-20-double-2e-plot-20-1-2e-linewidth}

```ts
"moving average double.plot 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 1.plottype {#moving-20-average-20-double-2e-plot-20-1-2e-plottype}

```ts
"moving average double.plot 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 1.trackprice {#moving-20-average-20-double-2e-plot-20-1-2e-trackprice}

```ts
"moving average double.plot 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 1.transparency {#moving-20-average-20-double-2e-plot-20-1-2e-transparency}

```ts
"moving average double.plot 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 1.color {#moving-20-average-20-double-2e-plot-20-1-2e-color}

```ts
"moving average double.plot 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 2.display {#moving-20-average-20-double-2e-plot-20-2-2e-display}

```ts
"moving average double.plot 2.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 2.linestyle {#moving-20-average-20-double-2e-plot-20-2-2e-linestyle}

```ts
"moving average double.plot 2.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 2.linewidth {#moving-20-average-20-double-2e-plot-20-2-2e-linewidth}

```ts
"moving average double.plot 2.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 2.plottype {#moving-20-average-20-double-2e-plot-20-2-2e-plottype}

```ts
"moving average double.plot 2.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 2.trackprice {#moving-20-average-20-double-2e-plot-20-2-2e-trackprice}

```ts
"moving average double.plot 2.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 2.transparency {#moving-20-average-20-double-2e-plot-20-2-2e-transparency}

```ts
"moving average double.plot 2.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.plot 2.color {#moving-20-average-20-double-2e-plot-20-2-2e-color}

```ts
"moving average double.plot 2.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.1st period {#moving-20-average-20-double-2e-1st-20-period}

```ts
"moving average double.1st period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.2nd period {#moving-20-average-20-double-2e-2nd-20-period}

```ts
"moving average double.2nd period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average double.method {#moving-20-average-20-double-2e-method}

```ts
"moving average double.method": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.plot.display {#moving-20-average-20-exponential-2e-plot-2e-display}

```ts
"moving average exponential.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.plot.linestyle {#moving-20-average-20-exponential-2e-plot-2e-linestyle}

```ts
"moving average exponential.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.plot.linewidth {#moving-20-average-20-exponential-2e-plot-2e-linewidth}

```ts
"moving average exponential.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.plot.plottype {#moving-20-average-20-exponential-2e-plot-2e-plottype}

```ts
"moving average exponential.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.plot.trackprice {#moving-20-average-20-exponential-2e-plot-2e-trackprice}

```ts
"moving average exponential.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.plot.transparency {#moving-20-average-20-exponential-2e-plot-2e-transparency}

```ts
"moving average exponential.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.plot.color {#moving-20-average-20-exponential-2e-plot-2e-color}

```ts
"moving average exponential.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothed ma.display {#moving-20-average-20-exponential-2e-smoothed-20-ma-2e-display}

```ts
"moving average exponential.smoothed ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothed ma.linestyle {#moving-20-average-20-exponential-2e-smoothed-20-ma-2e-linestyle}

```ts
"moving average exponential.smoothed ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothed ma.linewidth {#moving-20-average-20-exponential-2e-smoothed-20-ma-2e-linewidth}

```ts
"moving average exponential.smoothed ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothed ma.plottype {#moving-20-average-20-exponential-2e-smoothed-20-ma-2e-plottype}

```ts
"moving average exponential.smoothed ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothed ma.trackprice {#moving-20-average-20-exponential-2e-smoothed-20-ma-2e-trackprice}

```ts
"moving average exponential.smoothed ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothed ma.transparency {#moving-20-average-20-exponential-2e-smoothed-20-ma-2e-transparency}

```ts
"moving average exponential.smoothed ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.length {#moving-20-average-20-exponential-2e-length}

```ts
"moving average exponential.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.source {#moving-20-average-20-exponential-2e-source}

```ts
"moving average exponential.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.offset {#moving-20-average-20-exponential-2e-offset}

```ts
"moving average exponential.offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothing line {#moving-20-average-20-exponential-2e-smoothing-20-line}

```ts
"moving average exponential.smoothing line": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average exponential.smoothing length {#moving-20-average-20-exponential-2e-smoothing-20-length}

```ts
"moving average exponential.smoothing length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.plot 1.display {#moving-20-average-20-hamming-2e-plot-20-1-2e-display}

```ts
"moving average hamming.plot 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.plot 1.linestyle {#moving-20-average-20-hamming-2e-plot-20-1-2e-linestyle}

```ts
"moving average hamming.plot 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.plot 1.linewidth {#moving-20-average-20-hamming-2e-plot-20-1-2e-linewidth}

```ts
"moving average hamming.plot 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.plot 1.plottype {#moving-20-average-20-hamming-2e-plot-20-1-2e-plottype}

```ts
"moving average hamming.plot 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.plot 1.transparency {#moving-20-average-20-hamming-2e-plot-20-1-2e-transparency}

```ts
"moving average hamming.plot 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.plot 1.trackprice {#moving-20-average-20-hamming-2e-plot-20-1-2e-trackprice}

```ts
"moving average hamming.plot 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.plot 1.color {#moving-20-average-20-hamming-2e-plot-20-1-2e-color}

```ts
"moving average hamming.plot 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average hamming.period {#moving-20-average-20-hamming-2e-period}

```ts
"moving average hamming.period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 1.display {#moving-20-average-20-multiple-2e-plot-20-1-2e-display}

```ts
"moving average multiple.plot 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 1.linestyle {#moving-20-average-20-multiple-2e-plot-20-1-2e-linestyle}

```ts
"moving average multiple.plot 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 1.linewidth {#moving-20-average-20-multiple-2e-plot-20-1-2e-linewidth}

```ts
"moving average multiple.plot 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 1.plottype {#moving-20-average-20-multiple-2e-plot-20-1-2e-plottype}

```ts
"moving average multiple.plot 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 1.transparency {#moving-20-average-20-multiple-2e-plot-20-1-2e-transparency}

```ts
"moving average multiple.plot 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 1.trackprice {#moving-20-average-20-multiple-2e-plot-20-1-2e-trackprice}

```ts
"moving average multiple.plot 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 1.color {#moving-20-average-20-multiple-2e-plot-20-1-2e-color}

```ts
"moving average multiple.plot 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 2.display {#moving-20-average-20-multiple-2e-plot-20-2-2e-display}

```ts
"moving average multiple.plot 2.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 2.linestyle {#moving-20-average-20-multiple-2e-plot-20-2-2e-linestyle}

```ts
"moving average multiple.plot 2.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 2.linewidth {#moving-20-average-20-multiple-2e-plot-20-2-2e-linewidth}

```ts
"moving average multiple.plot 2.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 2.transparency {#moving-20-average-20-multiple-2e-plot-20-2-2e-transparency}

```ts
"moving average multiple.plot 2.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 2.plottype {#moving-20-average-20-multiple-2e-plot-20-2-2e-plottype}

```ts
"moving average multiple.plot 2.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 2.trackprice {#moving-20-average-20-multiple-2e-plot-20-2-2e-trackprice}

```ts
"moving average multiple.plot 2.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 2.color {#moving-20-average-20-multiple-2e-plot-20-2-2e-color}

```ts
"moving average multiple.plot 2.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 3.display {#moving-20-average-20-multiple-2e-plot-20-3-2e-display}

```ts
"moving average multiple.plot 3.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 3.linestyle {#moving-20-average-20-multiple-2e-plot-20-3-2e-linestyle}

```ts
"moving average multiple.plot 3.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 3.linewidth {#moving-20-average-20-multiple-2e-plot-20-3-2e-linewidth}

```ts
"moving average multiple.plot 3.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 3.transparency {#moving-20-average-20-multiple-2e-plot-20-3-2e-transparency}

```ts
"moving average multiple.plot 3.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 3.plottype {#moving-20-average-20-multiple-2e-plot-20-3-2e-plottype}

```ts
"moving average multiple.plot 3.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 3.trackprice {#moving-20-average-20-multiple-2e-plot-20-3-2e-trackprice}

```ts
"moving average multiple.plot 3.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 3.color {#moving-20-average-20-multiple-2e-plot-20-3-2e-color}

```ts
"moving average multiple.plot 3.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 4.display {#moving-20-average-20-multiple-2e-plot-20-4-2e-display}

```ts
"moving average multiple.plot 4.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 4.linestyle {#moving-20-average-20-multiple-2e-plot-20-4-2e-linestyle}

```ts
"moving average multiple.plot 4.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 4.linewidth {#moving-20-average-20-multiple-2e-plot-20-4-2e-linewidth}

```ts
"moving average multiple.plot 4.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 4.transparency {#moving-20-average-20-multiple-2e-plot-20-4-2e-transparency}

```ts
"moving average multiple.plot 4.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 4.plottype {#moving-20-average-20-multiple-2e-plot-20-4-2e-plottype}

```ts
"moving average multiple.plot 4.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 4.trackprice {#moving-20-average-20-multiple-2e-plot-20-4-2e-trackprice}

```ts
"moving average multiple.plot 4.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 4.color {#moving-20-average-20-multiple-2e-plot-20-4-2e-color}

```ts
"moving average multiple.plot 4.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 5.display {#moving-20-average-20-multiple-2e-plot-20-5-2e-display}

```ts
"moving average multiple.plot 5.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 5.linestyle {#moving-20-average-20-multiple-2e-plot-20-5-2e-linestyle}

```ts
"moving average multiple.plot 5.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 5.linewidth {#moving-20-average-20-multiple-2e-plot-20-5-2e-linewidth}

```ts
"moving average multiple.plot 5.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 5.transparency {#moving-20-average-20-multiple-2e-plot-20-5-2e-transparency}

```ts
"moving average multiple.plot 5.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 5.plottype {#moving-20-average-20-multiple-2e-plot-20-5-2e-plottype}

```ts
"moving average multiple.plot 5.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 5.trackprice {#moving-20-average-20-multiple-2e-plot-20-5-2e-trackprice}

```ts
"moving average multiple.plot 5.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 5.color {#moving-20-average-20-multiple-2e-plot-20-5-2e-color}

```ts
"moving average multiple.plot 5.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 6.display {#moving-20-average-20-multiple-2e-plot-20-6-2e-display}

```ts
"moving average multiple.plot 6.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 6.linestyle {#moving-20-average-20-multiple-2e-plot-20-6-2e-linestyle}

```ts
"moving average multiple.plot 6.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 6.linewidth {#moving-20-average-20-multiple-2e-plot-20-6-2e-linewidth}

```ts
"moving average multiple.plot 6.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 6.transparency {#moving-20-average-20-multiple-2e-plot-20-6-2e-transparency}

```ts
"moving average multiple.plot 6.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 6.plottype {#moving-20-average-20-multiple-2e-plot-20-6-2e-plottype}

```ts
"moving average multiple.plot 6.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 6.trackprice {#moving-20-average-20-multiple-2e-plot-20-6-2e-trackprice}

```ts
"moving average multiple.plot 6.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.plot 6.color {#moving-20-average-20-multiple-2e-plot-20-6-2e-color}

```ts
"moving average multiple.plot 6.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.1st period {#moving-20-average-20-multiple-2e-1st-20-period}

```ts
"moving average multiple.1st period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.2nd period {#moving-20-average-20-multiple-2e-2nd-20-period}

```ts
"moving average multiple.2nd period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.3rd period {#moving-20-average-20-multiple-2e-3rd-20-period}

```ts
"moving average multiple.3rd period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.4th period {#moving-20-average-20-multiple-2e-4th-20-period}

```ts
"moving average multiple.4th period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.5th period {#moving-20-average-20-multiple-2e-5th-20-period}

```ts
"moving average multiple.5th period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.6th period {#moving-20-average-20-multiple-2e-6th-20-period}

```ts
"moving average multiple.6th period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average multiple.method {#moving-20-average-20-multiple-2e-method}

```ts
"moving average multiple.method": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 1.display {#moving-20-average-20-triple-2e-plot-20-1-2e-display}

```ts
"moving average triple.plot 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 1.linestyle {#moving-20-average-20-triple-2e-plot-20-1-2e-linestyle}

```ts
"moving average triple.plot 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 1.linewidth {#moving-20-average-20-triple-2e-plot-20-1-2e-linewidth}

```ts
"moving average triple.plot 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 1.plottype {#moving-20-average-20-triple-2e-plot-20-1-2e-plottype}

```ts
"moving average triple.plot 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 1.transparency {#moving-20-average-20-triple-2e-plot-20-1-2e-transparency}

```ts
"moving average triple.plot 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 1.trackprice {#moving-20-average-20-triple-2e-plot-20-1-2e-trackprice}

```ts
"moving average triple.plot 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 1.color {#moving-20-average-20-triple-2e-plot-20-1-2e-color}

```ts
"moving average triple.plot 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 2.display {#moving-20-average-20-triple-2e-plot-20-2-2e-display}

```ts
"moving average triple.plot 2.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 2.linestyle {#moving-20-average-20-triple-2e-plot-20-2-2e-linestyle}

```ts
"moving average triple.plot 2.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 2.linewidth {#moving-20-average-20-triple-2e-plot-20-2-2e-linewidth}

```ts
"moving average triple.plot 2.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 2.transparency {#moving-20-average-20-triple-2e-plot-20-2-2e-transparency}

```ts
"moving average triple.plot 2.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 2.plottype {#moving-20-average-20-triple-2e-plot-20-2-2e-plottype}

```ts
"moving average triple.plot 2.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 2.trackprice {#moving-20-average-20-triple-2e-plot-20-2-2e-trackprice}

```ts
"moving average triple.plot 2.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 2.color {#moving-20-average-20-triple-2e-plot-20-2-2e-color}

```ts
"moving average triple.plot 2.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 3.display {#moving-20-average-20-triple-2e-plot-20-3-2e-display}

```ts
"moving average triple.plot 3.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 3.linestyle {#moving-20-average-20-triple-2e-plot-20-3-2e-linestyle}

```ts
"moving average triple.plot 3.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 3.linewidth {#moving-20-average-20-triple-2e-plot-20-3-2e-linewidth}

```ts
"moving average triple.plot 3.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 3.transparency {#moving-20-average-20-triple-2e-plot-20-3-2e-transparency}

```ts
"moving average triple.plot 3.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 3.plottype {#moving-20-average-20-triple-2e-plot-20-3-2e-plottype}

```ts
"moving average triple.plot 3.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 3.trackprice {#moving-20-average-20-triple-2e-plot-20-3-2e-trackprice}

```ts
"moving average triple.plot 3.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.plot 3.color {#moving-20-average-20-triple-2e-plot-20-3-2e-color}

```ts
"moving average triple.plot 3.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.1st period {#moving-20-average-20-triple-2e-1st-20-period}

```ts
"moving average triple.1st period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.2nd period {#moving-20-average-20-triple-2e-2nd-20-period}

```ts
"moving average triple.2nd period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.3rd period {#moving-20-average-20-triple-2e-3rd-20-period}

```ts
"moving average triple.3rd period": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average triple.method {#moving-20-average-20-triple-2e-method}

```ts
"moving average triple.method": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.plot.display {#moving-20-average-20-weighted-2e-plot-2e-display}

```ts
"moving average weighted.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.plot.linestyle {#moving-20-average-20-weighted-2e-plot-2e-linestyle}

```ts
"moving average weighted.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.plot.linewidth {#moving-20-average-20-weighted-2e-plot-2e-linewidth}

```ts
"moving average weighted.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.plot.plottype {#moving-20-average-20-weighted-2e-plot-2e-plottype}

```ts
"moving average weighted.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.plot.trackprice {#moving-20-average-20-weighted-2e-plot-2e-trackprice}

```ts
"moving average weighted.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.plot.transparency {#moving-20-average-20-weighted-2e-plot-2e-transparency}

```ts
"moving average weighted.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.plot.color {#moving-20-average-20-weighted-2e-plot-2e-color}

```ts
"moving average weighted.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.length {#moving-20-average-20-weighted-2e-length}

```ts
"moving average weighted.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.source {#moving-20-average-20-weighted-2e-source}

```ts
"moving average weighted.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## moving average weighted.offset {#moving-20-average-20-weighted-2e-offset}

```ts
"moving average weighted.offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## net volume.plot.display {#net-20-volume-2e-plot-2e-display}

```ts
"net volume.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## net volume.plot.linestyle {#net-20-volume-2e-plot-2e-linestyle}

```ts
"net volume.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## net volume.plot.linewidth {#net-20-volume-2e-plot-2e-linewidth}

```ts
"net volume.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## net volume.plot.plottype {#net-20-volume-2e-plot-2e-plottype}

```ts
"net volume.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## net volume.plot.trackprice {#net-20-volume-2e-plot-2e-trackprice}

```ts
"net volume.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## net volume.plot.transparency {#net-20-volume-2e-plot-2e-transparency}

```ts
"net volume.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## net volume.plot.color {#net-20-volume-2e-plot-2e-color}

```ts
"net volume.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.plot.display {#on-20-balance-20-volume-2e-plot-2e-display}

```ts
"on balance volume.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.plot.linestyle {#on-20-balance-20-volume-2e-plot-2e-linestyle}

```ts
"on balance volume.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.plot.linewidth {#on-20-balance-20-volume-2e-plot-2e-linewidth}

```ts
"on balance volume.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.plot.plottype {#on-20-balance-20-volume-2e-plot-2e-plottype}

```ts
"on balance volume.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.plot.trackprice {#on-20-balance-20-volume-2e-plot-2e-trackprice}

```ts
"on balance volume.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.plot.transparency {#on-20-balance-20-volume-2e-plot-2e-transparency}

```ts
"on balance volume.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.plot.color {#on-20-balance-20-volume-2e-plot-2e-color}

```ts
"on balance volume.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothed ma.display {#on-20-balance-20-volume-2e-smoothed-20-ma-2e-display}

```ts
"on balance volume.smoothed ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothed ma.linestyle {#on-20-balance-20-volume-2e-smoothed-20-ma-2e-linestyle}

```ts
"on balance volume.smoothed ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothed ma.linewidth {#on-20-balance-20-volume-2e-smoothed-20-ma-2e-linewidth}

```ts
"on balance volume.smoothed ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothed ma.plottype {#on-20-balance-20-volume-2e-smoothed-20-ma-2e-plottype}

```ts
"on balance volume.smoothed ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothed ma.trackprice {#on-20-balance-20-volume-2e-smoothed-20-ma-2e-trackprice}

```ts
"on balance volume.smoothed ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothed ma.transparency {#on-20-balance-20-volume-2e-smoothed-20-ma-2e-transparency}

```ts
"on balance volume.smoothed ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothing line {#on-20-balance-20-volume-2e-smoothing-20-line}

```ts
"on balance volume.smoothing line": string;
```

Use the type signature above and the integration guide for the owning capability.

## on balance volume.smoothing length {#on-20-balance-20-volume-2e-smoothing-20-length}

```ts
"on balance volume.smoothing length": number;
```

Use the type signature above and the integration guide for the owning capability.

## overlay.symbol {#overlay-2e-symbol}

```ts
"overlay.symbol": string;
```

Use the type signature above and the integration guide for the owning capability.

## overlay.extendtimescale {#overlay-2e-extendtimescale}

```ts
"overlay.extendtimescale": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.plot.display {#parabolic-20-sar-2e-plot-2e-display}

```ts
"parabolic sar.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.plot.linestyle {#parabolic-20-sar-2e-plot-2e-linestyle}

```ts
"parabolic sar.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.plot.linewidth {#parabolic-20-sar-2e-plot-2e-linewidth}

```ts
"parabolic sar.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.plot.plottype {#parabolic-20-sar-2e-plot-2e-plottype}

```ts
"parabolic sar.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.plot.trackprice {#parabolic-20-sar-2e-plot-2e-trackprice}

```ts
"parabolic sar.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.plot.transparency {#parabolic-20-sar-2e-plot-2e-transparency}

```ts
"parabolic sar.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.plot.color {#parabolic-20-sar-2e-plot-2e-color}

```ts
"parabolic sar.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.start {#parabolic-20-sar-2e-start}

```ts
"parabolic sar.start": number;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.increment {#parabolic-20-sar-2e-increment}

```ts
"parabolic sar.increment": number;
```

Use the type signature above and the integration guide for the owning capability.

## parabolic sar.maximum {#parabolic-20-sar-2e-maximum}

```ts
"parabolic sar.maximum": number;
```

Use the type signature above and the integration guide for the owning capability.

## pivot points standard.type {#pivot-20-points-20-standard-2e-type}

```ts
"pivot points standard.type": string;
```

Use the type signature above and the integration guide for the owning capability.

## pivot points standard.number of pivots back {#pivot-20-points-20-standard-2e-number-20-of-20-pivots-20-back}

```ts
"pivot points standard.number of pivots back": number;
```

Use the type signature above and the integration guide for the owning capability.

## pivot points standard.pivots timeframe {#pivot-20-points-20-standard-2e-pivots-20-timeframe}

```ts
"pivot points standard.pivots timeframe": string;
```

Use the type signature above and the integration guide for the owning capability.

## pivot points standard.show historical pivots {#pivot-20-points-20-standard-2e-show-20-historical-20-pivots}

```ts
"pivot points standard.show historical pivots": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.highprice line.display {#price-20-channel-2e-highprice-20-line-2e-display}

```ts
"price channel.highprice line.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.highprice line.linestyle {#price-20-channel-2e-highprice-20-line-2e-linestyle}

```ts
"price channel.highprice line.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.highprice line.linewidth {#price-20-channel-2e-highprice-20-line-2e-linewidth}

```ts
"price channel.highprice line.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.highprice line.plottype {#price-20-channel-2e-highprice-20-line-2e-plottype}

```ts
"price channel.highprice line.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.highprice line.trackprice {#price-20-channel-2e-highprice-20-line-2e-trackprice}

```ts
"price channel.highprice line.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.highprice line.transparency {#price-20-channel-2e-highprice-20-line-2e-transparency}

```ts
"price channel.highprice line.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.highprice line.color {#price-20-channel-2e-highprice-20-line-2e-color}

```ts
"price channel.highprice line.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.lowprice line.display {#price-20-channel-2e-lowprice-20-line-2e-display}

```ts
"price channel.lowprice line.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.lowprice line.linestyle {#price-20-channel-2e-lowprice-20-line-2e-linestyle}

```ts
"price channel.lowprice line.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.lowprice line.linewidth {#price-20-channel-2e-lowprice-20-line-2e-linewidth}

```ts
"price channel.lowprice line.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.lowprice line.plottype {#price-20-channel-2e-lowprice-20-line-2e-plottype}

```ts
"price channel.lowprice line.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.lowprice line.trackprice {#price-20-channel-2e-lowprice-20-line-2e-trackprice}

```ts
"price channel.lowprice line.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.lowprice line.transparency {#price-20-channel-2e-lowprice-20-line-2e-transparency}

```ts
"price channel.lowprice line.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.lowprice line.color {#price-20-channel-2e-lowprice-20-line-2e-color}

```ts
"price channel.lowprice line.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.centerprice line.display {#price-20-channel-2e-centerprice-20-line-2e-display}

```ts
"price channel.centerprice line.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.centerprice line.linestyle {#price-20-channel-2e-centerprice-20-line-2e-linestyle}

```ts
"price channel.centerprice line.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.centerprice line.linewidth {#price-20-channel-2e-centerprice-20-line-2e-linewidth}

```ts
"price channel.centerprice line.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.centerprice line.plottype {#price-20-channel-2e-centerprice-20-line-2e-plottype}

```ts
"price channel.centerprice line.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.centerprice line.trackprice {#price-20-channel-2e-centerprice-20-line-2e-trackprice}

```ts
"price channel.centerprice line.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.centerprice line.transparency {#price-20-channel-2e-centerprice-20-line-2e-transparency}

```ts
"price channel.centerprice line.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.centerprice line.color {#price-20-channel-2e-centerprice-20-line-2e-color}

```ts
"price channel.centerprice line.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.length {#price-20-channel-2e-length}

```ts
"price channel.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## price channel.offset length {#price-20-channel-2e-offset-20-length}

```ts
"price channel.offset length": number;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.plot.display {#price-20-oscillator-2e-plot-2e-display}

```ts
"price oscillator.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.plot.linestyle {#price-20-oscillator-2e-plot-2e-linestyle}

```ts
"price oscillator.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.plot.linewidth {#price-20-oscillator-2e-plot-2e-linewidth}

```ts
"price oscillator.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.plot.plottype {#price-20-oscillator-2e-plot-2e-plottype}

```ts
"price oscillator.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.plot.trackprice {#price-20-oscillator-2e-plot-2e-trackprice}

```ts
"price oscillator.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.plot.transparency {#price-20-oscillator-2e-plot-2e-transparency}

```ts
"price oscillator.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.plot.color {#price-20-oscillator-2e-plot-2e-color}

```ts
"price oscillator.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.shortlen {#price-20-oscillator-2e-shortlen}

```ts
"price oscillator.shortlen": number;
```

Use the type signature above and the integration guide for the owning capability.

## price oscillator.longlen {#price-20-oscillator-2e-longlen}

```ts
"price oscillator.longlen": number;
```

Use the type signature above and the integration guide for the owning capability.

## price volume trend.pvt.display {#price-20-volume-20-trend-2e-pvt-2e-display}

```ts
"price volume trend.pvt.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## price volume trend.pvt.linestyle {#price-20-volume-20-trend-2e-pvt-2e-linestyle}

```ts
"price volume trend.pvt.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## price volume trend.pvt.linewidth {#price-20-volume-20-trend-2e-pvt-2e-linewidth}

```ts
"price volume trend.pvt.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## price volume trend.pvt.plottype {#price-20-volume-20-trend-2e-pvt-2e-plottype}

```ts
"price volume trend.pvt.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## price volume trend.pvt.trackprice {#price-20-volume-20-trend-2e-pvt-2e-trackprice}

```ts
"price volume trend.pvt.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## price volume trend.pvt.transparency {#price-20-volume-20-trend-2e-pvt-2e-transparency}

```ts
"price volume trend.pvt.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## price volume trend.pvt.color {#price-20-volume-20-trend-2e-pvt-2e-color}

```ts
"price volume trend.pvt.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.zero line.color {#rate-20-of-20-change-2e-zero-20-line-2e-color}

```ts
"rate of change.zero line.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.zero line.linestyle {#rate-20-of-20-change-2e-zero-20-line-2e-linestyle}

```ts
"rate of change.zero line.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.zero line.linewidth {#rate-20-of-20-change-2e-zero-20-line-2e-linewidth}

```ts
"rate of change.zero line.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.zero line.visible {#rate-20-of-20-change-2e-zero-20-line-2e-visible}

```ts
"rate of change.zero line.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.zero line.value {#rate-20-of-20-change-2e-zero-20-line-2e-value}

```ts
"rate of change.zero line.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.roc.display {#rate-20-of-20-change-2e-roc-2e-display}

```ts
"rate of change.roc.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.roc.linestyle {#rate-20-of-20-change-2e-roc-2e-linestyle}

```ts
"rate of change.roc.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.roc.linewidth {#rate-20-of-20-change-2e-roc-2e-linewidth}

```ts
"rate of change.roc.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.roc.plottype {#rate-20-of-20-change-2e-roc-2e-plottype}

```ts
"rate of change.roc.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.roc.trackprice {#rate-20-of-20-change-2e-roc-2e-trackprice}

```ts
"rate of change.roc.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.roc.transparency {#rate-20-of-20-change-2e-roc-2e-transparency}

```ts
"rate of change.roc.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.roc.color {#rate-20-of-20-change-2e-roc-2e-color}

```ts
"rate of change.roc.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## rate of change.length {#rate-20-of-20-change-2e-length}

```ts
"rate of change.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.plot.linestyle {#ratio-2e-plot-2e-linestyle}

```ts
"ratio.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.plot.linewidth {#ratio-2e-plot-2e-linewidth}

```ts
"ratio.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.plot.plottype {#ratio-2e-plot-2e-plottype}

```ts
"ratio.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.plot.trackprice {#ratio-2e-plot-2e-trackprice}

```ts
"ratio.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.plot.transparency {#ratio-2e-plot-2e-transparency}

```ts
"ratio.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.plot.color {#ratio-2e-plot-2e-color}

```ts
"ratio.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.plot.display {#ratio-2e-plot-2e-display}

```ts
"ratio.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.source {#ratio-2e-source}

```ts
"ratio.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## ratio.symbol {#ratio-2e-symbol}

```ts
"ratio.symbol": string;
```

Use the type signature above and the integration guide for the owning capability.

## regression trend.first bar time {#regression-20-trend-2e-first-20-bar-20-time}

```ts
"regression trend.first bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## regression trend.last bar time {#regression-20-trend-2e-last-20-bar-20-time}

```ts
"regression trend.last bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## regression trend.lower deviation {#regression-20-trend-2e-lower-20-deviation}

```ts
"regression trend.lower deviation": number;
```

Use the type signature above and the integration guide for the owning capability.

## regression trend.source {#regression-20-trend-2e-source}

```ts
"regression trend.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## regression trend.upper deviation {#regression-20-trend-2e-upper-20-deviation}

```ts
"regression trend.upper deviation": number;
```

Use the type signature above and the integration guide for the owning capability.

## regression trend.use lower deviation {#regression-20-trend-2e-use-20-lower-20-deviation}

```ts
"regression trend.use lower deviation": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## regression trend.use upper deviation {#regression-20-trend-2e-use-20-upper-20-deviation}

```ts
"regression trend.use upper deviation": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.hlines background.color {#relative-20-strength-20-index-2e-hlines-20-background-2e-color}

```ts
"relative strength index.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.hlines background.transparency {#relative-20-strength-20-index-2e-hlines-20-background-2e-transparency}

```ts
"relative strength index.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.hlines background.visible {#relative-20-strength-20-index-2e-hlines-20-background-2e-visible}

```ts
"relative strength index.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.upperlimit.color {#relative-20-strength-20-index-2e-upperlimit-2e-color}

```ts
"relative strength index.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.upperlimit.linestyle {#relative-20-strength-20-index-2e-upperlimit-2e-linestyle}

```ts
"relative strength index.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.upperlimit.linewidth {#relative-20-strength-20-index-2e-upperlimit-2e-linewidth}

```ts
"relative strength index.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.upperlimit.visible {#relative-20-strength-20-index-2e-upperlimit-2e-visible}

```ts
"relative strength index.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.upperlimit.value {#relative-20-strength-20-index-2e-upperlimit-2e-value}

```ts
"relative strength index.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.upperlimit.zorder {#relative-20-strength-20-index-2e-upperlimit-2e-zorder}

```ts
"relative strength index.upperlimit.zorder": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.middlelimit.color {#relative-20-strength-20-index-2e-middlelimit-2e-color}

```ts
"relative strength index.middlelimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.middlelimit.linestyle {#relative-20-strength-20-index-2e-middlelimit-2e-linestyle}

```ts
"relative strength index.middlelimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.middlelimit.linewidth {#relative-20-strength-20-index-2e-middlelimit-2e-linewidth}

```ts
"relative strength index.middlelimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.middlelimit.visible {#relative-20-strength-20-index-2e-middlelimit-2e-visible}

```ts
"relative strength index.middlelimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.middlelimit.value {#relative-20-strength-20-index-2e-middlelimit-2e-value}

```ts
"relative strength index.middlelimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.middlelimit.zorder {#relative-20-strength-20-index-2e-middlelimit-2e-zorder}

```ts
"relative strength index.middlelimit.zorder": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.lowerlimit.color {#relative-20-strength-20-index-2e-lowerlimit-2e-color}

```ts
"relative strength index.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.lowerlimit.linestyle {#relative-20-strength-20-index-2e-lowerlimit-2e-linestyle}

```ts
"relative strength index.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.lowerlimit.linewidth {#relative-20-strength-20-index-2e-lowerlimit-2e-linewidth}

```ts
"relative strength index.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.lowerlimit.visible {#relative-20-strength-20-index-2e-lowerlimit-2e-visible}

```ts
"relative strength index.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.lowerlimit.value {#relative-20-strength-20-index-2e-lowerlimit-2e-value}

```ts
"relative strength index.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.lowerlimit.zorder {#relative-20-strength-20-index-2e-lowerlimit-2e-zorder}

```ts
"relative strength index.lowerlimit.zorder": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.plot.display {#relative-20-strength-20-index-2e-plot-2e-display}

```ts
"relative strength index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.plot.linestyle {#relative-20-strength-20-index-2e-plot-2e-linestyle}

```ts
"relative strength index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.plot.linewidth {#relative-20-strength-20-index-2e-plot-2e-linewidth}

```ts
"relative strength index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.plot.plottype {#relative-20-strength-20-index-2e-plot-2e-plottype}

```ts
"relative strength index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.plot.trackprice {#relative-20-strength-20-index-2e-plot-2e-trackprice}

```ts
"relative strength index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.plot.transparency {#relative-20-strength-20-index-2e-plot-2e-transparency}

```ts
"relative strength index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.plot.color {#relative-20-strength-20-index-2e-plot-2e-color}

```ts
"relative strength index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothed ma.display {#relative-20-strength-20-index-2e-smoothed-20-ma-2e-display}

```ts
"relative strength index.smoothed ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothed ma.linestyle {#relative-20-strength-20-index-2e-smoothed-20-ma-2e-linestyle}

```ts
"relative strength index.smoothed ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothed ma.linewidth {#relative-20-strength-20-index-2e-smoothed-20-ma-2e-linewidth}

```ts
"relative strength index.smoothed ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothed ma.plottype {#relative-20-strength-20-index-2e-smoothed-20-ma-2e-plottype}

```ts
"relative strength index.smoothed ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothed ma.trackprice {#relative-20-strength-20-index-2e-smoothed-20-ma-2e-trackprice}

```ts
"relative strength index.smoothed ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothed ma.transparency {#relative-20-strength-20-index-2e-smoothed-20-ma-2e-transparency}

```ts
"relative strength index.smoothed ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.length {#relative-20-strength-20-index-2e-length}

```ts
"relative strength index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothing line {#relative-20-strength-20-index-2e-smoothing-20-line}

```ts
"relative strength index.smoothing line": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative strength index.smoothing length {#relative-20-strength-20-index-2e-smoothing-20-length}

```ts
"relative strength index.smoothing length": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.rvgi.display {#relative-20-vigor-20-index-2e-rvgi-2e-display}

```ts
"relative vigor index.rvgi.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.rvgi.linestyle {#relative-20-vigor-20-index-2e-rvgi-2e-linestyle}

```ts
"relative vigor index.rvgi.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.rvgi.linewidth {#relative-20-vigor-20-index-2e-rvgi-2e-linewidth}

```ts
"relative vigor index.rvgi.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.rvgi.plottype {#relative-20-vigor-20-index-2e-rvgi-2e-plottype}

```ts
"relative vigor index.rvgi.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.rvgi.trackprice {#relative-20-vigor-20-index-2e-rvgi-2e-trackprice}

```ts
"relative vigor index.rvgi.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.rvgi.transparency {#relative-20-vigor-20-index-2e-rvgi-2e-transparency}

```ts
"relative vigor index.rvgi.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.rvgi.color {#relative-20-vigor-20-index-2e-rvgi-2e-color}

```ts
"relative vigor index.rvgi.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.signal.display {#relative-20-vigor-20-index-2e-signal-2e-display}

```ts
"relative vigor index.signal.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.signal.linestyle {#relative-20-vigor-20-index-2e-signal-2e-linestyle}

```ts
"relative vigor index.signal.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.signal.linewidth {#relative-20-vigor-20-index-2e-signal-2e-linewidth}

```ts
"relative vigor index.signal.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.signal.plottype {#relative-20-vigor-20-index-2e-signal-2e-plottype}

```ts
"relative vigor index.signal.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.signal.trackprice {#relative-20-vigor-20-index-2e-signal-2e-trackprice}

```ts
"relative vigor index.signal.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.signal.transparency {#relative-20-vigor-20-index-2e-signal-2e-transparency}

```ts
"relative vigor index.signal.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.signal.color {#relative-20-vigor-20-index-2e-signal-2e-color}

```ts
"relative vigor index.signal.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative vigor index.length {#relative-20-vigor-20-index-2e-length}

```ts
"relative vigor index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.hlines background.color {#relative-20-volatility-20-index-2e-hlines-20-background-2e-color}

```ts
"relative volatility index.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.hlines background.transparency {#relative-20-volatility-20-index-2e-hlines-20-background-2e-transparency}

```ts
"relative volatility index.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.hlines background.visible {#relative-20-volatility-20-index-2e-hlines-20-background-2e-visible}

```ts
"relative volatility index.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.upperlimit.color {#relative-20-volatility-20-index-2e-upperlimit-2e-color}

```ts
"relative volatility index.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.upperlimit.linestyle {#relative-20-volatility-20-index-2e-upperlimit-2e-linestyle}

```ts
"relative volatility index.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.upperlimit.linewidth {#relative-20-volatility-20-index-2e-upperlimit-2e-linewidth}

```ts
"relative volatility index.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.upperlimit.visible {#relative-20-volatility-20-index-2e-upperlimit-2e-visible}

```ts
"relative volatility index.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.upperlimit.value {#relative-20-volatility-20-index-2e-upperlimit-2e-value}

```ts
"relative volatility index.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.lowerlimit.color {#relative-20-volatility-20-index-2e-lowerlimit-2e-color}

```ts
"relative volatility index.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.lowerlimit.linestyle {#relative-20-volatility-20-index-2e-lowerlimit-2e-linestyle}

```ts
"relative volatility index.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.lowerlimit.linewidth {#relative-20-volatility-20-index-2e-lowerlimit-2e-linewidth}

```ts
"relative volatility index.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.lowerlimit.visible {#relative-20-volatility-20-index-2e-lowerlimit-2e-visible}

```ts
"relative volatility index.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.lowerlimit.value {#relative-20-volatility-20-index-2e-lowerlimit-2e-value}

```ts
"relative volatility index.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.plot.display {#relative-20-volatility-20-index-2e-plot-2e-display}

```ts
"relative volatility index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.plot.linestyle {#relative-20-volatility-20-index-2e-plot-2e-linestyle}

```ts
"relative volatility index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.plot.linewidth {#relative-20-volatility-20-index-2e-plot-2e-linewidth}

```ts
"relative volatility index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.plot.plottype {#relative-20-volatility-20-index-2e-plot-2e-plottype}

```ts
"relative volatility index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.plot.trackprice {#relative-20-volatility-20-index-2e-plot-2e-trackprice}

```ts
"relative volatility index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.plot.transparency {#relative-20-volatility-20-index-2e-plot-2e-transparency}

```ts
"relative volatility index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.plot.color {#relative-20-volatility-20-index-2e-plot-2e-color}

```ts
"relative volatility index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## relative volatility index.length {#relative-20-volatility-20-index-2e-length}

```ts
"relative volatility index.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.indicator.display {#smi-20-ergodic-20-indicator-2f-oscillator-2e-indicator-2e-display}

```ts
"smi ergodic indicator/oscillator.indicator.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.indicator.linestyle {#smi-20-ergodic-20-indicator-2f-oscillator-2e-indicator-2e-linestyle}

```ts
"smi ergodic indicator/oscillator.indicator.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.indicator.linewidth {#smi-20-ergodic-20-indicator-2f-oscillator-2e-indicator-2e-linewidth}

```ts
"smi ergodic indicator/oscillator.indicator.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.indicator.plottype {#smi-20-ergodic-20-indicator-2f-oscillator-2e-indicator-2e-plottype}

```ts
"smi ergodic indicator/oscillator.indicator.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.indicator.trackprice {#smi-20-ergodic-20-indicator-2f-oscillator-2e-indicator-2e-trackprice}

```ts
"smi ergodic indicator/oscillator.indicator.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.indicator.transparency {#smi-20-ergodic-20-indicator-2f-oscillator-2e-indicator-2e-transparency}

```ts
"smi ergodic indicator/oscillator.indicator.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.indicator.color {#smi-20-ergodic-20-indicator-2f-oscillator-2e-indicator-2e-color}

```ts
"smi ergodic indicator/oscillator.indicator.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.signal.display {#smi-20-ergodic-20-indicator-2f-oscillator-2e-signal-2e-display}

```ts
"smi ergodic indicator/oscillator.signal.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.signal.linestyle {#smi-20-ergodic-20-indicator-2f-oscillator-2e-signal-2e-linestyle}

```ts
"smi ergodic indicator/oscillator.signal.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.signal.linewidth {#smi-20-ergodic-20-indicator-2f-oscillator-2e-signal-2e-linewidth}

```ts
"smi ergodic indicator/oscillator.signal.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.signal.plottype {#smi-20-ergodic-20-indicator-2f-oscillator-2e-signal-2e-plottype}

```ts
"smi ergodic indicator/oscillator.signal.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.signal.trackprice {#smi-20-ergodic-20-indicator-2f-oscillator-2e-signal-2e-trackprice}

```ts
"smi ergodic indicator/oscillator.signal.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.signal.transparency {#smi-20-ergodic-20-indicator-2f-oscillator-2e-signal-2e-transparency}

```ts
"smi ergodic indicator/oscillator.signal.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.signal.color {#smi-20-ergodic-20-indicator-2f-oscillator-2e-signal-2e-color}

```ts
"smi ergodic indicator/oscillator.signal.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.oscillator.display {#smi-20-ergodic-20-indicator-2f-oscillator-2e-oscillator-2e-display}

```ts
"smi ergodic indicator/oscillator.oscillator.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.oscillator.linestyle {#smi-20-ergodic-20-indicator-2f-oscillator-2e-oscillator-2e-linestyle}

```ts
"smi ergodic indicator/oscillator.oscillator.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.oscillator.linewidth {#smi-20-ergodic-20-indicator-2f-oscillator-2e-oscillator-2e-linewidth}

```ts
"smi ergodic indicator/oscillator.oscillator.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.oscillator.plottype {#smi-20-ergodic-20-indicator-2f-oscillator-2e-oscillator-2e-plottype}

```ts
"smi ergodic indicator/oscillator.oscillator.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.oscillator.trackprice {#smi-20-ergodic-20-indicator-2f-oscillator-2e-oscillator-2e-trackprice}

```ts
"smi ergodic indicator/oscillator.oscillator.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.oscillator.transparency {#smi-20-ergodic-20-indicator-2f-oscillator-2e-oscillator-2e-transparency}

```ts
"smi ergodic indicator/oscillator.oscillator.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.oscillator.color {#smi-20-ergodic-20-indicator-2f-oscillator-2e-oscillator-2e-color}

```ts
"smi ergodic indicator/oscillator.oscillator.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.shortlen {#smi-20-ergodic-20-indicator-2f-oscillator-2e-shortlen}

```ts
"smi ergodic indicator/oscillator.shortlen": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.longlen {#smi-20-ergodic-20-indicator-2f-oscillator-2e-longlen}

```ts
"smi ergodic indicator/oscillator.longlen": number;
```

Use the type signature above and the integration guide for the owning capability.

## smi ergodic indicator/oscillator.siglen {#smi-20-ergodic-20-indicator-2f-oscillator-2e-siglen}

```ts
"smi ergodic indicator/oscillator.siglen": number;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.plot.display {#smoothed-20-moving-20-average-2e-plot-2e-display}

```ts
"smoothed moving average.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.plot.linestyle {#smoothed-20-moving-20-average-2e-plot-2e-linestyle}

```ts
"smoothed moving average.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.plot.linewidth {#smoothed-20-moving-20-average-2e-plot-2e-linewidth}

```ts
"smoothed moving average.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.plot.plottype {#smoothed-20-moving-20-average-2e-plot-2e-plottype}

```ts
"smoothed moving average.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.plot.trackprice {#smoothed-20-moving-20-average-2e-plot-2e-trackprice}

```ts
"smoothed moving average.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.plot.transparency {#smoothed-20-moving-20-average-2e-plot-2e-transparency}

```ts
"smoothed moving average.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.plot.color {#smoothed-20-moving-20-average-2e-plot-2e-color}

```ts
"smoothed moving average.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.length {#smoothed-20-moving-20-average-2e-length}

```ts
"smoothed moving average.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## smoothed moving average.source {#smoothed-20-moving-20-average-2e-source}

```ts
"smoothed moving average.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## spread.negative fill.transparency {#spread-2e-negative-20-fill-2e-transparency}

```ts
"spread.negative fill.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.negative fill.visible {#spread-2e-negative-20-fill-2e-visible}

```ts
"spread.negative fill.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## spread.positive fill.transparency {#spread-2e-positive-20-fill-2e-transparency}

```ts
"spread.positive fill.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.positive fill.visible {#spread-2e-positive-20-fill-2e-visible}

```ts
"spread.positive fill.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## spread.plot.linestyle {#spread-2e-plot-2e-linestyle}

```ts
"spread.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.plot.linewidth {#spread-2e-plot-2e-linewidth}

```ts
"spread.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.plot.plottype {#spread-2e-plot-2e-plottype}

```ts
"spread.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## spread.plot.trackprice {#spread-2e-plot-2e-trackprice}

```ts
"spread.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## spread.plot.transparency {#spread-2e-plot-2e-transparency}

```ts
"spread.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.plot.color {#spread-2e-plot-2e-color}

```ts
"spread.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## spread.plot.display {#spread-2e-plot-2e-display}

```ts
"spread.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.baseline.linestyle {#spread-2e-baseline-2e-linestyle}

```ts
"spread.baseline.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.baseline.linewidth {#spread-2e-baseline-2e-linewidth}

```ts
"spread.baseline.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.baseline.plottype {#spread-2e-baseline-2e-plottype}

```ts
"spread.baseline.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## spread.baseline.trackprice {#spread-2e-baseline-2e-trackprice}

```ts
"spread.baseline.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## spread.baseline.transparency {#spread-2e-baseline-2e-transparency}

```ts
"spread.baseline.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.baseline.color {#spread-2e-baseline-2e-color}

```ts
"spread.baseline.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## spread.baseline.display {#spread-2e-baseline-2e-display}

```ts
"spread.baseline.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## spread.source {#spread-2e-source}

```ts
"spread.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## spread.symbol {#spread-2e-symbol}

```ts
"spread.symbol": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.plot.display {#standard-20-deviation-2e-plot-2e-display}

```ts
"standard deviation.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.plot.linestyle {#standard-20-deviation-2e-plot-2e-linestyle}

```ts
"standard deviation.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.plot.linewidth {#standard-20-deviation-2e-plot-2e-linewidth}

```ts
"standard deviation.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.plot.plottype {#standard-20-deviation-2e-plot-2e-plottype}

```ts
"standard deviation.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.plot.trackprice {#standard-20-deviation-2e-plot-2e-trackprice}

```ts
"standard deviation.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.plot.transparency {#standard-20-deviation-2e-plot-2e-transparency}

```ts
"standard deviation.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.plot.color {#standard-20-deviation-2e-plot-2e-color}

```ts
"standard deviation.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.periods {#standard-20-deviation-2e-periods}

```ts
"standard deviation.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard deviation.deviations {#standard-20-deviation-2e-deviations}

```ts
"standard deviation.deviations": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.plot.display {#standard-20-error-2e-plot-2e-display}

```ts
"standard error.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.plot.linestyle {#standard-20-error-2e-plot-2e-linestyle}

```ts
"standard error.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.plot.linewidth {#standard-20-error-2e-plot-2e-linewidth}

```ts
"standard error.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.plot.plottype {#standard-20-error-2e-plot-2e-plottype}

```ts
"standard error.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.plot.trackprice {#standard-20-error-2e-plot-2e-trackprice}

```ts
"standard error.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.plot.transparency {#standard-20-error-2e-plot-2e-transparency}

```ts
"standard error.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.plot.color {#standard-20-error-2e-plot-2e-color}

```ts
"standard error.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard error.length {#standard-20-error-2e-length}

```ts
"standard error.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.background.color {#standard-20-error-20-bands-2e-background-2e-color}

```ts
"standard error bands.background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.background.transparency {#standard-20-error-20-bands-2e-background-2e-transparency}

```ts
"standard error bands.background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.background.visible {#standard-20-error-20-bands-2e-background-2e-visible}

```ts
"standard error bands.background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 1.display {#standard-20-error-20-bands-2e-plot-20-1-2e-display}

```ts
"standard error bands.plot 1.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 1.linestyle {#standard-20-error-20-bands-2e-plot-20-1-2e-linestyle}

```ts
"standard error bands.plot 1.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 1.linewidth {#standard-20-error-20-bands-2e-plot-20-1-2e-linewidth}

```ts
"standard error bands.plot 1.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 1.plottype {#standard-20-error-20-bands-2e-plot-20-1-2e-plottype}

```ts
"standard error bands.plot 1.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 1.transparency {#standard-20-error-20-bands-2e-plot-20-1-2e-transparency}

```ts
"standard error bands.plot 1.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 1.trackprice {#standard-20-error-20-bands-2e-plot-20-1-2e-trackprice}

```ts
"standard error bands.plot 1.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 1.color {#standard-20-error-20-bands-2e-plot-20-1-2e-color}

```ts
"standard error bands.plot 1.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 2.display {#standard-20-error-20-bands-2e-plot-20-2-2e-display}

```ts
"standard error bands.plot 2.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 2.linestyle {#standard-20-error-20-bands-2e-plot-20-2-2e-linestyle}

```ts
"standard error bands.plot 2.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 2.linewidth {#standard-20-error-20-bands-2e-plot-20-2-2e-linewidth}

```ts
"standard error bands.plot 2.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 2.transparency {#standard-20-error-20-bands-2e-plot-20-2-2e-transparency}

```ts
"standard error bands.plot 2.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 2.plottype {#standard-20-error-20-bands-2e-plot-20-2-2e-plottype}

```ts
"standard error bands.plot 2.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 2.trackprice {#standard-20-error-20-bands-2e-plot-20-2-2e-trackprice}

```ts
"standard error bands.plot 2.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 2.color {#standard-20-error-20-bands-2e-plot-20-2-2e-color}

```ts
"standard error bands.plot 2.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 3.display {#standard-20-error-20-bands-2e-plot-20-3-2e-display}

```ts
"standard error bands.plot 3.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 3.linestyle {#standard-20-error-20-bands-2e-plot-20-3-2e-linestyle}

```ts
"standard error bands.plot 3.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 3.linewidth {#standard-20-error-20-bands-2e-plot-20-3-2e-linewidth}

```ts
"standard error bands.plot 3.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 3.transparency {#standard-20-error-20-bands-2e-plot-20-3-2e-transparency}

```ts
"standard error bands.plot 3.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 3.plottype {#standard-20-error-20-bands-2e-plot-20-3-2e-plottype}

```ts
"standard error bands.plot 3.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 3.trackprice {#standard-20-error-20-bands-2e-plot-20-3-2e-trackprice}

```ts
"standard error bands.plot 3.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.plot 3.color {#standard-20-error-20-bands-2e-plot-20-3-2e-color}

```ts
"standard error bands.plot 3.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.periods {#standard-20-error-20-bands-2e-periods}

```ts
"standard error bands.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.standard errors {#standard-20-error-20-bands-2e-standard-20-errors}

```ts
"standard error bands.standard errors": number;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.method {#standard-20-error-20-bands-2e-method}

```ts
"standard error bands.method": string;
```

Use the type signature above and the integration guide for the owning capability.

## standard error bands.averaging periods {#standard-20-error-20-bands-2e-averaging-20-periods}

```ts
"standard error bands.averaging periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.hlines background.color {#stochastic-2e-hlines-20-background-2e-color}

```ts
"stochastic.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.hlines background.transparency {#stochastic-2e-hlines-20-background-2e-transparency}

```ts
"stochastic.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.hlines background.visible {#stochastic-2e-hlines-20-background-2e-visible}

```ts
"stochastic.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.upperlimit.color {#stochastic-2e-upperlimit-2e-color}

```ts
"stochastic.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.upperlimit.linestyle {#stochastic-2e-upperlimit-2e-linestyle}

```ts
"stochastic.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.upperlimit.linewidth {#stochastic-2e-upperlimit-2e-linewidth}

```ts
"stochastic.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.upperlimit.visible {#stochastic-2e-upperlimit-2e-visible}

```ts
"stochastic.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.upperlimit.value {#stochastic-2e-upperlimit-2e-value}

```ts
"stochastic.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.lowerlimit.color {#stochastic-2e-lowerlimit-2e-color}

```ts
"stochastic.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.lowerlimit.linestyle {#stochastic-2e-lowerlimit-2e-linestyle}

```ts
"stochastic.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.lowerlimit.linewidth {#stochastic-2e-lowerlimit-2e-linewidth}

```ts
"stochastic.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.lowerlimit.visible {#stochastic-2e-lowerlimit-2e-visible}

```ts
"stochastic.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.lowerlimit.value {#stochastic-2e-lowerlimit-2e-value}

```ts
"stochastic.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k.display {#stochastic-2e--25-k-2e-display}

```ts
"stochastic.%k.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k.linestyle {#stochastic-2e--25-k-2e-linestyle}

```ts
"stochastic.%k.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k.linewidth {#stochastic-2e--25-k-2e-linewidth}

```ts
"stochastic.%k.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k.plottype {#stochastic-2e--25-k-2e-plottype}

```ts
"stochastic.%k.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k.trackprice {#stochastic-2e--25-k-2e-trackprice}

```ts
"stochastic.%k.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k.transparency {#stochastic-2e--25-k-2e-transparency}

```ts
"stochastic.%k.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k.color {#stochastic-2e--25-k-2e-color}

```ts
"stochastic.%k.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d.display {#stochastic-2e--25-d-2e-display}

```ts
"stochastic.%d.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d.linestyle {#stochastic-2e--25-d-2e-linestyle}

```ts
"stochastic.%d.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d.linewidth {#stochastic-2e--25-d-2e-linewidth}

```ts
"stochastic.%d.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d.plottype {#stochastic-2e--25-d-2e-plottype}

```ts
"stochastic.%d.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d.trackprice {#stochastic-2e--25-d-2e-trackprice}

```ts
"stochastic.%d.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d.transparency {#stochastic-2e--25-d-2e-transparency}

```ts
"stochastic.%d.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d.color {#stochastic-2e--25-d-2e-color}

```ts
"stochastic.%d.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k length {#stochastic-2e--25-k-20-length}

```ts
"stochastic.%k length": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%k smoothing {#stochastic-2e--25-k-20-smoothing}

```ts
"stochastic.%k smoothing": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic.%d smoothing {#stochastic-2e--25-d-20-smoothing}

```ts
"stochastic.%d smoothing": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.hlines background.color {#stochastic-20-rsi-2e-hlines-20-background-2e-color}

```ts
"stochastic rsi.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.hlines background.transparency {#stochastic-20-rsi-2e-hlines-20-background-2e-transparency}

```ts
"stochastic rsi.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.hlines background.visible {#stochastic-20-rsi-2e-hlines-20-background-2e-visible}

```ts
"stochastic rsi.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.upperlimit.color {#stochastic-20-rsi-2e-upperlimit-2e-color}

```ts
"stochastic rsi.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.upperlimit.linestyle {#stochastic-20-rsi-2e-upperlimit-2e-linestyle}

```ts
"stochastic rsi.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.upperlimit.linewidth {#stochastic-20-rsi-2e-upperlimit-2e-linewidth}

```ts
"stochastic rsi.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.upperlimit.visible {#stochastic-20-rsi-2e-upperlimit-2e-visible}

```ts
"stochastic rsi.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.upperlimit.value {#stochastic-20-rsi-2e-upperlimit-2e-value}

```ts
"stochastic rsi.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.lowerlimit.color {#stochastic-20-rsi-2e-lowerlimit-2e-color}

```ts
"stochastic rsi.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.lowerlimit.linestyle {#stochastic-20-rsi-2e-lowerlimit-2e-linestyle}

```ts
"stochastic rsi.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.lowerlimit.linewidth {#stochastic-20-rsi-2e-lowerlimit-2e-linewidth}

```ts
"stochastic rsi.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.lowerlimit.visible {#stochastic-20-rsi-2e-lowerlimit-2e-visible}

```ts
"stochastic rsi.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.lowerlimit.value {#stochastic-20-rsi-2e-lowerlimit-2e-value}

```ts
"stochastic rsi.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%k.display {#stochastic-20-rsi-2e--25-k-2e-display}

```ts
"stochastic rsi.%k.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%k.linestyle {#stochastic-20-rsi-2e--25-k-2e-linestyle}

```ts
"stochastic rsi.%k.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%k.linewidth {#stochastic-20-rsi-2e--25-k-2e-linewidth}

```ts
"stochastic rsi.%k.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%k.plottype {#stochastic-20-rsi-2e--25-k-2e-plottype}

```ts
"stochastic rsi.%k.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%k.trackprice {#stochastic-20-rsi-2e--25-k-2e-trackprice}

```ts
"stochastic rsi.%k.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%k.transparency {#stochastic-20-rsi-2e--25-k-2e-transparency}

```ts
"stochastic rsi.%k.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%k.color {#stochastic-20-rsi-2e--25-k-2e-color}

```ts
"stochastic rsi.%k.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%d.display {#stochastic-20-rsi-2e--25-d-2e-display}

```ts
"stochastic rsi.%d.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%d.linestyle {#stochastic-20-rsi-2e--25-d-2e-linestyle}

```ts
"stochastic rsi.%d.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%d.linewidth {#stochastic-20-rsi-2e--25-d-2e-linewidth}

```ts
"stochastic rsi.%d.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%d.plottype {#stochastic-20-rsi-2e--25-d-2e-plottype}

```ts
"stochastic rsi.%d.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%d.trackprice {#stochastic-20-rsi-2e--25-d-2e-trackprice}

```ts
"stochastic rsi.%d.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%d.transparency {#stochastic-20-rsi-2e--25-d-2e-transparency}

```ts
"stochastic rsi.%d.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.%d.color {#stochastic-20-rsi-2e--25-d-2e-color}

```ts
"stochastic rsi.%d.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.lengthrsi {#stochastic-20-rsi-2e-lengthrsi}

```ts
"stochastic rsi.lengthrsi": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.lengthstoch {#stochastic-20-rsi-2e-lengthstoch}

```ts
"stochastic rsi.lengthstoch": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.smoothk {#stochastic-20-rsi-2e-smoothk}

```ts
"stochastic rsi.smoothk": number;
```

Use the type signature above and the integration guide for the owning capability.

## stochastic rsi.smoothd {#stochastic-20-rsi-2e-smoothd}

```ts
"stochastic rsi.smoothd": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.supertrend.display {#supertrend-2e-supertrend-2e-display}

```ts
"supertrend.supertrend.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.supertrend.linestyle {#supertrend-2e-supertrend-2e-linestyle}

```ts
"supertrend.supertrend.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.supertrend.linewidth {#supertrend-2e-supertrend-2e-linewidth}

```ts
"supertrend.supertrend.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.supertrend.plottype {#supertrend-2e-supertrend-2e-plottype}

```ts
"supertrend.supertrend.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.supertrend.trackprice {#supertrend-2e-supertrend-2e-trackprice}

```ts
"supertrend.supertrend.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.supertrend.transparency {#supertrend-2e-supertrend-2e-transparency}

```ts
"supertrend.supertrend.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.supertrend.color {#supertrend-2e-supertrend-2e-color}

```ts
"supertrend.supertrend.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.display {#supertrend-2e-up-20-arrow-2e-display}

```ts
"supertrend.up arrow.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.linestyle {#supertrend-2e-up-20-arrow-2e-linestyle}

```ts
"supertrend.up arrow.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.linewidth {#supertrend-2e-up-20-arrow-2e-linewidth}

```ts
"supertrend.up arrow.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.plottype {#supertrend-2e-up-20-arrow-2e-plottype}

```ts
"supertrend.up arrow.plottype": string;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.trackprice {#supertrend-2e-up-20-arrow-2e-trackprice}

```ts
"supertrend.up arrow.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.location {#supertrend-2e-up-20-arrow-2e-location}

```ts
"supertrend.up arrow.location": string;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.transparency {#supertrend-2e-up-20-arrow-2e-transparency}

```ts
"supertrend.up arrow.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.up arrow.color {#supertrend-2e-up-20-arrow-2e-color}

```ts
"supertrend.up arrow.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.display {#supertrend-2e-down-20-arrow-2e-display}

```ts
"supertrend.down arrow.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.linestyle {#supertrend-2e-down-20-arrow-2e-linestyle}

```ts
"supertrend.down arrow.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.linewidth {#supertrend-2e-down-20-arrow-2e-linewidth}

```ts
"supertrend.down arrow.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.plottype {#supertrend-2e-down-20-arrow-2e-plottype}

```ts
"supertrend.down arrow.plottype": string;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.trackprice {#supertrend-2e-down-20-arrow-2e-trackprice}

```ts
"supertrend.down arrow.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.location {#supertrend-2e-down-20-arrow-2e-location}

```ts
"supertrend.down arrow.location": string;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.transparency {#supertrend-2e-down-20-arrow-2e-transparency}

```ts
"supertrend.down arrow.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.down arrow.color {#supertrend-2e-down-20-arrow-2e-color}

```ts
"supertrend.down arrow.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.length {#supertrend-2e-length}

```ts
"supertrend.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## supertrend.factor {#supertrend-2e-factor}

```ts
"supertrend.factor": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.zero.color {#trix-2e-zero-2e-color}

```ts
"trix.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## trix.zero.linestyle {#trix-2e-zero-2e-linestyle}

```ts
"trix.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.zero.linewidth {#trix-2e-zero-2e-linewidth}

```ts
"trix.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.zero.visible {#trix-2e-zero-2e-visible}

```ts
"trix.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## trix.zero.value {#trix-2e-zero-2e-value}

```ts
"trix.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.trix.display {#trix-2e-trix-2e-display}

```ts
"trix.trix.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.trix.linestyle {#trix-2e-trix-2e-linestyle}

```ts
"trix.trix.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.trix.linewidth {#trix-2e-trix-2e-linewidth}

```ts
"trix.trix.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.trix.plottype {#trix-2e-trix-2e-plottype}

```ts
"trix.trix.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## trix.trix.trackprice {#trix-2e-trix-2e-trackprice}

```ts
"trix.trix.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## trix.trix.transparency {#trix-2e-trix-2e-transparency}

```ts
"trix.trix.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## trix.trix.color {#trix-2e-trix-2e-color}

```ts
"trix.trix.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## trix.length {#trix-2e-length}

```ts
"trix.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.plot.display {#trend-20-strength-20-index-2e-plot-2e-display}

```ts
"trend strength index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.plot.linestyle {#trend-20-strength-20-index-2e-plot-2e-linestyle}

```ts
"trend strength index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.plot.linewidth {#trend-20-strength-20-index-2e-plot-2e-linewidth}

```ts
"trend strength index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.plot.plottype {#trend-20-strength-20-index-2e-plot-2e-plottype}

```ts
"trend strength index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.plot.trackprice {#trend-20-strength-20-index-2e-plot-2e-trackprice}

```ts
"trend strength index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.plot.transparency {#trend-20-strength-20-index-2e-plot-2e-transparency}

```ts
"trend strength index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.plot.color {#trend-20-strength-20-index-2e-plot-2e-color}

```ts
"trend strength index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## trend strength index.periods {#trend-20-strength-20-index-2e-periods}

```ts
"trend strength index.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.plot.display {#triple-20-ema-2e-plot-2e-display}

```ts
"triple ema.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.plot.linestyle {#triple-20-ema-2e-plot-2e-linestyle}

```ts
"triple ema.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.plot.linewidth {#triple-20-ema-2e-plot-2e-linewidth}

```ts
"triple ema.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.plot.plottype {#triple-20-ema-2e-plot-2e-plottype}

```ts
"triple ema.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.plot.trackprice {#triple-20-ema-2e-plot-2e-trackprice}

```ts
"triple ema.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.plot.transparency {#triple-20-ema-2e-plot-2e-transparency}

```ts
"triple ema.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.plot.color {#triple-20-ema-2e-plot-2e-color}

```ts
"triple ema.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## triple ema.length {#triple-20-ema-2e-length}

```ts
"triple ema.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.zero.color {#true-20-strength-20-index-2e-zero-2e-color}

```ts
"true strength index.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.zero.linestyle {#true-20-strength-20-index-2e-zero-2e-linestyle}

```ts
"true strength index.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.zero.linewidth {#true-20-strength-20-index-2e-zero-2e-linewidth}

```ts
"true strength index.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.zero.visible {#true-20-strength-20-index-2e-zero-2e-visible}

```ts
"true strength index.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.zero.value {#true-20-strength-20-index-2e-zero-2e-value}

```ts
"true strength index.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.true strength index.display {#true-20-strength-20-index-2e-true-20-strength-20-index-2e-display}

```ts
"true strength index.true strength index.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.true strength index.linestyle {#true-20-strength-20-index-2e-true-20-strength-20-index-2e-linestyle}

```ts
"true strength index.true strength index.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.true strength index.linewidth {#true-20-strength-20-index-2e-true-20-strength-20-index-2e-linewidth}

```ts
"true strength index.true strength index.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.true strength index.plottype {#true-20-strength-20-index-2e-true-20-strength-20-index-2e-plottype}

```ts
"true strength index.true strength index.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.true strength index.trackprice {#true-20-strength-20-index-2e-true-20-strength-20-index-2e-trackprice}

```ts
"true strength index.true strength index.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.true strength index.transparency {#true-20-strength-20-index-2e-true-20-strength-20-index-2e-transparency}

```ts
"true strength index.true strength index.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.true strength index.color {#true-20-strength-20-index-2e-true-20-strength-20-index-2e-color}

```ts
"true strength index.true strength index.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.signal.display {#true-20-strength-20-index-2e-signal-2e-display}

```ts
"true strength index.signal.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.signal.linestyle {#true-20-strength-20-index-2e-signal-2e-linestyle}

```ts
"true strength index.signal.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.signal.linewidth {#true-20-strength-20-index-2e-signal-2e-linewidth}

```ts
"true strength index.signal.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.signal.plottype {#true-20-strength-20-index-2e-signal-2e-plottype}

```ts
"true strength index.signal.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.signal.trackprice {#true-20-strength-20-index-2e-signal-2e-trackprice}

```ts
"true strength index.signal.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.signal.transparency {#true-20-strength-20-index-2e-signal-2e-transparency}

```ts
"true strength index.signal.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.signal.color {#true-20-strength-20-index-2e-signal-2e-color}

```ts
"true strength index.signal.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.long {#true-20-strength-20-index-2e-long}

```ts
"true strength index.long": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.short {#true-20-strength-20-index-2e-short}

```ts
"true strength index.short": number;
```

Use the type signature above and the integration guide for the owning capability.

## true strength index.siglen {#true-20-strength-20-index-2e-siglen}

```ts
"true strength index.siglen": number;
```

Use the type signature above and the integration guide for the owning capability.

## typical price.plot.display {#typical-20-price-2e-plot-2e-display}

```ts
"typical price.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## typical price.plot.linestyle {#typical-20-price-2e-plot-2e-linestyle}

```ts
"typical price.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## typical price.plot.linewidth {#typical-20-price-2e-plot-2e-linewidth}

```ts
"typical price.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## typical price.plot.plottype {#typical-20-price-2e-plot-2e-plottype}

```ts
"typical price.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## typical price.plot.trackprice {#typical-20-price-2e-plot-2e-trackprice}

```ts
"typical price.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## typical price.plot.transparency {#typical-20-price-2e-plot-2e-transparency}

```ts
"typical price.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## typical price.plot.color {#typical-20-price-2e-plot-2e-color}

```ts
"typical price.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.uo.display {#ultimate-20-oscillator-2e-uo-2e-display}

```ts
"ultimate oscillator.uo.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.uo.linestyle {#ultimate-20-oscillator-2e-uo-2e-linestyle}

```ts
"ultimate oscillator.uo.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.uo.linewidth {#ultimate-20-oscillator-2e-uo-2e-linewidth}

```ts
"ultimate oscillator.uo.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.uo.plottype {#ultimate-20-oscillator-2e-uo-2e-plottype}

```ts
"ultimate oscillator.uo.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.uo.trackprice {#ultimate-20-oscillator-2e-uo-2e-trackprice}

```ts
"ultimate oscillator.uo.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.uo.transparency {#ultimate-20-oscillator-2e-uo-2e-transparency}

```ts
"ultimate oscillator.uo.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.uo.color {#ultimate-20-oscillator-2e-uo-2e-color}

```ts
"ultimate oscillator.uo.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.length7 {#ultimate-20-oscillator-2e-length7}

```ts
"ultimate oscillator.length7": number;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.length14 {#ultimate-20-oscillator-2e-length14}

```ts
"ultimate oscillator.length14": number;
```

Use the type signature above and the integration guide for the owning capability.

## ultimate oscillator.length28 {#ultimate-20-oscillator-2e-length28}

```ts
"ultimate oscillator.length28": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.vwap.display {#vwap-2e-vwap-2e-display}

```ts
"vwap.vwap.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.vwap.linestyle {#vwap-2e-vwap-2e-linestyle}

```ts
"vwap.vwap.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.vwap.linewidth {#vwap-2e-vwap-2e-linewidth}

```ts
"vwap.vwap.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.vwap.plottype {#vwap-2e-vwap-2e-plottype}

```ts
"vwap.vwap.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.vwap.trackprice {#vwap-2e-vwap-2e-trackprice}

```ts
"vwap.vwap.trackprice": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.vwap.transparency {#vwap-2e-vwap-2e-transparency}

```ts
"vwap.vwap.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.vwap.color {#vwap-2e-vwap-2e-color}

```ts
"vwap.vwap.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.source {#vwap-2e-source}

```ts
"vwap.source": string;
```

Use the type signature above and the integration guide for the owning capability.

## vwap.anchor period {#vwap-2e-anchor-20-period}

```ts
"vwap.anchor period": string;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.plot.display {#vwma-2e-plot-2e-display}

```ts
"vwma.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.plot.linestyle {#vwma-2e-plot-2e-linestyle}

```ts
"vwma.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.plot.linewidth {#vwma-2e-plot-2e-linewidth}

```ts
"vwma.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.plot.plottype {#vwma-2e-plot-2e-plottype}

```ts
"vwma.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.plot.trackprice {#vwma-2e-plot-2e-trackprice}

```ts
"vwma.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.plot.transparency {#vwma-2e-plot-2e-transparency}

```ts
"vwma.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.plot.color {#vwma-2e-plot-2e-color}

```ts
"vwma.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## vwma.len {#vwma-2e-len}

```ts
"vwma.len": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.plot.display {#volatility-20-close-to-close-2e-plot-2e-display}

```ts
"volatility close-to-close.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.plot.linestyle {#volatility-20-close-to-close-2e-plot-2e-linestyle}

```ts
"volatility close-to-close.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.plot.linewidth {#volatility-20-close-to-close-2e-plot-2e-linewidth}

```ts
"volatility close-to-close.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.plot.plottype {#volatility-20-close-to-close-2e-plot-2e-plottype}

```ts
"volatility close-to-close.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.plot.trackprice {#volatility-20-close-to-close-2e-plot-2e-trackprice}

```ts
"volatility close-to-close.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.plot.transparency {#volatility-20-close-to-close-2e-plot-2e-transparency}

```ts
"volatility close-to-close.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.plot.color {#volatility-20-close-to-close-2e-plot-2e-color}

```ts
"volatility close-to-close.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.periods {#volatility-20-close-to-close-2e-periods}

```ts
"volatility close-to-close.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility close-to-close.days per year {#volatility-20-close-to-close-2e-days-20-per-20-year}

```ts
"volatility close-to-close.days per year": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.plot.display {#volatility-20-index-2e-plot-2e-display}

```ts
"volatility index.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.plot.linestyle {#volatility-20-index-2e-plot-2e-linestyle}

```ts
"volatility index.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.plot.linewidth {#volatility-20-index-2e-plot-2e-linewidth}

```ts
"volatility index.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.plot.plottype {#volatility-20-index-2e-plot-2e-plottype}

```ts
"volatility index.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.plot.trackprice {#volatility-20-index-2e-plot-2e-trackprice}

```ts
"volatility index.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.plot.transparency {#volatility-20-index-2e-plot-2e-transparency}

```ts
"volatility index.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.plot.color {#volatility-20-index-2e-plot-2e-color}

```ts
"volatility index.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.periods {#volatility-20-index-2e-periods}

```ts
"volatility index.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.atr mult {#volatility-20-index-2e-atr-20-mult}

```ts
"volatility index.atr mult": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility index.method {#volatility-20-index-2e-method}

```ts
"volatility index.method": string;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.plot.display {#volatility-20-o-h-l-c-2e-plot-2e-display}

```ts
"volatility o-h-l-c.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.plot.linestyle {#volatility-20-o-h-l-c-2e-plot-2e-linestyle}

```ts
"volatility o-h-l-c.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.plot.linewidth {#volatility-20-o-h-l-c-2e-plot-2e-linewidth}

```ts
"volatility o-h-l-c.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.plot.plottype {#volatility-20-o-h-l-c-2e-plot-2e-plottype}

```ts
"volatility o-h-l-c.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.plot.trackprice {#volatility-20-o-h-l-c-2e-plot-2e-trackprice}

```ts
"volatility o-h-l-c.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.plot.transparency {#volatility-20-o-h-l-c-2e-plot-2e-transparency}

```ts
"volatility o-h-l-c.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.plot.color {#volatility-20-o-h-l-c-2e-plot-2e-color}

```ts
"volatility o-h-l-c.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.periods {#volatility-20-o-h-l-c-2e-periods}

```ts
"volatility o-h-l-c.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.market closed percentage {#volatility-20-o-h-l-c-2e-market-20-closed-20-percentage}

```ts
"volatility o-h-l-c.market closed percentage": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility o-h-l-c.days per year {#volatility-20-o-h-l-c-2e-days-20-per-20-year}

```ts
"volatility o-h-l-c.days per year": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.plot.display {#volatility-20-zero-20-trend-20-close-to-close-2e-plot-2e-display}

```ts
"volatility zero trend close-to-close.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.plot.linestyle {#volatility-20-zero-20-trend-20-close-to-close-2e-plot-2e-linestyle}

```ts
"volatility zero trend close-to-close.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.plot.linewidth {#volatility-20-zero-20-trend-20-close-to-close-2e-plot-2e-linewidth}

```ts
"volatility zero trend close-to-close.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.plot.plottype {#volatility-20-zero-20-trend-20-close-to-close-2e-plot-2e-plottype}

```ts
"volatility zero trend close-to-close.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.plot.trackprice {#volatility-20-zero-20-trend-20-close-to-close-2e-plot-2e-trackprice}

```ts
"volatility zero trend close-to-close.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.plot.transparency {#volatility-20-zero-20-trend-20-close-to-close-2e-plot-2e-transparency}

```ts
"volatility zero trend close-to-close.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.plot.color {#volatility-20-zero-20-trend-20-close-to-close-2e-plot-2e-color}

```ts
"volatility zero trend close-to-close.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.periods {#volatility-20-zero-20-trend-20-close-to-close-2e-periods}

```ts
"volatility zero trend close-to-close.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## volatility zero trend close-to-close.days per year {#volatility-20-zero-20-trend-20-close-to-close-2e-days-20-per-20-year}

```ts
"volatility zero trend close-to-close.days per year": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume.display {#volume-2e-volume-2e-display}

```ts
"volume.volume.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume.linestyle {#volume-2e-volume-2e-linestyle}

```ts
"volume.volume.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume.linewidth {#volume-2e-volume-2e-linewidth}

```ts
"volume.volume.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume.plottype {#volume-2e-volume-2e-plottype}

```ts
"volume.volume.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume.trackprice {#volume-2e-volume-2e-trackprice}

```ts
"volume.volume.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume.transparency {#volume-2e-volume-2e-transparency}

```ts
"volume.volume.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume.color {#volume-2e-volume-2e-color}

```ts
"volume.volume.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume ma.display {#volume-2e-volume-20-ma-2e-display}

```ts
"volume.volume ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume ma.linestyle {#volume-2e-volume-20-ma-2e-linestyle}

```ts
"volume.volume ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume ma.linewidth {#volume-2e-volume-20-ma-2e-linewidth}

```ts
"volume.volume ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume ma.plottype {#volume-2e-volume-20-ma-2e-plottype}

```ts
"volume.volume ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume ma.trackprice {#volume-2e-volume-20-ma-2e-trackprice}

```ts
"volume.volume ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume ma.transparency {#volume-2e-volume-20-ma-2e-transparency}

```ts
"volume.volume ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.volume ma.color {#volume-2e-volume-20-ma-2e-color}

```ts
"volume.volume ma.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothed ma.display {#volume-2e-smoothed-20-ma-2e-display}

```ts
"volume.smoothed ma.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothed ma.linestyle {#volume-2e-smoothed-20-ma-2e-linestyle}

```ts
"volume.smoothed ma.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothed ma.linewidth {#volume-2e-smoothed-20-ma-2e-linewidth}

```ts
"volume.smoothed ma.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothed ma.plottype {#volume-2e-smoothed-20-ma-2e-plottype}

```ts
"volume.smoothed ma.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothed ma.trackprice {#volume-2e-smoothed-20-ma-2e-trackprice}

```ts
"volume.smoothed ma.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothed ma.transparency {#volume-2e-smoothed-20-ma-2e-transparency}

```ts
"volume.smoothed ma.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothed ma.color {#volume-2e-smoothed-20-ma-2e-color}

```ts
"volume.smoothed ma.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume.show ma {#volume-2e-show-20-ma}

```ts
"volume.show ma": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume.ma length {#volume-2e-ma-20-length}

```ts
"volume.ma length": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume.color based on previous close {#volume-2e-color-20-based-20-on-20-previous-20-close}

```ts
"volume.color based on previous close": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume.other symbol {#volume-2e-other-20-symbol}

```ts
"volume.other symbol": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothing line {#volume-2e-smoothing-20-line}

```ts
"volume.smoothing line": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume.smoothing length {#volume-2e-smoothing-20-length}

```ts
"volume.smoothing length": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.zero.color {#volume-20-oscillator-2e-zero-2e-color}

```ts
"volume oscillator.zero.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.zero.linestyle {#volume-20-oscillator-2e-zero-2e-linestyle}

```ts
"volume oscillator.zero.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.zero.linewidth {#volume-20-oscillator-2e-zero-2e-linewidth}

```ts
"volume oscillator.zero.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.zero.visible {#volume-20-oscillator-2e-zero-2e-visible}

```ts
"volume oscillator.zero.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.zero.value {#volume-20-oscillator-2e-zero-2e-value}

```ts
"volume oscillator.zero.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.plot.display {#volume-20-oscillator-2e-plot-2e-display}

```ts
"volume oscillator.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.plot.linestyle {#volume-20-oscillator-2e-plot-2e-linestyle}

```ts
"volume oscillator.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.plot.linewidth {#volume-20-oscillator-2e-plot-2e-linewidth}

```ts
"volume oscillator.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.plot.plottype {#volume-20-oscillator-2e-plot-2e-plottype}

```ts
"volume oscillator.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.plot.trackprice {#volume-20-oscillator-2e-plot-2e-trackprice}

```ts
"volume oscillator.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.plot.transparency {#volume-20-oscillator-2e-plot-2e-transparency}

```ts
"volume oscillator.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.plot.color {#volume-20-oscillator-2e-plot-2e-color}

```ts
"volume oscillator.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.shortlen {#volume-20-oscillator-2e-shortlen}

```ts
"volume oscillator.shortlen": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume oscillator.longlen {#volume-20-oscillator-2e-longlen}

```ts
"volume oscillator.longlen": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing poc.color {#volume-20-profile-20-fixed-20-range-2e-developing-20-poc-2e-color}

```ts
"volume profile fixed range.developing poc.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing poc.linestyle {#volume-20-profile-20-fixed-20-range-2e-developing-20-poc-2e-linestyle}

```ts
"volume profile fixed range.developing poc.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing poc.linewidth {#volume-20-profile-20-fixed-20-range-2e-developing-20-poc-2e-linewidth}

```ts
"volume profile fixed range.developing poc.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing poc.plottype {#volume-20-profile-20-fixed-20-range-2e-developing-20-poc-2e-plottype}

```ts
"volume profile fixed range.developing poc.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing poc.trackprice {#volume-20-profile-20-fixed-20-range-2e-developing-20-poc-2e-trackprice}

```ts
"volume profile fixed range.developing poc.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing poc.transparency {#volume-20-profile-20-fixed-20-range-2e-developing-20-poc-2e-transparency}

```ts
"volume profile fixed range.developing poc.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing poc.display {#volume-20-profile-20-fixed-20-range-2e-developing-20-poc-2e-display}

```ts
"volume profile fixed range.developing poc.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va high.color {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-high-2e-color}

```ts
"volume profile fixed range.developing va high.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va high.linestyle {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-high-2e-linestyle}

```ts
"volume profile fixed range.developing va high.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va high.linewidth {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-high-2e-linewidth}

```ts
"volume profile fixed range.developing va high.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va high.plottype {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-high-2e-plottype}

```ts
"volume profile fixed range.developing va high.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va high.trackprice {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-high-2e-trackprice}

```ts
"volume profile fixed range.developing va high.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va high.transparency {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-high-2e-transparency}

```ts
"volume profile fixed range.developing va high.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va high.display {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-high-2e-display}

```ts
"volume profile fixed range.developing va high.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va low.color {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-low-2e-color}

```ts
"volume profile fixed range.developing va low.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va low.linestyle {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-low-2e-linestyle}

```ts
"volume profile fixed range.developing va low.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va low.linewidth {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-low-2e-linewidth}

```ts
"volume profile fixed range.developing va low.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va low.plottype {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-low-2e-plottype}

```ts
"volume profile fixed range.developing va low.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va low.trackprice {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-low-2e-trackprice}

```ts
"volume profile fixed range.developing va low.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va low.transparency {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-low-2e-transparency}

```ts
"volume profile fixed range.developing va low.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.developing va low.display {#volume-20-profile-20-fixed-20-range-2e-developing-20-va-20-low-2e-display}

```ts
"volume profile fixed range.developing va low.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.first bar time {#volume-20-profile-20-fixed-20-range-2e-first-20-bar-20-time}

```ts
"volume profile fixed range.first bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.last bar time {#volume-20-profile-20-fixed-20-range-2e-last-20-bar-20-time}

```ts
"volume profile fixed range.last bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.row size {#volume-20-profile-20-fixed-20-range-2e-row-20-size}

```ts
"volume profile fixed range.row size": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.rows layout {#volume-20-profile-20-fixed-20-range-2e-rows-20-layout}

```ts
"volume profile fixed range.rows layout": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.subscriberealtime {#volume-20-profile-20-fixed-20-range-2e-subscriberealtime}

```ts
"volume profile fixed range.subscriberealtime": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.value area volume {#volume-20-profile-20-fixed-20-range-2e-value-20-area-20-volume}

```ts
"volume profile fixed range.value area volume": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile fixed range.volume {#volume-20-profile-20-fixed-20-range-2e-volume}

```ts
"volume profile fixed range.volume": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing poc.color {#volume-20-profile-20-visible-20-range-2e-developing-20-poc-2e-color}

```ts
"volume profile visible range.developing poc.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing poc.linestyle {#volume-20-profile-20-visible-20-range-2e-developing-20-poc-2e-linestyle}

```ts
"volume profile visible range.developing poc.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing poc.linewidth {#volume-20-profile-20-visible-20-range-2e-developing-20-poc-2e-linewidth}

```ts
"volume profile visible range.developing poc.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing poc.plottype {#volume-20-profile-20-visible-20-range-2e-developing-20-poc-2e-plottype}

```ts
"volume profile visible range.developing poc.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing poc.trackprice {#volume-20-profile-20-visible-20-range-2e-developing-20-poc-2e-trackprice}

```ts
"volume profile visible range.developing poc.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing poc.transparency {#volume-20-profile-20-visible-20-range-2e-developing-20-poc-2e-transparency}

```ts
"volume profile visible range.developing poc.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing poc.display {#volume-20-profile-20-visible-20-range-2e-developing-20-poc-2e-display}

```ts
"volume profile visible range.developing poc.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va high.color {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-high-2e-color}

```ts
"volume profile visible range.developing va high.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va high.linestyle {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-high-2e-linestyle}

```ts
"volume profile visible range.developing va high.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va high.linewidth {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-high-2e-linewidth}

```ts
"volume profile visible range.developing va high.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va high.plottype {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-high-2e-plottype}

```ts
"volume profile visible range.developing va high.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va high.trackprice {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-high-2e-trackprice}

```ts
"volume profile visible range.developing va high.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va high.transparency {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-high-2e-transparency}

```ts
"volume profile visible range.developing va high.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va high.display {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-high-2e-display}

```ts
"volume profile visible range.developing va high.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va low.color {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-low-2e-color}

```ts
"volume profile visible range.developing va low.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va low.linestyle {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-low-2e-linestyle}

```ts
"volume profile visible range.developing va low.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va low.linewidth {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-low-2e-linewidth}

```ts
"volume profile visible range.developing va low.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va low.plottype {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-low-2e-plottype}

```ts
"volume profile visible range.developing va low.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va low.trackprice {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-low-2e-trackprice}

```ts
"volume profile visible range.developing va low.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va low.transparency {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-low-2e-transparency}

```ts
"volume profile visible range.developing va low.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.developing va low.display {#volume-20-profile-20-visible-20-range-2e-developing-20-va-20-low-2e-display}

```ts
"volume profile visible range.developing va low.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.first visible bar time {#volume-20-profile-20-visible-20-range-2e-first-20-visible-20-bar-20-time}

```ts
"volume profile visible range.first visible bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.last visible bar time {#volume-20-profile-20-visible-20-range-2e-last-20-visible-20-bar-20-time}

```ts
"volume profile visible range.last visible bar time": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.row size {#volume-20-profile-20-visible-20-range-2e-row-20-size}

```ts
"volume profile visible range.row size": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.rows layout {#volume-20-profile-20-visible-20-range-2e-rows-20-layout}

```ts
"volume profile visible range.rows layout": string;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.value area volume {#volume-20-profile-20-visible-20-range-2e-value-20-area-20-volume}

```ts
"volume profile visible range.value area volume": number;
```

Use the type signature above and the integration guide for the owning capability.

## volume profile visible range.volume {#volume-20-profile-20-visible-20-range-2e-volume}

```ts
"volume profile visible range.volume": string;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi +.display {#vortex-20-indicator-2e-vi-20--2b--2e-display}

```ts
"vortex indicator.vi +.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi +.linestyle {#vortex-20-indicator-2e-vi-20--2b--2e-linestyle}

```ts
"vortex indicator.vi +.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi +.linewidth {#vortex-20-indicator-2e-vi-20--2b--2e-linewidth}

```ts
"vortex indicator.vi +.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi +.plottype {#vortex-20-indicator-2e-vi-20--2b--2e-plottype}

```ts
"vortex indicator.vi +.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi +.trackprice {#vortex-20-indicator-2e-vi-20--2b--2e-trackprice}

```ts
"vortex indicator.vi +.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi +.transparency {#vortex-20-indicator-2e-vi-20--2b--2e-transparency}

```ts
"vortex indicator.vi +.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi +.color {#vortex-20-indicator-2e-vi-20--2b--2e-color}

```ts
"vortex indicator.vi +.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi -.display {#vortex-20-indicator-2e-vi-20---2e-display}

```ts
"vortex indicator.vi -.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi -.linestyle {#vortex-20-indicator-2e-vi-20---2e-linestyle}

```ts
"vortex indicator.vi -.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi -.linewidth {#vortex-20-indicator-2e-vi-20---2e-linewidth}

```ts
"vortex indicator.vi -.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi -.plottype {#vortex-20-indicator-2e-vi-20---2e-plottype}

```ts
"vortex indicator.vi -.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi -.trackprice {#vortex-20-indicator-2e-vi-20---2e-trackprice}

```ts
"vortex indicator.vi -.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi -.transparency {#vortex-20-indicator-2e-vi-20---2e-transparency}

```ts
"vortex indicator.vi -.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.vi -.color {#vortex-20-indicator-2e-vi-20---2e-color}

```ts
"vortex indicator.vi -.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## vortex indicator.period {#vortex-20-indicator-2e-period}

```ts
"vortex indicator.period": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.hlines background.color {#williams-20--25-r-2e-hlines-20-background-2e-color}

```ts
"williams %r.hlines background.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.hlines background.transparency {#williams-20--25-r-2e-hlines-20-background-2e-transparency}

```ts
"williams %r.hlines background.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.hlines background.visible {#williams-20--25-r-2e-hlines-20-background-2e-visible}

```ts
"williams %r.hlines background.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.upperlimit.color {#williams-20--25-r-2e-upperlimit-2e-color}

```ts
"williams %r.upperlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.upperlimit.linestyle {#williams-20--25-r-2e-upperlimit-2e-linestyle}

```ts
"williams %r.upperlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.upperlimit.linewidth {#williams-20--25-r-2e-upperlimit-2e-linewidth}

```ts
"williams %r.upperlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.upperlimit.visible {#williams-20--25-r-2e-upperlimit-2e-visible}

```ts
"williams %r.upperlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.upperlimit.value {#williams-20--25-r-2e-upperlimit-2e-value}

```ts
"williams %r.upperlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.lowerlimit.color {#williams-20--25-r-2e-lowerlimit-2e-color}

```ts
"williams %r.lowerlimit.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.lowerlimit.linestyle {#williams-20--25-r-2e-lowerlimit-2e-linestyle}

```ts
"williams %r.lowerlimit.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.lowerlimit.linewidth {#williams-20--25-r-2e-lowerlimit-2e-linewidth}

```ts
"williams %r.lowerlimit.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.lowerlimit.visible {#williams-20--25-r-2e-lowerlimit-2e-visible}

```ts
"williams %r.lowerlimit.visible": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.lowerlimit.value {#williams-20--25-r-2e-lowerlimit-2e-value}

```ts
"williams %r.lowerlimit.value": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.plot.display {#williams-20--25-r-2e-plot-2e-display}

```ts
"williams %r.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.plot.linestyle {#williams-20--25-r-2e-plot-2e-linestyle}

```ts
"williams %r.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.plot.linewidth {#williams-20--25-r-2e-plot-2e-linewidth}

```ts
"williams %r.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.plot.plottype {#williams-20--25-r-2e-plot-2e-plottype}

```ts
"williams %r.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.plot.trackprice {#williams-20--25-r-2e-plot-2e-trackprice}

```ts
"williams %r.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.plot.transparency {#williams-20--25-r-2e-plot-2e-transparency}

```ts
"williams %r.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.plot.color {#williams-20--25-r-2e-plot-2e-color}

```ts
"williams %r.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams %r.length {#williams-20--25-r-2e-length}

```ts
"williams %r.length": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw.display {#williams-20-alligator-2e-jaw-2e-display}

```ts
"williams alligator.jaw.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw.linestyle {#williams-20-alligator-2e-jaw-2e-linestyle}

```ts
"williams alligator.jaw.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw.linewidth {#williams-20-alligator-2e-jaw-2e-linewidth}

```ts
"williams alligator.jaw.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw.plottype {#williams-20-alligator-2e-jaw-2e-plottype}

```ts
"williams alligator.jaw.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw.trackprice {#williams-20-alligator-2e-jaw-2e-trackprice}

```ts
"williams alligator.jaw.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw.transparency {#williams-20-alligator-2e-jaw-2e-transparency}

```ts
"williams alligator.jaw.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw.color {#williams-20-alligator-2e-jaw-2e-color}

```ts
"williams alligator.jaw.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth.display {#williams-20-alligator-2e-teeth-2e-display}

```ts
"williams alligator.teeth.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth.linestyle {#williams-20-alligator-2e-teeth-2e-linestyle}

```ts
"williams alligator.teeth.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth.linewidth {#williams-20-alligator-2e-teeth-2e-linewidth}

```ts
"williams alligator.teeth.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth.plottype {#williams-20-alligator-2e-teeth-2e-plottype}

```ts
"williams alligator.teeth.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth.trackprice {#williams-20-alligator-2e-teeth-2e-trackprice}

```ts
"williams alligator.teeth.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth.transparency {#williams-20-alligator-2e-teeth-2e-transparency}

```ts
"williams alligator.teeth.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth.color {#williams-20-alligator-2e-teeth-2e-color}

```ts
"williams alligator.teeth.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips.display {#williams-20-alligator-2e-lips-2e-display}

```ts
"williams alligator.lips.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips.linestyle {#williams-20-alligator-2e-lips-2e-linestyle}

```ts
"williams alligator.lips.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips.linewidth {#williams-20-alligator-2e-lips-2e-linewidth}

```ts
"williams alligator.lips.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips.plottype {#williams-20-alligator-2e-lips-2e-plottype}

```ts
"williams alligator.lips.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips.trackprice {#williams-20-alligator-2e-lips-2e-trackprice}

```ts
"williams alligator.lips.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips.transparency {#williams-20-alligator-2e-lips-2e-transparency}

```ts
"williams alligator.lips.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips.color {#williams-20-alligator-2e-lips-2e-color}

```ts
"williams alligator.lips.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw length {#williams-20-alligator-2e-jaw-20-length}

```ts
"williams alligator.jaw length": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth length {#williams-20-alligator-2e-teeth-20-length}

```ts
"williams alligator.teeth length": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips length {#williams-20-alligator-2e-lips-20-length}

```ts
"williams alligator.lips length": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.jaw offset {#williams-20-alligator-2e-jaw-20-offset}

```ts
"williams alligator.jaw offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.teeth offset {#williams-20-alligator-2e-teeth-20-offset}

```ts
"williams alligator.teeth offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams alligator.lips offset {#williams-20-alligator-2e-lips-20-offset}

```ts
"williams alligator.lips offset": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.down fractals.display {#williams-20-fractal-2e-down-20-fractals-2e-display}

```ts
"williams fractal.down fractals.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.down fractals.plottype {#williams-20-fractal-2e-down-20-fractals-2e-plottype}

```ts
"williams fractal.down fractals.plottype": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.down fractals.location {#williams-20-fractal-2e-down-20-fractals-2e-location}

```ts
"williams fractal.down fractals.location": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.down fractals.transparency {#williams-20-fractal-2e-down-20-fractals-2e-transparency}

```ts
"williams fractal.down fractals.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.down fractals.color {#williams-20-fractal-2e-down-20-fractals-2e-color}

```ts
"williams fractal.down fractals.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.up fractals.display {#williams-20-fractal-2e-up-20-fractals-2e-display}

```ts
"williams fractal.up fractals.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.up fractals.plottype {#williams-20-fractal-2e-up-20-fractals-2e-plottype}

```ts
"williams fractal.up fractals.plottype": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.up fractals.location {#williams-20-fractal-2e-up-20-fractals-2e-location}

```ts
"williams fractal.up fractals.location": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.up fractals.transparency {#williams-20-fractal-2e-up-20-fractals-2e-transparency}

```ts
"williams fractal.up fractals.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.up fractals.color {#williams-20-fractal-2e-up-20-fractals-2e-color}

```ts
"williams fractal.up fractals.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## williams fractal.periods {#williams-20-fractal-2e-periods}

```ts
"williams fractal.periods": number;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.plot.display {#zig-20-zag-2e-plot-2e-display}

```ts
"zig zag.plot.display": number;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.plot.linestyle {#zig-20-zag-2e-plot-2e-linestyle}

```ts
"zig zag.plot.linestyle": number;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.plot.linewidth {#zig-20-zag-2e-plot-2e-linewidth}

```ts
"zig zag.plot.linewidth": number;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.plot.plottype {#zig-20-zag-2e-plot-2e-plottype}

```ts
"zig zag.plot.plottype": LineStudyPlotStyleName;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.plot.trackprice {#zig-20-zag-2e-plot-2e-trackprice}

```ts
"zig zag.plot.trackprice": boolean;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.plot.transparency {#zig-20-zag-2e-plot-2e-transparency}

```ts
"zig zag.plot.transparency": number;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.plot.color {#zig-20-zag-2e-plot-2e-color}

```ts
"zig zag.plot.color": string;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.deviation {#zig-20-zag-2e-deviation}

```ts
"zig zag.deviation": number;
```

Use the type signature above and the integration guide for the owning capability.

## zig zag.depth {#zig-20-zag-2e-depth}

```ts
"zig zag.depth": number;
```

Use the type signature above and the integration guide for the owning capability.

## signature {#signature}

```ts
[key: string]: StudyOverrideValueType;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `key` | `string` | Yes |

## Related types

- [LineStudyPlotStyleName](https://docs.lumencharts.com/charting-library/api/LineStudyPlotStyleName)
- [StudyOverrideValueType](https://docs.lumencharts.com/charting-library/api/StudyOverrideValueType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOverrides


---

<!-- Public documentation export; not library implementation source. -->
# StudyOverrideValueType

[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.

```ts
export type StudyOverrideValueType = string | number | boolean;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyOverrideValueType


---

<!-- Public documentation export; not library implementation source. -->
# StudyPaletteColor

[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.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## style {#style}

```ts
style: number;
```

Use the type signature above and the integration guide for the owning capability.

## width {#width}

```ts
width: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPaletteColor


---

<!-- Public documentation export; not library implementation source. -->
# StudyPaletteColorPreferences

[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.

```ts
export interface StudyPaletteColorPreferences
  extends StudyPaletteColor, StudyPaletteInfo {}
```

## Related types

- [StudyPaletteColor](https://docs.lumencharts.com/charting-library/api/StudyPaletteColor)
- [StudyPaletteInfo](https://docs.lumencharts.com/charting-library/api/StudyPaletteInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPaletteColorPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyPalettedPlotInfo

[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.

## Extends

[StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

## palette {#palette}

```ts
readonly palette: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyPaletteInfo

[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.

## name {#name}

```ts
readonly name: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPaletteInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyPalettePreferences

[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.

## colors {#colors}

```ts
colors: Record<string, StudyPaletteColorPreferences>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPaletteColorPreferences](https://docs.lumencharts.com/charting-library/api/StudyPaletteColorPreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPalettePreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyPalettesInfo

[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.

## colors {#colors}

```ts
readonly colors: MappedObject<StudyPaletteInfo> | StudyPaletteInfo[];
```

Use the type signature above and the integration guide for the owning capability.

## valToIndex {#valtoindex}

```ts
readonly valToIndex?: MappedObject<number>;
```

Use the type signature above and the integration guide for the owning capability.

## addDefaultColor {#adddefaultcolor}

```ts
readonly addDefaultColor?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [MappedObject](https://docs.lumencharts.com/charting-library/api/MappedObject)
- [StudyPaletteInfo](https://docs.lumencharts.com/charting-library/api/StudyPaletteInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPalettesInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyPaletteStyle

[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.

## colors {#colors}

```ts
colors: MappedObject<StudyPaletteColor> | StudyPaletteColor[];
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [MappedObject](https://docs.lumencharts.com/charting-library/api/MappedObject)
- [StudyPaletteColor](https://docs.lumencharts.com/charting-library/api/StudyPaletteColor)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPaletteStyle


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotBaseInfo

[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.

## id {#id}

```ts
readonly id: string;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
readonly type: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotBasePreferences

[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.

## transparency {#transparency}

```ts
transparency: number;
```

Use the type signature above and the integration guide for the owning capability.

## display {#display}

```ts
display: StudyPlotDisplayMode;
```

Use the type signature above and the integration guide for the owning capability.

## visible {#visible}

```ts
visible?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotDisplayMode](https://docs.lumencharts.com/charting-library/api/StudyPlotDisplayMode)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotDisplayMode

[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.

```ts
export type StudyPlotDisplayMode =
  Nominal<number, "StudyPlotDisplayTarget"> | StudyPlotDisplayTarget;
```

## Related types

- [Nominal](https://docs.lumencharts.com/charting-library/api/Nominal)
- [StudyPlotDisplayTarget](https://docs.lumencharts.com/charting-library/api/StudyPlotDisplayTarget)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotDisplayMode


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotDisplayTarget

[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.

```ts
export declare const enum StudyPlotDisplayTarget {
  None = 0,
  Pane = 1,
  DataWindow = 2,
  PriceScale = 4,
  StatusLine = 8,
  All = 15,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotDisplayTarget


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotInfo

[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.

```ts
export type StudyPlotInfo = StudyPlotInformation;
```

## Related types

- [StudyPlotInformation](https://docs.lumencharts.com/charting-library/api/StudyPlotInformation)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotInformation

[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.

```ts
export type StudyPlotInformation =
  | StudyArrowsPlotInfo
  | StudyCharsPlotInfo
  | StudyColorerPlotInfo
  | StudyRgbaColorerPlotInfo
  | StudyDataPlotInfo
  | StudyDataOffsetPlotInfo
  | StudyLinePlotInfo
  | StudyOhlcPlotInfo
  | StudyShapesPlotInfo
  | StudyBarColorerPlotInfo
  | StudyBgColorerPlotInfo
  | StudyTextColorerPlotInfo
  | StudyOhlcColorerPlotInfo
  | StudyCandleWickColorerPlotInfo
  | StudyCandleBorderColorerPlotInfo
  | StudyUpColorerPlotInfo
  | StudyDownColorerPlotInfo;
```

## Related types

- [StudyArrowsPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyArrowsPlotInfo)
- [StudyCharsPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyCharsPlotInfo)
- [StudyColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyColorerPlotInfo)
- [StudyRgbaColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyRgbaColorerPlotInfo)
- [StudyDataPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyDataPlotInfo)
- [StudyDataOffsetPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyDataOffsetPlotInfo)
- [StudyLinePlotInfo](https://docs.lumencharts.com/charting-library/api/StudyLinePlotInfo)
- [StudyOhlcPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotInfo)
- [StudyShapesPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyShapesPlotInfo)
- [StudyBarColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyBarColorerPlotInfo)
- [StudyBgColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyBgColorerPlotInfo)
- [StudyTextColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTextColorerPlotInfo)
- [StudyOhlcColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyOhlcColorerPlotInfo)
- [StudyCandleWickColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyCandleWickColorerPlotInfo)
- [StudyCandleBorderColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyCandleBorderColorerPlotInfo)
- [StudyUpColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyUpColorerPlotInfo)
- [StudyDownColorerPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyDownColorerPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotInformation


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotPreferences

[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.

```ts
export type StudyPlotPreferences =
  | StudyLinePlotPreferences
  | StudyShapesPlotPreferences
  | StudyCharsPlotPreferences
  | StudyArrowsPlotPreferences;
```

## Related types

- [StudyLinePlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyLinePlotPreferences)
- [StudyShapesPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyShapesPlotPreferences)
- [StudyCharsPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyCharsPlotPreferences)
- [StudyArrowsPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyArrowsPlotPreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotValueFormat

[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.

```ts
export type StudyPlotValueFormat =
  StudyPlotValueInheritFormat | StudyPlotValuePrecisionFormat;
```

## Related types

- [StudyPlotValueInheritFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValueInheritFormat)
- [StudyPlotValuePrecisionFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValuePrecisionFormat)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotValueFormat


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotValueInheritFormat

[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.

## type {#type}

```ts
type: "inherit";
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotValueInheritFormat


---

<!-- Public documentation export; not library implementation source. -->
# StudyPlotValuePrecisionFormat

[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.

## type {#type}

```ts
type: "price" | "volume" | "percent";
```

Use the type signature above and the integration guide for the owning capability.

## precision {#precision}

```ts
precision?: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPlotValuePrecisionFormat


---

<!-- Public documentation export; not library implementation source. -->
# StudyPriceInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Price;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: number;
```

Use the type signature above and the integration guide for the owning capability.

## max {#max}

```ts
readonly max?: number;
```

Use the type signature above and the integration guide for the owning capability.

## min {#min}

```ts
readonly min?: number;
```

Use the type signature above and the integration guide for the owning capability.

## step {#step}

```ts
readonly step?: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPriceInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyPriceScale

[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.

```ts
export type StudyPriceScale =
  "new-left" | "new-right" | "no-scale" | "as-series";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPriceScale


---

<!-- Public documentation export; not library implementation source. -->
# StudyPrimitiveResult

[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.

```ts
export type StudyPrimitiveResult = (number | StudyResultValueWithOffset)[];
```

## Related types

- [StudyResultValueWithOffset](https://docs.lumencharts.com/charting-library/api/StudyResultValueWithOffset)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyPrimitiveResult


---

<!-- Public documentation export; not library implementation source. -->
# StudyResolutionInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Resolution;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

## options {#options}

```ts
readonly options?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## optionsTitles {#optionstitles}

```ts
readonly optionsTitles?: StudyInputOptionsTitles;
```

Use the type signature above and the integration guide for the owning capability.

## isMTFResolution {#ismtfresolution}

```ts
readonly isMTFResolution?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [StudyInputOptionsTitles](https://docs.lumencharts.com/charting-library/api/StudyInputOptionsTitles)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyResolutionInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyResultValueWithOffset

[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.

## value {#value}

```ts
value: number;
```

Use the type signature above and the integration guide for the owning capability.

## offset {#offset}

```ts
offset: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyResultValueWithOffset


---

<!-- Public documentation export; not library implementation source. -->
# StudyRgbaColorerPlotInfo

[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.

## Extends

[StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.Colorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyRgbaColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudySessionInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Session;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: string;
```

Use the type signature above and the integration guide for the owning capability.

## options {#options}

```ts
readonly options?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## optionsTitles {#optionstitles}

```ts
readonly optionsTitles?: StudyInputOptionsTitles;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)
- [StudyInputOptionsTitles](https://docs.lumencharts.com/charting-library/api/StudyInputOptionsTitles)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudySessionInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyShapesPlotInfo

[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.

## Extends

[StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

## type {#type}

```ts
readonly type: StudyPlotType.Shapes;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyShapesPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyShapesPlotPreferences

[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.

## Extends

[StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)

## plottype {#plottype}

```ts
plottype: PlotShapeId;
```

Use the type signature above and the integration guide for the owning capability.

## location {#location}

```ts
location: MarkLocation;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## textColor {#textcolor}

```ts
textColor: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBasePreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotBasePreferences)
- [PlotShapeId](https://docs.lumencharts.com/charting-library/api/PlotShapeId)
- [MarkLocation](https://docs.lumencharts.com/charting-library/api/MarkLocation)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyShapesPlotPreferences


---

<!-- Public documentation export; not library implementation source. -->
# StudySourceInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Source;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: StudyAvailableConstSources | string;
```

Use the type signature above and the integration guide for the owning capability.

## options {#options}

```ts
readonly options?: (StudyAvailableConstSources | string)[];
```

Use the type signature above and the integration guide for the owning capability.

## optionsTitles {#optionstitles}

```ts
readonly optionsTitles?: StudyInputOptionsTitles;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)
- [StudyAvailableConstSources](https://docs.lumencharts.com/charting-library/api/StudyAvailableConstSources)
- [StudyInputOptionsTitles](https://docs.lumencharts.com/charting-library/api/StudyInputOptionsTitles)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudySourceInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyStyleInfo

[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.

## defaults {#defaults}

```ts
defaults?: StudyStyleInfoDefaults;
```

Use the type signature above and the integration guide for the owning capability.

## plots {#plots}

```ts
plots?: readonly Readonly<StudyPlotInfo>[];
```

Use the type signature above and the integration guide for the owning capability.

## styles {#styles}

```ts
styles?: Record<string, Readonly<StudyStylesInfo> | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## bands {#bands}

```ts
bands?: readonly Readonly<StudyBandInfo>[];
```

Use the type signature above and the integration guide for the owning capability.

## filledAreas {#filledareas}

```ts
filledAreas?: readonly Readonly<StudyFilledAreaInfo>[];
```

Use the type signature above and the integration guide for the owning capability.

## palettes {#palettes}

```ts
palettes?: Record<string, Readonly<StudyPalettesInfo> | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyStyleInfoDefaults](https://docs.lumencharts.com/charting-library/api/StudyStyleInfoDefaults)
- [StudyPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotInfo)
- [StudyStylesInfo](https://docs.lumencharts.com/charting-library/api/StudyStylesInfo)
- [StudyBandInfo](https://docs.lumencharts.com/charting-library/api/StudyBandInfo)
- [StudyFilledAreaInfo](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaInfo)
- [StudyPalettesInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettesInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyStyleInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyStyleInfoDefaults

[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.

## bands {#bands}

```ts
bands?: readonly StudyBandStyle[];
```

Use the type signature above and the integration guide for the owning capability.

## filledAreasStyle {#filledareasstyle}

```ts
filledAreasStyle?: Record<string, StudyFilledAreaStyle | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## palettes {#palettes}

```ts
palettes?: Record<string, StudyPaletteStyle | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## styles {#styles}

```ts
styles?: Record<string, StudyPlotPreferences | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## ohlcPlots {#ohlcplots}

```ts
ohlcPlots?: Record<string, StudyOhlcPlotPreferences | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## graphics {#graphics}

```ts
graphics?: {
    horizlines?: Record<string, HorizLinePreferences | undefined>;
    polygons?: Record<string, PolygonPreferences | undefined>;
    hhists?: Record<string, HHistPreferences | undefined>;
    vertlines?: Record<string, VertLinePreferences | undefined>;
  };
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyBandStyle](https://docs.lumencharts.com/charting-library/api/StudyBandStyle)
- [StudyFilledAreaStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyle)
- [StudyPaletteStyle](https://docs.lumencharts.com/charting-library/api/StudyPaletteStyle)
- [StudyPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotPreferences)
- [StudyOhlcPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotPreferences)
- [HorizLinePreferences](https://docs.lumencharts.com/charting-library/api/HorizLinePreferences)
- [PolygonPreferences](https://docs.lumencharts.com/charting-library/api/PolygonPreferences)
- [HHistPreferences](https://docs.lumencharts.com/charting-library/api/HHistPreferences)
- [VertLinePreferences](https://docs.lumencharts.com/charting-library/api/VertLinePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyStyleInfoDefaults


---

<!-- Public documentation export; not library implementation source. -->
# StudyStylesInfo

[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.

## histogramBase {#histogrambase}

```ts
readonly histogramBase?: number;
```

Use the type signature above and the integration guide for the owning capability.

## joinPoints {#joinpoints}

```ts
readonly joinPoints?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
readonly title: string;
```

Use the type signature above and the integration guide for the owning capability.

## isHidden {#ishidden}

```ts
readonly isHidden?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## minHeight {#minheight}

```ts
readonly minHeight?: number;
```

Use the type signature above and the integration guide for the owning capability.

## maxHeight {#maxheight}

```ts
readonly maxHeight?: number;
```

Use the type signature above and the integration guide for the owning capability.

## size {#size}

```ts
readonly size?: PlotSymbolSize;
```

Use the type signature above and the integration guide for the owning capability.

## char {#char}

```ts
readonly char?: string;
```

Use the type signature above and the integration guide for the owning capability.

## text {#text}

```ts
readonly text?: string;
```

Use the type signature above and the integration guide for the owning capability.

## showLast {#showlast}

```ts
readonly showLast?: number;
```

Use the type signature above and the integration guide for the owning capability.

## zorder {#zorder}

```ts
readonly zorder?: number;
```

Use the type signature above and the integration guide for the owning capability.

## format {#format}

```ts
readonly format?: Partial<StudyPlotValuePrecisionFormat>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [PlotSymbolSize](https://docs.lumencharts.com/charting-library/api/PlotSymbolSize)
- [StudyPlotValuePrecisionFormat](https://docs.lumencharts.com/charting-library/api/StudyPlotValuePrecisionFormat)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyStylesInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyStyleValues

[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.

## ohlcPlots {#ohlcplots}

```ts
ohlcPlots: Record<string, StudyOhlcPlotPreferences | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## bands {#bands}

```ts
bands: StudyBandPreferences[];
```

Use the type signature above and the integration guide for the owning capability.

## palettes {#palettes}

```ts
palettes: Record<string, StudyPalettePreferences | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## styles {#styles}

```ts
styles: Record<string, StudyPlotPreferences | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## filledAreas {#filledareas}

```ts
filledAreas: StudyFilledAreaInfo[];
```

Use the type signature above and the integration guide for the owning capability.

## filledAreasStyle {#filledareasstyle}

```ts
filledAreasStyle: Record<string, StudyFilledAreaStyle | undefined>;
```

Use the type signature above and the integration guide for the owning capability.

## graphics {#graphics}

```ts
graphics: {
    horizlines?: Record<string, HorizLinePreferences | undefined>;
    polygons?: Record<string, PolygonPreferences | undefined>;
    hhists?: Record<string, HHistPreferences | undefined>;
    vertlines?: Record<string, VertLinePreferences | undefined>;
  };
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyOhlcPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyOhlcPlotPreferences)
- [StudyBandPreferences](https://docs.lumencharts.com/charting-library/api/StudyBandPreferences)
- [StudyPalettePreferences](https://docs.lumencharts.com/charting-library/api/StudyPalettePreferences)
- [StudyPlotPreferences](https://docs.lumencharts.com/charting-library/api/StudyPlotPreferences)
- [StudyFilledAreaInfo](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaInfo)
- [StudyFilledAreaStyle](https://docs.lumencharts.com/charting-library/api/StudyFilledAreaStyle)
- [HorizLinePreferences](https://docs.lumencharts.com/charting-library/api/HorizLinePreferences)
- [PolygonPreferences](https://docs.lumencharts.com/charting-library/api/PolygonPreferences)
- [HHistPreferences](https://docs.lumencharts.com/charting-library/api/HHistPreferences)
- [VertLinePreferences](https://docs.lumencharts.com/charting-library/api/VertLinePreferences)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyStyleValues


---

<!-- Public documentation export; not library implementation source. -->
# StudySymbolInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Symbol;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval?: string;
```

Use the type signature above and the integration guide for the owning capability.

## optional {#optional}

```ts
readonly optional?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudySymbolInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyTargetedPlotInfo

[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.

## Extends

[StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

## target {#target}

```ts
readonly target: string;
```

Use the type signature above and the integration guide for the owning capability.

## targetField {#targetfield}

```ts
readonly targetField?:
    "topColor" | "bottomColor" | "topValue" | "bottomValue";
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPlotBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyPlotBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyTargetPriceScale

[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.

```ts
export declare const enum StudyTargetPriceScale {
  Right = 0,
  Left = 1,
  NoScale = 2,
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTargetPriceScale


---

<!-- Public documentation export; not library implementation source. -->
# StudyTemplateData

[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.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## content {#content}

```ts
content: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTemplateData


---

<!-- Public documentation export; not library implementation source. -->
# StudyTemplateMetaInfo

[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.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTemplateMetaInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyTextareaInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Textarea;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTextareaInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyTextColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo), [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.TextColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTextColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyTextInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Text;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: string;
```

Use the type signature above and the integration guide for the owning capability.

## options {#options}

```ts
readonly options?: string[];
```

Use the type signature above and the integration guide for the owning capability.

## optionsTitles {#optionstitles}

```ts
readonly optionsTitles?: StudyInputOptionsTitles;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)
- [StudyInputOptionsTitles](https://docs.lumencharts.com/charting-library/api/StudyInputOptionsTitles)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTextInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyTimeInputInfo

[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.

## Extends

[StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

## type {#type}

```ts
readonly type: StudyInputType.Time;
```

Use the type signature above and the integration guide for the owning capability.

## defval {#defval}

```ts
readonly defval: number;
```

Use the type signature above and the integration guide for the owning capability.

## max {#max}

```ts
readonly max: number;
```

Use the type signature above and the integration guide for the owning capability.

## min {#min}

```ts
readonly min: number;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyInputBaseInfo](https://docs.lumencharts.com/charting-library/api/StudyInputBaseInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyTimeInputInfo


---

<!-- Public documentation export; not library implementation source. -->
# StudyUpColorerPlotInfo

[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.

## Extends

[StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo), [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

## type {#type}

```ts
readonly type: StudyPlotType.UpColorer;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [StudyPalettedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyPalettedPlotInfo)
- [StudyTargetedPlotInfo](https://docs.lumencharts.com/charting-library/api/StudyTargetedPlotInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StudyUpColorerPlotInfo


---

<!-- Public documentation export; not library implementation source. -->
# StyledText

[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.

## text {#text}

```ts
text: string;
```

Use the type signature above and the integration guide for the owning capability.

## font {#font}

```ts
font?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontFamily {#fontfamily}

```ts
fontFamily?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontFeatureSettings {#fontfeaturesettings}

```ts
fontFeatureSettings?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontKerning {#fontkerning}

```ts
fontKerning?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontOpticalSizing {#fontopticalsizing}

```ts
fontOpticalSizing?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontPalette {#fontpalette}

```ts
fontPalette?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontSize {#fontsize}

```ts
fontSize?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontSizeAdjust {#fontsizeadjust}

```ts
fontSizeAdjust?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontStretch {#fontstretch}

```ts
fontStretch?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontStyle {#fontstyle}

```ts
fontStyle?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontSynthesis {#fontsynthesis}

```ts
fontSynthesis?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariant {#fontvariant}

```ts
fontVariant?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariantAlternates {#fontvariantalternates}

```ts
fontVariantAlternates?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariantCaps {#fontvariantcaps}

```ts
fontVariantCaps?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariantEastAsian {#fontvarianteastasian}

```ts
fontVariantEastAsian?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariantLigatures {#fontvariantligatures}

```ts
fontVariantLigatures?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariantNumeric {#fontvariantnumeric}

```ts
fontVariantNumeric?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariantPosition {#fontvariantposition}

```ts
fontVariantPosition?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontVariationSettings {#fontvariationsettings}

```ts
fontVariationSettings?: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontWeight {#fontweight}

```ts
fontWeight?: string;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color?: string;
```

Use the type signature above and the integration guide for the owning capability.

## lineHeight {#lineheight}

```ts
lineHeight?: string;
```

Use the type signature above and the integration guide for the owning capability.

## letterSpacing {#letterspacing}

```ts
letterSpacing?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/StyledText


---

<!-- Public documentation export; not library implementation source. -->
# SubscribeBarsCallback

[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.

```ts
export type SubscribeBarsCallback = (bar: Bar) => void;
```

## Related types

- [Bar](https://docs.lumencharts.com/charting-library/api/Bar)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SubscribeBarsCallback


---

<!-- Public documentation export; not library implementation source. -->
# SubscribeEventsMap

[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.

## toggle_sidebar {#toggle_sidebar}

```ts
toggle_sidebar: (isHidden: boolean) => void;
```

Use the type signature above and the integration guide for the owning capability.

## indicators_dialog {#indicators_dialog}

```ts
indicators_dialog: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## toggle_header {#toggle_header}

```ts
toggle_header: (isHidden: boolean) => void;
```

Use the type signature above and the integration guide for the owning capability.

## edit_object_dialog {#edit_object_dialog}

```ts
edit_object_dialog: (params: EditObjectDialogEventParams) => void;
```

Use the type signature above and the integration guide for the owning capability.

## chart_load_requested {#chart_load_requested}

```ts
chart_load_requested: (savedData: object) => void;
```

Use the type signature above and the integration guide for the owning capability.

## chart_loaded {#chart_loaded}

```ts
chart_loaded: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## mouse_down {#mouse_down}

```ts
mouse_down: (params: MouseEventParams) => void;
```

Use the type signature above and the integration guide for the owning capability.

## mouse_up {#mouse_up}

```ts
mouse_up: (params: MouseEventParams) => void;
```

Use the type signature above and the integration guide for the owning capability.

## drawing {#drawing}

```ts
drawing: (params: StudyOrDrawingAddedToChartEventParams) => void;
```

Use the type signature above and the integration guide for the owning capability.

## study {#study}

```ts
study: (params: StudyOrDrawingAddedToChartEventParams) => void;
```

Use the type signature above and the integration guide for the owning capability.

## undo {#undo}

```ts
undo: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## redo {#redo}

```ts
redo: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## undo_redo_state_changed {#undo_redo_state_changed}

```ts
undo_redo_state_changed: (state: UndoRedoState) => void;
```

Use the type signature above and the integration guide for the owning capability.

## reset_scales {#reset_scales}

```ts
reset_scales: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## compare_add {#compare_add}

```ts
compare_add: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## add_compare {#add_compare}

```ts
add_compare: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## load_study_template {#load_study_template}

```ts
load_study_template: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## onTick {#ontick}

```ts
onTick: (tick: Bar) => void;
```

Use the type signature above and the integration guide for the owning capability.

## onAutoSaveNeeded {#onautosaveneeded}

```ts
onAutoSaveNeeded: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## save_status_retry_requested {#save_status_retry_requested}

```ts
save_status_retry_requested: (payload: { status: "failed" | "load-failed" }) => void;
```

The user clicked Retry on a failed header save status (`setSaveStatus`).

## onScreenshotReady {#onscreenshotready}

```ts
onScreenshotReady: (url: string) => void;
```

Use the type signature above and the integration guide for the owning capability.

## onMarkClick {#onmarkclick}

```ts
onMarkClick: (markId: Mark["id"]) => void;
```

Use the type signature above and the integration guide for the owning capability.

## onPlusClick {#onplusclick}

```ts
onPlusClick: (params: PlusClickParams) => void;
```

Use the type signature above and the integration guide for the owning capability.

## onTimescaleMarkClick {#ontimescalemarkclick}

```ts
onTimescaleMarkClick: (markId: TimescaleMark["id"]) => void;
```

Use the type signature above and the integration guide for the owning capability.

## onSelectedLineToolChanged {#onselectedlinetoolchanged}

```ts
onSelectedLineToolChanged: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## layout_about_to_be_changed {#layout_about_to_be_changed}

```ts
layout_about_to_be_changed: (newLayoutType: LayoutType) => void;
```

Use the type signature above and the integration guide for the owning capability.

## layout_changed {#layout_changed}

```ts
layout_changed: EmptyCallback;
```

Use the type signature above and the integration guide for the owning capability.

## activeChartChanged {#activechartchanged}

```ts
activeChartChanged: (chartIndex: number) => void;
```

Use the type signature above and the integration guide for the owning capability.

## series_event {#series_event}

```ts
series_event: (seriesEventType: SeriesEventType) => void;
```

Use the type signature above and the integration guide for the owning capability.

## study_event {#study_event}

```ts
study_event: (entityId: EntityId, studyEventType: StudyEventType) => void;
```

Use the type signature above and the integration guide for the owning capability.

## drawing_event {#drawing_event}

```ts
drawing_event: (
    sourceId: EntityId,
    drawingEventType: DrawingEventType,
  ) => void;
```

Use the type signature above and the integration guide for the owning capability.

## study_properties_changed {#study_properties_changed}

```ts
study_properties_changed: (id: EntityId) => void;
```

Use the type signature above and the integration guide for the owning capability.

## series_properties_changed {#series_properties_changed}

```ts
series_properties_changed: (id: EntityId) => void;
```

Use the type signature above and the integration guide for the owning capability.

## panes_height_changed {#panes_height_changed}

```ts
panes_height_changed: () => void;
```

Use the type signature above and the integration guide for the owning capability.

## panes_order_changed {#panes_order_changed}

```ts
panes_order_changed: () => void;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [EmptyCallback](https://docs.lumencharts.com/charting-library/api/EmptyCallback)
- [EditObjectDialogEventParams](https://docs.lumencharts.com/charting-library/api/EditObjectDialogEventParams)
- [MouseEventParams](https://docs.lumencharts.com/charting-library/api/MouseEventParams)
- [StudyOrDrawingAddedToChartEventParams](https://docs.lumencharts.com/charting-library/api/StudyOrDrawingAddedToChartEventParams)
- [UndoRedoState](https://docs.lumencharts.com/charting-library/api/UndoRedoState)
- [Bar](https://docs.lumencharts.com/charting-library/api/Bar)
- [Mark](https://docs.lumencharts.com/charting-library/api/Mark)
- [PlusClickParams](https://docs.lumencharts.com/charting-library/api/PlusClickParams)
- [TimescaleMark](https://docs.lumencharts.com/charting-library/api/TimescaleMark)
- [LayoutType](https://docs.lumencharts.com/charting-library/api/LayoutType)
- [SeriesEventType](https://docs.lumencharts.com/charting-library/api/SeriesEventType)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [StudyEventType](https://docs.lumencharts.com/charting-library/api/StudyEventType)
- [DrawingEventType](https://docs.lumencharts.com/charting-library/api/DrawingEventType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SubscribeEventsMap


---

<!-- Public documentation export; not library implementation source. -->
# SuccessFormatterParseResult

[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.

## Extends

[FormatterParseResult](https://docs.lumencharts.com/charting-library/api/FormatterParseResult)

## res {#res}

```ts
res: true;
```

Use the type signature above and the integration guide for the owning capability.

## value {#value}

```ts
value: T;
```

Use the type signature above and the integration guide for the owning capability.

## suggest {#suggest}

```ts
suggest?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [FormatterParseResult](https://docs.lumencharts.com/charting-library/api/FormatterParseResult)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SuccessFormatterParseResult


---

<!-- Public documentation export; not library implementation source. -->
# SupportedLineTools

[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.

```ts
export type SupportedLineTools =
  | "text"
  | "anchored_text"
  | "note"
  | "anchored_note"
  | "signpost"
  | "double_curve"
  | "arc"
  | "icon"
  | "emoji"
  | "sticker"
  | "arrow_up"
  | "arrow_down"
  | "arrow_left"
  | "arrow_right"
  | "price_label"
  | "price_note"
  | "arrow_marker"
  | "flag"
  | "vertical_line"
  | "horizontal_line"
  | "cross_line"
  | "horizontal_ray"
  | "trend_line"
  | "info_line"
  | "trend_angle"
  | "arrow"
  | "ray"
  | "extended"
  | "parallel_channel"
  | "disjoint_angle"
  | "flat_bottom"
  | "anchored_vwap"
  | "pitchfork"
  | "schiff_pitchfork_modified"
  | "schiff_pitchfork"
  | "balloon"
  | "comment"
  | "inside_pitchfork"
  | "pitchfan"
  | "gannbox"
  | "gannbox_square"
  | "gannbox_fixed"
  | "gannbox_fan"
  | "fib_retracement"
  | "fib_trend_ext"
  | "fib_speed_resist_fan"
  | "fib_timezone"
  | "fib_trend_time"
  | "fib_circles"
  | "fib_spiral"
  | "fib_speed_resist_arcs"
  | "fib_channel"
  | "xabcd_pattern"
  | "cypher_pattern"
  | "abcd_pattern"
  | "callout"
  | "triangle_pattern"
  | "3divers_pattern"
  | "head_and_shoulders"
  | "fib_wedge"
  | "elliott_impulse_wave"
  | "elliott_triangle_wave"
  | "elliott_triple_combo"
  | "elliott_correction"
  | "elliott_double_combo"
  | "cyclic_lines"
  | "time_cycles"
  | "sine_line"
  | "long_position"
  | "short_position"
  | "forecast"
  | "date_range"
  | "price_range"
  | "date_and_price_range"
  | "bars_pattern"
  | "ghost_feed"
  | "projection"
  | "rectangle"
  | "rotated_rectangle"
  | "circle"
  | "ellipse"
  | "triangle"
  | "polyline"
  | "path"
  | "curve"
  | "cursor"
  | "dot"
  | "arrow_cursor"
  | "eraser"
  | "measure"
  | "zoom"
  | "brush"
  | "highlighter"
  | "regression_trend"
  | "fixed_range_volume_profile";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SupportedLineTools


---

<!-- Public documentation export; not library implementation source. -->
# SymbolExt

[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.

## symbol {#symbol}

```ts
symbol: string;
```

Use the type signature above and the integration guide for the owning capability.

## full_name {#full_name}

```ts
full_name: string;
```

Use the type signature above and the integration guide for the owning capability.

## exchange {#exchange}

```ts
exchange: string;
```

Use the type signature above and the integration guide for the owning capability.

## description {#description}

```ts
description: string;
```

Use the type signature above and the integration guide for the owning capability.

## type {#type}

```ts
type: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolExt


---

<!-- Public documentation export; not library implementation source. -->
# SymbolInfoPriceSource

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolInfoPriceSource


---

<!-- Public documentation export; not library implementation source. -->
# SymbolInputSymbolSource

[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.

## type {#type}

```ts
type: "symbolInputSymbolSource";
```

Use the type signature above and the integration guide for the owning capability.

## inputId {#inputid}

```ts
inputId: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolInputSymbolSource


---

<!-- Public documentation export; not library implementation source. -->
# SymbolIntervalResult

[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.

## symbol {#symbol}

```ts
symbol: string;
```

Use the type signature above and the integration guide for the owning capability.

## interval {#interval}

```ts
interval: ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolIntervalResult


---

<!-- Public documentation export; not library implementation source. -->
# SymbolResolveExtension

[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.

## currencyCode {#currencycode}

```ts
currencyCode?: string;
```

Use the type signature above and the integration guide for the owning capability.

## unitId {#unitid}

```ts
unitId?: string;
```

Use the type signature above and the integration guide for the owning capability.

## session {#session}

```ts
session?: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolResolveExtension


---

<!-- Public documentation export; not library implementation source. -->
# SymbolSearchCompleteData

[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.

## symbol {#symbol}

```ts
symbol: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolSearchCompleteData


---

<!-- Public documentation export; not library implementation source. -->
# SymbolSearchCompleteOverrideFunction

[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.

```ts
export type SymbolSearchCompleteOverrideFunction = (
  symbol: string,
  searchResultItem?: SearchSymbolResultItem,
) => Promise<SymbolSearchCompleteData>;
```

## Related types

- [SearchSymbolResultItem](https://docs.lumencharts.com/charting-library/api/SearchSymbolResultItem)
- [SymbolSearchCompleteData](https://docs.lumencharts.com/charting-library/api/SymbolSearchCompleteData)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolSearchCompleteOverrideFunction


---

<!-- Public documentation export; not library implementation source. -->
# SymbolSource

[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.

```ts
export type SymbolSource = SymbolInputSymbolSource;
```

## Related types

- [SymbolInputSymbolSource](https://docs.lumencharts.com/charting-library/api/SymbolInputSymbolSource)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SymbolSource


---

<!-- Public documentation export; not library implementation source. -->
# ThemeName

[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.

```ts
export type ThemeName = "light" | "dark";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ThemeName


---

<!-- Public documentation export; not library implementation source. -->
# TickMarkType

[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.

```ts
export type TickMarkType =
  | "Year"
  | "Month"
  | "DayOfMonth"
  | "Time"
  | "TimeWithSeconds"
  | "TimeWithMilliseconds";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TickMarkType


---

<!-- Public documentation export; not library implementation source. -->
# TimeFieldDescriptor

[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.

## type {#type}

```ts
type: "time";
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeFieldDescriptor


---

<!-- Public documentation export; not library implementation source. -->
# TimeFrameItem

[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.

## text {#text}

```ts
text: string;
```

Use the type signature above and the integration guide for the owning capability.

## resolution {#resolution}

```ts
resolution: ResolutionString;
```

Use the type signature above and the integration guide for the owning capability.

## description {#description}

```ts
description?: string;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title?: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeFrameItem


---

<!-- Public documentation export; not library implementation source. -->
# TimeframeOption

[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.

```ts
export type TimeframeOption =
  | string
  | {
      from: number;
      to: number;
    };
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeframeOption


---

<!-- Public documentation export; not library implementation source. -->
# TimeFramePeriodBack

[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.

## type {#type}

```ts
type: TimeFrameType.PeriodBack;
```

Use the type signature above and the integration guide for the owning capability.

## value {#value}

```ts
value: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeFramePeriodBack


---

<!-- Public documentation export; not library implementation source. -->
# TimeFrameTimeRange

[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.

## type {#type}

```ts
type: TimeFrameType.TimeRange;
```

Use the type signature above and the integration guide for the owning capability.

## from {#from}

```ts
from: number;
```

Use the type signature above and the integration guide for the owning capability.

## to {#to}

```ts
to: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeFrameTimeRange


---

<!-- Public documentation export; not library implementation source. -->
# TimeFrameValue

[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.

```ts
export type TimeFrameValue = TimeFramePeriodBack | TimeFrameTimeRange;
```

## Related types

- [TimeFramePeriodBack](https://docs.lumencharts.com/charting-library/api/TimeFramePeriodBack)
- [TimeFrameTimeRange](https://docs.lumencharts.com/charting-library/api/TimeFrameTimeRange)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeFrameValue


---

<!-- Public documentation export; not library implementation source. -->
# TimeHoursFormat

[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.

```ts
export declare const enum TimeHoursFormat {
  TwentyFourHours = "24-hours",
  TwelveHours = "12-hours",
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeHoursFormat


---

<!-- Public documentation export; not library implementation source. -->
# TimePoint

[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.

## time {#time}

```ts
time: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimePoint


---

<!-- Public documentation export; not library implementation source. -->
# TimescaleMark

[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.

## id {#id}

```ts
id: string | number;
```

Use the type signature above and the integration guide for the owning capability.

## time {#time}

```ts
time: number;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: MarkConstColors | string;
```

Use the type signature above and the integration guide for the owning capability.

## labelFontColor {#labelfontcolor}

```ts
labelFontColor?: MarkConstColors | string;
```

Use the type signature above and the integration guide for the owning capability.

## label {#label}

```ts
label: string;
```

Use the type signature above and the integration guide for the owning capability.

## tooltip {#tooltip}

```ts
tooltip: string[];
```

Use the type signature above and the integration guide for the owning capability.

## shape {#shape}

```ts
shape?: TimeScaleMarkShape;
```

Use the type signature above and the integration guide for the owning capability.

## imageUrl {#imageurl}

```ts
imageUrl?: string;
```

Use the type signature above and the integration guide for the owning capability.

## showLabelWhenImageLoaded {#showlabelwhenimageloaded}

```ts
showLabelWhenImageLoaded?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [MarkConstColors](https://docs.lumencharts.com/charting-library/api/MarkConstColors)
- [TimeScaleMarkShape](https://docs.lumencharts.com/charting-library/api/TimeScaleMarkShape)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimescaleMark


---

<!-- Public documentation export; not library implementation source. -->
# TimeScaleMarkShape

[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.

```ts
export type TimeScaleMarkShape =
  "circle" | "earningUp" | "earningDown" | "earning";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeScaleMarkShape


---

<!-- Public documentation export; not library implementation source. -->
# TimeScaleOptions

[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.

## min_bar_spacing {#min_bar_spacing}

```ts
min_bar_spacing?: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimeScaleOptions


---

<!-- Public documentation export; not library implementation source. -->
# Timezone

[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.

```ts
export type Timezone = "Etc/UTC" | CustomTimezones;
```

## Related types

- [CustomTimezones](https://docs.lumencharts.com/charting-library/api/CustomTimezones)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/Timezone


---

<!-- Public documentation export; not library implementation source. -->
# TimezoneId

[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.

```ts
export type TimezoneId = CustomTimezones | "Etc/UTC" | "exchange";
```

## Related types

- [CustomTimezones](https://docs.lumencharts.com/charting-library/api/CustomTimezones)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimezoneId


---

<!-- Public documentation export; not library implementation source. -->
# TimezoneInfo

[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.

## id {#id}

```ts
id: TimezoneId | CustomTimezoneId;
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title: string;
```

Use the type signature above and the integration guide for the owning capability.

## offset {#offset}

```ts
offset?: number;
```

Use the type signature above and the integration guide for the owning capability.

## alias {#alias}

```ts
alias?: TimezoneId | GmtTimezoneId;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [TimezoneId](https://docs.lumencharts.com/charting-library/api/TimezoneId)
- [CustomTimezoneId](https://docs.lumencharts.com/charting-library/api/CustomTimezoneId)
- [GmtTimezoneId](https://docs.lumencharts.com/charting-library/api/GmtTimezoneId)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/TimezoneInfo


---

<!-- Public documentation export; not library implementation source. -->
# UndoOptions

[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.

## disableUndo {#disableundo}

```ts
disableUndo?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/UndoOptions


---

<!-- Public documentation export; not library implementation source. -->
# UndoRedoState

[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.

## enableUndo {#enableundo}

```ts
readonly enableUndo: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## undoText {#undotext}

```ts
readonly undoText: string | undefined;
```

Use the type signature above and the integration guide for the owning capability.

## enableRedo {#enableredo}

```ts
readonly enableRedo: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## redoText {#redotext}

```ts
readonly redoText: string | undefined;
```

Use the type signature above and the integration guide for the owning capability.

## originalUndoText {#originalundotext}

```ts
readonly originalUndoText: string | undefined;
```

Use the type signature above and the integration guide for the owning capability.

## originalRedoText {#originalredotext}

```ts
readonly originalRedoText: string | undefined;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/UndoRedoState


---

<!-- Public documentation export; not library implementation source. -->
# Unit

[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.

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## name {#name}

```ts
name: string;
```

Use the type signature above and the integration guide for the owning capability.

## description {#description}

```ts
description: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/Unit


---

<!-- Public documentation export; not library implementation source. -->
# UnitInfo

[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.

## selectedUnit {#selectedunit}

```ts
selectedUnit: string | null;
```

Use the type signature above and the integration guide for the owning capability.

## availableGroups {#availablegroups}

```ts
availableGroups: string[];
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/UnitInfo


---

<!-- Public documentation export; not library implementation source. -->
# UserTimeFieldDescriptor

[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.

## type {#type}

```ts
type: "userTime";
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/UserTimeFieldDescriptor


---

<!-- Public documentation export; not library implementation source. -->
# ValueByStyleId

[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.

## signature {#signature}

```ts
[styleId: string]: TValue | undefined;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `styleId` | `string` | Yes |

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ValueByStyleId


---

<!-- Public documentation export; not library implementation source. -->
# VertLinePreferences

[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.

## visible {#visible}

```ts
visible: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## width {#width}

```ts
width: number;
```

Use the type signature above and the integration guide for the owning capability.

## color {#color}

```ts
color: string;
```

Use the type signature above and the integration guide for the owning capability.

## style {#style}

```ts
style: LineStyle;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [LineStyle](https://docs.lumencharts.com/charting-library/api/LineStyle)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/VertLinePreferences


---

<!-- Public documentation export; not library implementation source. -->
# VisibilityType

[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.

```ts
export declare const enum VisibilityType {
  AlwaysOn = "alwaysOn",
  VisibleOnMouseOver = "visibleOnMouseOver",
  AlwaysOff = "alwaysOff",
}
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/VisibilityType


---

<!-- Public documentation export; not library implementation source. -->
# VisiblePlotsSet

[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.

```ts
export type VisiblePlotsSet = "ohlcv" | "ohlc" | "c";
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/VisiblePlotsSet


---

<!-- Public documentation export; not library implementation source. -->
# VisiblePriceRange

[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.

## from {#from}

```ts
from: number;
```

Use the type signature above and the integration guide for the owning capability.

## to {#to}

```ts
to: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/VisiblePriceRange


---

<!-- Public documentation export; not library implementation source. -->
# VisibleTimeRange

[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.

## from {#from}

```ts
from: number;
```

Use the type signature above and the integration guide for the owning capability.

## to {#to}

```ts
to: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/VisibleTimeRange


---

<!-- Public documentation export; not library implementation source. -->
# WatchedValueCallback

[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.

```ts
export type WatchedValueCallback<T> = (value: T) => void;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchedValueCallback


---

<!-- Public documentation export; not library implementation source. -->
# WatchedValueSubscribeOptions

[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.

## once {#once}

```ts
once?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

## callWithLast {#callwithlast}

```ts
callWithLast?: boolean;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchedValueSubscribeOptions


---

<!-- Public documentation export; not library implementation source. -->
# WatchListSymbolList

[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.

## Extends

[WatchListSymbolListData](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListData)

## id {#id}

```ts
id: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [WatchListSymbolListData](https://docs.lumencharts.com/charting-library/api/WatchListSymbolListData)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchListSymbolList


---

<!-- Public documentation export; not library implementation source. -->
# WatchListSymbolListAddedCallback

[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.

```ts
export type WatchListSymbolListAddedCallback = (
  listId: string,
  symbols: string[],
) => void;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchListSymbolListAddedCallback


---

<!-- Public documentation export; not library implementation source. -->
# WatchListSymbolListChangedCallback

[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.

```ts
export type WatchListSymbolListChangedCallback = (listId: string) => void;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchListSymbolListChangedCallback


---

<!-- Public documentation export; not library implementation source. -->
# WatchListSymbolListData

[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.

## symbols {#symbols}

```ts
symbols: string[];
```

Use the type signature above and the integration guide for the owning capability.

## title {#title}

```ts
title: string;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchListSymbolListData


---

<!-- Public documentation export; not library implementation source. -->
# WatchListSymbolListMap

[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.

## signature {#signature}

```ts
[listId: string]: WatchListSymbolList;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `listId` | `string` | Yes |

## Related types

- [WatchListSymbolList](https://docs.lumencharts.com/charting-library/api/WatchListSymbolList)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchListSymbolListMap


---

<!-- Public documentation export; not library implementation source. -->
# WatchListSymbolListRemovedCallback

[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.

```ts
export type WatchListSymbolListRemovedCallback = (listId: string) => void;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRemovedCallback


---

<!-- Public documentation export; not library implementation source. -->
# WatchListSymbolListRenamedCallback

[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.

```ts
export type WatchListSymbolListRenamedCallback = (
  listId: string,
  oldName: string,
  newName: string,
) => void;
```

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatchListSymbolListRenamedCallback


---

<!-- Public documentation export; not library implementation source. -->
# WatermarkContentData

[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.

## symbolInfo {#symbolinfo}

```ts
symbolInfo: LibrarySymbolInfo;
```

Use the type signature above and the integration guide for the owning capability.

## interval {#interval}

```ts
interval: string;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [LibrarySymbolInfo](https://docs.lumencharts.com/charting-library/api/LibrarySymbolInfo)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatermarkContentData


---

<!-- Public documentation export; not library implementation source. -->
# WatermarkContentProvider

[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.

```ts
export type WatermarkContentProvider = (
  data: WatermarkContentData,
) => WatermarkLine[] | null;
```

## Related types

- [WatermarkContentData](https://docs.lumencharts.com/charting-library/api/WatermarkContentData)
- [WatermarkLine](https://docs.lumencharts.com/charting-library/api/WatermarkLine)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatermarkContentProvider


---

<!-- Public documentation export; not library implementation source. -->
# WatermarkLine

[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.

## text {#text}

```ts
text: string;
```

Use the type signature above and the integration guide for the owning capability.

## fontSize {#fontsize}

```ts
fontSize: number;
```

Use the type signature above and the integration guide for the owning capability.

## lineHeight {#lineheight}

```ts
lineHeight: number;
```

Use the type signature above and the integration guide for the owning capability.

## vertOffset {#vertoffset}

```ts
vertOffset: number;
```

Use the type signature above and the integration guide for the owning capability.

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WatermarkLine


---

<!-- Public documentation export; not library implementation source. -->
# WidgetOverrides

[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.

```ts
export type WidgetOverrides = DrawingOverrides & {
  "tradingProperties.positionPL.visibility": boolean;
  "tradingProperties.positionPL.display": PlDisplay;
  [key: string]: string | number | boolean;
};
```

## Related types

- [DrawingOverrides](https://docs.lumencharts.com/charting-library/api/DrawingOverrides)
- [PlDisplay](https://docs.lumencharts.com/charting-library/api/PlDisplay)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/WidgetOverrides