Class: SignalIQ

SignalIQ

SignalIQ signal generation module. SignalIQ is a module that compares study outputs to predetermined trigger conditions. If the study output matches a trigger condition, an interactive marker is drawn on the chart. Signal trigger levels and appearance are configured by the CompactChart configuration Config.

Since:

  • 9.4.0

Type Definitions

SignalCondition

Structure of signal condition.

Type:
  • Array
Properties:
Index Type Description
0 string

Field of study output to use as left hand side of condition expression(s)
1 string

Operator to use on the field(s). The following are supported:

  • "<" (lhs < rhs)
  • "<=" (lhs <= rhs)
  • "=" (lhs = rhs)
  • ">" (lhs > rhs)
  • ">=" (lhs >= rhs)
  • "<>" (lhs <> rhs)
  • ">p" (greater than previous)
  • "<p" (less than previous)
  • "=p" (same as previous)
  • "x" (crosses another plot/value in either direction)
  • "x+" (crosses another plot/value upwards"
  • "x-" (crosses another plot/value downwards"
  • "t+" (turns upwards"
  • "t-" (turns downwards"
2 string | number | null

Field of study output to use as right hand side of condition expression(s), if necessary. Set to a number for comparison to a constant value, or null if operator does not need two operands.
3 string | null

Color of the signal. If not provided, field's color will be used. The color can be either a literal CSS color, or a variable beginning with an asterisk (*), which matches up to the corresponding variable in the themes' signalIQ/colorMap setting. That way, colors can be customized by theme.
4 SignalMarkerSettings

Optional settings for marker. When multiple conditions match, markerOptions from the first matching condition are applied.
Since:

  • 9.4.0

SignalDataConfig

Configuration of the actual signal trigger. This is done through one or more conditions.

Type:
  • object
Properties:
Name Type Argument Description
name string <optional>

Name of signal, will appear as headline of marker.
reveal boolean <optional>

Reflects current visibility of the marker expansion.
conditions Array.<SignalCondition> <optional>

One or more conditions that need to match for signal to be generated.
joiner '&' | '|' <optional>

Whether the conditions are "any" or "all". Default is "any".
description string <optional>

Optional description to show in body of marker expansion.
Since:

  • 9.4.0

SignalIQConfig

SignalIQ configuration settings.

Type:
Properties:
Name Type Argument Description
colorMap Record.<string, (string|undefined)> <optional>

Map of keys to colors. Keys correspond to signal conditions. This map omits the asterisks. See sample config.js for example.
Since:

  • 9.4.0

SignalMarkerSettings

Optional settings for signal marker.

Type:
  • object
Properties:
Name Type Argument Default Description
shape 'square' | 'circle' | 'diamond' | 'text' | 'noshape' <optional>
 'circle'

Shape of marker.
size 'S' | 'M' | 'L' <optional>
 'S'

Size of marker.
position YPositioner <optional>
 'top'

Where to place the marker.
color string <optional>

Color of marker, can get overridden by color in SignalDataConfig.
description string <optional>

Optional description to show in body of marker expansion, overrides the property in SignalDataConfig.
label string <optional>

Label to draw on marker (usually this is one character).
Since:

  • 9.4.0