Configuration HDBPP Live Widget

The widget’s configuration schema is defined in src/index.ts. Options and defaults:

  • Tango attributes:

    • Key: attributes

    • Type: string[]

    • Purpose: Fully-qualified attribute names to visualize. One per line.

    • Default: example TPM temperatures in defaultCfg.

  • Use Live Data (subscribe):

    • Key: useLiveData

    • Type: boolean

    • Purpose: When true, subscribe to new values; when false, fetch periodically.

    • Default: false

  • Heatmap mode:

    • Key: useHeatmap

    • Type: boolean

    • Purpose: If true, render attributes vs time as a heatmap.

    • Default: false

  • Heatmap connect gaps:

    • Key: heatmapConnectGaps

    • Type: boolean

    • Purpose: Forward-fill values on an even time grid to keep cells connected; turn off to surface missing timestamps as holes.

    • Default: false

  • Legend position:

    • Key: legendPosition

    • Type: 'left'|'right'|'top'|'bottom'

    • Default: "bottom"

  • Color map position:

    • Key: colorMapPosition

    • Type: 'left'|'right'|'top'|'bottom'|'none'

    • Purpose: Heatmap color bar placement, or hide it entirely.

    • Default: "right"

  • Max points per trace:

    • Key: maxPoints

    • Type: integer

    • Default: 1000

  • Downsample:

    • Key: downsample

    • Type: 'minmax'|'avg'|'lttb'|'none'

    • Purpose: Server-side reduction for history windows.

    • Default: "minmax"

  • Enum display:

    • Key: enumDisplay

    • Type: 'value'|'label'

    • Purpose: For enum attributes, choose integer values or resolved enum labels in the chart display/hover.

    • Default: "value"

  • Append interval (s):

    • Key: appendInterval

    • Type: integer

    • Purpose: 0 = every packet; N > 0 = throttle to every N seconds.

    • Default: 0

  • Show legend:

    • Key: showLegend

    • Type: boolean

    • Default: true

  • Custom margins:

    • Key: customMargins

    • Type: string

    • Example: "t:60,r:20,b:50,l:70"

  • Color scheme:

    • Key: colorScheme

    • Type: palette id exported by @ska-octopus-widget-sdk/widget-sdk (e.g., scientificActon10, tableau10)

    • Purpose: Drives both line colors and heatmap gradients using the shared SDK palettes.

    • Default: the Acton scientific palette (scientificActon10)

  • Legend label format:

    • Key: legendFormat

    • Type: string

    • Purpose: Controls legend labels (e.g., fullname, lastname, station/{number}).

    • Default: "lastname"

  • Plot title:

    • Key: plotTitle

    • Type: string

    • Default: ""