Skip to main content

types.EntityMarker#

Persistent marker entity at a data coordinate.

SYNTAX#

interface EntityMarker { kind: 'marker'; key: string; x: number; y: number; shape: 'circle' | 'square' | 'triangle' | 'triangle-down' | 'diamond' | 'cross' | 'x'; color: string; size?: number; forceOverlay?: boolean; }

ARGUMENTS#

  • kind ('marker') — Discriminator.
  • key (string) — Persistent identifier.
  • x (number) — Timestamp in unix seconds.
  • y (number) — Price.
  • shape (string) — One of the seven marker glyphs.
  • color (string) — Glyph color.
  • size (number) — Optional pixel size.
  • forceOverlay (boolean) — When true, render on the price pane regardless of indicator pane.

RETURNS#

Type definition.

EXAMPLE#

{ kind: 'marker', key: 'spike-1700100000', x: 1700100000, y: 50300, shape: 'triangle', color: '#26a69a', size: 10 }

SEE ALSO#

indicator.entity.marker, types.EntityLine