ChartState

Documentation / @elitechart/elitechart / ChartState

Defined in: elitechart/src/lib/store/useChartStore.ts:26

Shape of the chart-side zustand store. Read via the useChartStore hook; every field is reactive in React.

Example

code

import { useChartStore } from '@elitechart/elitechart';
function MySymbolBadge() {
  const symbol = useChartStore((s) => s.symbol);
  return <span>{symbol}</span>;
}

Properties

kind

code

readonly kind: SeriesKind;

Defined in: elitechart/src/lib/store/useChartStore.ts:29

symbol

code

readonly symbol: string;

Defined in: elitechart/src/lib/store/useChartStore.ts:27

timeframe

code

readonly timeframe: Timeframe;

Defined in: elitechart/src/lib/store/useChartStore.ts:28

Methods

setKind()

code

setKind(k): void;

Defined in: elitechart/src/lib/store/useChartStore.ts:32

Parameters

k

SeriesKind

Returns

void

setSymbol()

code

setSymbol(s): void;

Defined in: elitechart/src/lib/store/useChartStore.ts:30

Parameters

s

string

Returns

void

setTimeframe()

code

setTimeframe(t): void;

Defined in: elitechart/src/lib/store/useChartStore.ts:31

Parameters

t

Timeframe

Returns

void