IPolarCursorModifierOptions | API Documentation for SciChart.js

Optional parameters used to configure a PolarCursorModifier at construct time

Hierarchy

IChartModifierBaseOptions
- IPolarCursorModifierOptions

Index

Properties

Optional angularAxisLabelPlacement

angularAxisLabelPlacement: EAngularAxisLabelPlacement

Sets angular axis label placement

Optional axisLabelFill

axisLabelFill: string

Sets both axes label fill as an HTML Color code.

Optional axisLabelStroke

axisLabelStroke: string

Sets both axes label text color as an HTML Color code

Optional excludedSeriesIds

excludedSeriesIds: string[]

A list of renderable series to exclude from this modifier

remarks: Also see ChartModifierBase2D.includedSeries which has methods to include or exclude a series by instance

Optional excludedXAxisIds

excludedXAxisIds: string[]

A list of X axes to exclude from this modifier

remarks: Also see ChartModifierBase2D.includedXAxes which has methods to include or exclude an axis by instance

Optional excludedYAxisIds

excludedYAxisIds: string[]

A list of Y axes to exclude from this modifier

remarks: Also see ChartModifierBase2D.includedYAxes which has methods to include or exclude an axis by instance

Optional executeCondition

executeCondition: TModifierExecuteCondition

The primary action execute condition that modifier should respond to

Optional hitTestRadius

hitTestRadius: number

If this is set greater than the default of zero, the tooltip 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 includedSeriesIds

includedSeriesIds: string[]

A list of renderable series to include to this modifier

remarks: Also see ChartModifierBase2D.includedSeries which has methods to include or exclude a series by instance

Optional includedXAxisIds

includedXAxisIds: string[]

A list of X axes to include to this modifier

remarks: Also see ChartModifierBase2D.includedXAxes which has methods to include or exclude an axis by instance

Optional includedYAxisIds

includedYAxisIds: string[]

A list of Y axes to include this modifier

remarks: Also see ChartModifierBase2D.includedYAxes which has methods to include or exclude an axis by instance

Optional lineColor

lineColor: string

Sets the crosshair stroke color as an HTML Color code

Optional lineDashArray

lineDashArray: number[]

Sets the crosshair line dash array

Optional lineThickness

lineThickness: number

Sets the crosshair line stroke thickness

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 radialAxisLabelPlacement

radialAxisLabelPlacement: ERadialAxisLabelPlacement

Sets radial axis label placement

Optional secondaryExecuteCondition

secondaryExecuteCondition: TModifierExecuteCondition

The secondary action execute condition that modifier should respond to

Optional showAxisLabels

showAxisLabels: boolean

Sets whether we should display axis labels. Default is true

Optional showCircularLine

showCircularLine: boolean

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

Optional showRadialLine

showRadialLine: boolean

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

Optional showTooltip

showTooltip: boolean

Sets whether we should display the tooltip. Default is false

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