Skip to main content

IchimokuConfig

type IchimokuConfig = {
  bearishCloudColor?: string | number;
  bullishCloudColor?: string | number;
  chikouColor?: string | number;
  chikouVisible?: boolean;
  chikouWidth?: number;
  cloudOpacity?: number;
  cloudVisible?: boolean;
  displacement?: number;
  enabled?: boolean;
  kijunColor?: string | number;
  kijunPeriod?: number;
  kijunVisible?: boolean;
  kijunWidth?: number;
  senkouAColor?: string | number;
  senkouAVisible?: boolean;
  senkouAWidth?: number;
  senkouBColor?: string | number;
  senkouBPeriod?: number;
  senkouBVisible?: boolean;
  senkouBWidth?: number;
  tenkanColor?: string | number;
  tenkanPeriod?: number;
  tenkanVisible?: boolean;
  tenkanWidth?: number;
};

Source: types/src/index.ts:615

Ichimoku Kinko Hyo overlay config. Five lines on the price pane plus the cloud (kumo) shaded between the two leading spans. No pane is reserved.

Unlike the other overlays, three of the lines are drawn away from the bar they were computed on:

  • Senkou A and B lead by displacement bars, so the cloud extends past the newest candle into empty time. The chart reserves that space when it frames itself, so the forward cloud is on screen without panning.
  • Chikou lags by displacement bars.

Ichimoku is built on highs and lows rather than a single price series, so it takes no MASource or MAKind.

Like the other price-pane overlays, its values don't feed the automatic y-axis fit — the cloud can run off the top or bottom of the pane on a chart scaled to the candles alone.

Properties​

bearishCloudColor?​

optional bearishCloudColor?: string | number;

Source: types/src/index.ts:667

Cloud fill where Senkou A is below Senkou B. Default red.

bullishCloudColor?​

optional bullishCloudColor?: string | number;

Source: types/src/index.ts:665

Cloud fill where Senkou A is above Senkou B. Default green.

chikouColor?​

optional chikouColor?: string | number;

Source: types/src/index.ts:656

Chikou span color. Default teal.

chikouVisible?​

optional chikouVisible?: boolean;

Source: types/src/index.ts:660

Draw the Chikou span. Default true.

chikouWidth?​

optional chikouWidth?: number;

Source: types/src/index.ts:658

Chikou span stroke width in px. Default 1.

cloudOpacity?​

optional cloudOpacity?: number;

Source: types/src/index.ts:669

Cloud opacity 0..1, applied to whichever cloud color is in play. Default 0.15.

cloudVisible?​

optional cloudVisible?: boolean;

Source: types/src/index.ts:663

Draw the cloud between the two leading spans. Default true.

displacement?​

optional displacement?: number;

Source: types/src/index.ts:629

Bars the cloud leads by and Chikou lags by. Default 26, clamped to >= 0. Changing it only moves what's already drawn — the lines themselves don't recompute.

enabled?​

optional enabled?: boolean;

Source: types/src/index.ts:617

Draw the indicator. Default false.

kijunColor?​

optional kijunColor?: string | number;

Source: types/src/index.ts:638

Kijun-sen color. Default red.

kijunPeriod?​

optional kijunPeriod?: number;

Source: types/src/index.ts:621

Kijun-sen (base) lookback. Default 26, clamped to >= 1.

kijunVisible?​

optional kijunVisible?: boolean;

Source: types/src/index.ts:642

Draw the Kijun-sen. Default true.

kijunWidth?​

optional kijunWidth?: number;

Source: types/src/index.ts:640

Kijun-sen stroke width in px. Default 1.

senkouAColor?​

optional senkouAColor?: string | number;

Source: types/src/index.ts:644

Senkou Span A color. Default green.

senkouAVisible?​

optional senkouAVisible?: boolean;

Source: types/src/index.ts:648

Draw the Senkou Span A edge. Default true.

senkouAWidth?​

optional senkouAWidth?: number;

Source: types/src/index.ts:646

Senkou Span A stroke width in px. Default 1.

senkouBColor?​

optional senkouBColor?: string | number;

Source: types/src/index.ts:650

Senkou Span B color. Default orange.

senkouBPeriod?​

optional senkouBPeriod?: number;

Source: types/src/index.ts:623

Senkou Span B lookback. Default 52, clamped to >= 1.

senkouBVisible?​

optional senkouBVisible?: boolean;

Source: types/src/index.ts:654

Draw the Senkou Span B edge. Default true.

senkouBWidth?​

optional senkouBWidth?: number;

Source: types/src/index.ts:652

Senkou Span B stroke width in px. Default 1.

tenkanColor?​

optional tenkanColor?: string | number;

Source: types/src/index.ts:632

Tenkan-sen color (hex string or packed ARGB number). Default blue.

tenkanPeriod?​

optional tenkanPeriod?: number;

Source: types/src/index.ts:619

Tenkan-sen (conversion) lookback. Default 9, clamped to >= 1.

tenkanVisible?​

optional tenkanVisible?: boolean;

Source: types/src/index.ts:636

Draw the Tenkan-sen. Default true.

tenkanWidth?​

optional tenkanWidth?: number;

Source: types/src/index.ts:634

Tenkan-sen stroke width in px. Default 1.