Function trackerControlInstance

trackerControlInstance(
    chartId: number,
    container: SVGSVGElement,
    svg: SvgSelection,
    plotDimensions: Dimensions,
    margin: Margin,
    style: TrackerStyle,
    labelFont: TrackerLabelFont,
    label: Map<ContinuousNumericAxis, (x: number) => string>,
    labelStyle: TrackerLabelLocation,
    onTrackerUpdate: (update: TrackerAxisUpdate) => void,
    axisLocation?: AxisLocation,
    backgroundColor: string,
): TrackerSelection
Creates or returns the existing SVG elements for displaying a tracker line that is either vertical (for x-axes) or horizontal (for y-axes).
Parameters
- chartId: number
  The ID of the chart
- container: SVGSVGElement
  The SVG container
- svg: SvgSelection
  The SVG selection
- plotDimensions: Dimensions
  The dimensions of the plot
- margin: Margin
  The margins around the plot
- style: TrackerStyle
  The tracker style
- labelFont: TrackerLabelFont
  The font used for the axis labels
- label: Map<ContinuousNumericAxis, (x: number) => string>
  A function that returns the tracker label string for a given x-value
- labelStyle: TrackerLabelLocation
  The location style for the tracker (i.e. on the axes, next to the mouse, none shown)
- onTrackerUpdate: (update: TrackerAxisUpdate) => void
  A callback function that accepts the current tracker's axis information
- OptionalaxisLocation: AxisLocation = AxisLocation.Bottom
  The optional location of the axis for which the tracker is to be shown. Default is bottom.
- backgroundColor: string
  The background color of the tracker label
Returns TrackerSelection
The tracker selection
- Defined in app/charts/trackers/trackerUtils.ts:96

Function trackerControlInstance

Parameters

Returns TrackerSelection

Settings