Options
All
  • Public
  • Public/Protected
  • All
Menu

Optional parameters used to configure a CursorModifier at construct time

Hierarchy

Index

Properties

Optional axisLabelFill

axisLabelFill: string

Sets both axis label fill as an HTML Color code.

Optional axisLabelStroke

axisLabelStroke: string

Sets both axis label text color as an HTML Color code

Optional crosshairStroke

crosshairStroke: string

Sets the crosshair stroke color as an HTML Color code

Optional crosshairStrokeDashArray

crosshairStrokeDashArray: number[]

Sets the crosshair line dash array

Optional crosshairStrokeThickness

crosshairStrokeThickness: number

Sets the crosshair line strokethickness

Optional executeOn

executeOn: EExecuteOn

Defines the operation that modifier should respond to

Optional hitTestRadius

hitTestRadius: number

If this is set greater than the default of zero, the toolip will only show values for points in this radius, rather than all points on the vertical line

Optional id

id: string

A unique Id for the ChartModifierBase2D

Optional modifierGroup

modifierGroup: string

Defines the Modifier Group string - a grouping by ID for sharing mouse events across charts

Optional placementDivId

placementDivId: string

Sets the parent div element reference or id for the Tooltip

Optional showAxisLabels

showAxisLabels: boolean

Sets whether we should display axis labels. Default is true

Optional showTooltip

showTooltip: boolean

Sets whether we should display the tooltip. Default is false

Optional showXLine

showXLine: boolean

Sets whether we should display the X Line. Default is true

Optional showYLine

showYLine: boolean

Sets whether we should display the Y Line. Default is true

Optional tooltipContainerBackground

tooltipContainerBackground: string

Sets the tooltip container background color as an HTML Color code

Optional tooltipDataTemplate

tooltipDataTemplate: TCursorTooltipDataTemplate | string

Sets the tooltipDataTemplate, which allows to customize content for the tooltip

Optional tooltipLegendOffsetX

tooltipLegendOffsetX: number

Sets the legend X offset

Optional tooltipLegendOffsetY

tooltipLegendOffsetY: number

Sets the legend Y offset

Optional tooltipLegendTemplate

tooltipLegendTemplate: TCursorTooltipSvgTemplate | string

Sets the template for the legend

Optional tooltipShadow

tooltipShadow: string

Sets the tooltip shadow color as an HTML Color code

Optional tooltipSvgTemplate

tooltipSvgTemplate: TCursorTooltipSvgTemplate | string

Set a function which generates the svg for the entire tooltip. Note that the repositioning of the tooltip to keep it within the chart is normally done in this function. To retain this functionality in your own template function, include the following:

  // valuesWithLabels is the result of the tooltipDataTemplate function, which is the text content of the tooltip as an array of strings
  const { width, height } = calcTooltipSize(valuesWithLabels);
  // this calculates and sets svgAnnotation.xCoordShift and svgAnnotation.yCoordShift.  Do not set x1 or y1 at this point.
  adjustTooltipPosition(width, height, svgAnnotation);

Optional tooltipTextStroke

tooltipTextStroke: string

Sets the tooltip text color as an HTML Color code

Optional xAxisId

xAxisId: string

The XAxis Id to be used by annotations internal to the modifier. Set if you have multiple x axes and need to distinguish between horizontal/vertical, or stacked axes

Optional xAxisLabelFill

xAxisLabelFill: string

Sets the xAxis label fill as an HTML Color code.

Optional xAxisLabelStroke

xAxisLabelStroke: string

Sets the xAxis label text color as an HTML Color code

Optional xyDirection

xyDirection: EXyDirection

Defines the Xy Direction - whether the modifier works in X, Y or XY or neither direction, for vertical charts the behaviour could be inverted, for example for vertical chart with RubberBandXyZoomModifier and EXyDirection.XDirection the modifier works on Y axis

Optional yAxisId

yAxisId: string

The YAxis Id to be used by annotations internal to the modifier. Set if you have multiple y axes and need the modifier to use something other than the first one.

Optional yAxisLabelFill

yAxisLabelFill: string

Sets the yAxis label fill as an HTML Color code.

Optional yAxisLabelStroke

yAxisLabelStroke: string

Sets the yAxis label text color as an HTML Color code

Generated using TypeDoc