Module trackerUtils

Index

Interfaces

Variables

Functions

Variables

defaultTrackerLabelFont

defaultTrackerLabelFont: TrackerLabelFont = ...

defaultTrackerStyle

defaultTrackerStyle: TrackerStyle = ...

Functions

removeTrackerControl

removeTrackerControl(svg: SvgSelection): void

- Defined in trackerUtils.ts:106
Removes the tracker control from the chart

Parameters
- svg: SvgSelection
  
  The svg selection holding the tracker contol
Returns void

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): TrackerSelection

- Defined in trackerUtils.ts:51
Creates or returns the existing SVG elements for displaying a tracker line

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 the accepts the current tracker's axis information
  - - (update: TrackerAxisUpdate): void
    - Parameters
      - update: TrackerAxisUpdate
      Returns void
Returns TrackerSelection
The tracker selection

Generated using TypeDoc