types.EntityBox#
Persistent rectangular box entity in data coordinates.
SYNTAX#
interface EntityBox { kind: 'box'; key: string; x1: number; y1: number; x2: number; y2: number; fill: string; border?: string; borderWidth?: number; forceOverlay?: boolean; }ARGUMENTS#
kind('box') — Discriminator.key(string) — Persistent identifier.x1(number) — Top-left timestamp (unix seconds).y1(number) — Top-left price.x2(number) — Bottom-right timestamp.y2(number) — Bottom-right price.fill(string) — CSS color (use rgba for transparency).border(string) — Optional border color.borderWidth(number) — Optional border width in pixels.forceOverlay(boolean) — When true, render on the price pane regardless of indicator pane.
RETURNS#
Type definition.
EXAMPLE#
{ kind: 'box', key: 'value-area', x1: 1700000000, y1: 51000, x2: 1700100000, y2: 49000, fill: 'rgba(38,166,154,0.15)', border: '#26a69a' }