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:772

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:824

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

bullishCloudColor?​

optional bullishCloudColor?: string | number;

Source: types/src/index.ts:822

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

chikouColor?​

optional chikouColor?: string | number;

Source: types/src/index.ts:813

Chikou span color. Default teal.

chikouVisible?​

optional chikouVisible?: boolean;

Source: types/src/index.ts:817

Draw the Chikou span. Default true.

chikouWidth?​

optional chikouWidth?: number;

Source: types/src/index.ts:815

Chikou span stroke width in px. Default 1.

cloudOpacity?​

optional cloudOpacity?: number;

Source: types/src/index.ts:826

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

cloudVisible?​

optional cloudVisible?: boolean;

Source: types/src/index.ts:820

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

displacement?​

optional displacement?: number;

Source: types/src/index.ts:786

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:774

Draw the indicator. Default false.

kijunColor?​

optional kijunColor?: string | number;

Source: types/src/index.ts:795

Kijun-sen color. Default red.

kijunPeriod?​

optional kijunPeriod?: number;

Source: types/src/index.ts:778

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

kijunVisible?​

optional kijunVisible?: boolean;

Source: types/src/index.ts:799

Draw the Kijun-sen. Default true.

kijunWidth?​

optional kijunWidth?: number;

Source: types/src/index.ts:797

Kijun-sen stroke width in px. Default 1.

senkouAColor?​

optional senkouAColor?: string | number;

Source: types/src/index.ts:801

Senkou Span A color. Default green.

senkouAVisible?​

optional senkouAVisible?: boolean;

Source: types/src/index.ts:805

Draw the Senkou Span A edge. Default true.

senkouAWidth?​

optional senkouAWidth?: number;

Source: types/src/index.ts:803

Senkou Span A stroke width in px. Default 1.

senkouBColor?​

optional senkouBColor?: string | number;

Source: types/src/index.ts:807

Senkou Span B color. Default orange.

senkouBPeriod?​

optional senkouBPeriod?: number;

Source: types/src/index.ts:780

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

senkouBVisible?​

optional senkouBVisible?: boolean;

Source: types/src/index.ts:811

Draw the Senkou Span B edge. Default true.

senkouBWidth?​

optional senkouBWidth?: number;

Source: types/src/index.ts:809

Senkou Span B stroke width in px. Default 1.

tenkanColor?​

optional tenkanColor?: string | number;

Source: types/src/index.ts:789

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

tenkanPeriod?​

optional tenkanPeriod?: number;

Source: types/src/index.ts:776

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

tenkanVisible?​

optional tenkanVisible?: boolean;

Source: types/src/index.ts:793

Draw the Tenkan-sen. Default true.

tenkanWidth?​

optional tenkanWidth?: number;

Source: types/src/index.ts:791

Tenkan-sen stroke width in px. Default 1.