Skip to main content

types.EntityLabel#

Persistent text label entity at a data coordinate.

SYNTAX#

interface EntityLabel { kind: 'label'; key: string; x: number; y: number; text: string; color: string; bg?: string; align?: 'left' | 'center' | 'right'; forceOverlay?: boolean; }

ARGUMENTS#

  • kind ('label') — Discriminator.
  • key (string) — Persistent identifier.
  • x (number) — Timestamp in unix seconds.
  • y (number) — Price.
  • text (string) — Displayed text.
  • color (string) — Text color.
  • bg (string) — Optional background color.
  • align (string) — left | center | right. Default center.
  • forceOverlay (boolean) — When true, render on the price pane regardless of indicator pane.

RETURNS#

Type definition.

EXAMPLE#

{ kind: 'label', key: 'last-price', x: 1700100000, y: 50100, text: 'Last: 50100', color: '#fff', bg: '#26a69a', align: 'left' }

SEE ALSO#

indicator.entity.label, types.EntityMarker