Options
All
  • Public
  • Public/Protected
  • All
Menu

The HitTestInfo class contains properties about the data-point under the mouse when a Hit-Test operation is performed

Hierarchy

  • HitTestInfo

Index

Constructors

constructor

  • Parameters

    Returns HitTestInfo

Properties

Readonly associatedSeries

associatedSeries: IRenderableSeries

Gets the associated series that this HitTestInfo was generated by

closeValue

closeValue: number

OHLC Series only: the Close-value result of the hit-test operation

dataSeriesIndex

dataSeriesIndex: number

The index of the data-series that was hit

dataSeriesName

dataSeriesName: string

The name of the DataSeries which is the result of the hit-test operation

dataSeriesType

dataSeriesType: EDataSeriesType

The type EDataSeriesType of the DataSeries which is the result of the hit-test operation

heatmapValue

heatmapValue: number

Gets or sets the value at the hit-test site, found at heatmapXIndex, heatmapYIndex

heatmapXIndex

heatmapXIndex: number

Gets or sets the XIndex at the hit-test site

heatmapYIndex

heatmapYIndex: number

Gets or sets the YIndex at the hit-test site

highValue

highValue: number

OHLC Series only: the High-value result of the hit-test operation

hitTestPoint

hitTestPoint: Point

A screen-coordinate point where hit test is performed relative to the seriesViewRect and premultiplied by DpiHelper.PIXEL_RATIO

hitTestPointValues

hitTestPointValues: Point

A data-coordinate point where hit test is performed

hitTestRadius

hitTestRadius: number

The radius in pixels that was used for the hit-test operation

isCategoryAxis

isCategoryAxis: boolean

When true, the parent SciChartSurface xAxis is a Category Axis

Readonly isEmpty

isEmpty: boolean

When true, the HitTestInfo is empty

isHit

isHit: boolean

When true, the hit-test operation was a success For the hitTest method it means that a series body was hit, Line body for line series Scatter point for scatter series Mountain area for mountain series and stacked mountain series Candlestick body for candle series Column body for column series and stacked column series Band series body for band series Bubble for bubble series The entire heatmap for heatmap series For the hitTestDataPoint method it means that a data point was hit For the hitTestXSlice method is means that the click was within data bounds

isWithinDataBounds

isWithinDataBounds: boolean

When true the hit-test operation was within the first and the last DataSeries X-values

lowValue

lowValue: number

OHLC Series only: the Low-value result of the hit-test operation

metadata

metadata: IPointMetadata

The point metadata from the associated data series, which is useful for displaying tooltips with additional information specific for the data point

openValue

openValue: number

OHLC Series only: the Open-value result of the hit-test operation

point2dataSeriesIndex

point2dataSeriesIndex: number

The index of the second data-series point when hit-test is performed for the series body

point2xCoord

point2xCoord: number

The X-coordinate result of the hit-test operation for the second data point, Y-coordinate for vertical chart

point2xValue

point2xValue: number

The X-value of category result of the hit-test operation for the second data point

point2yCoord

point2yCoord: number

The Y-coordinate result of the hit-test operation for the second data point, X-coordinate for vertical chart

point2yValue

point2yValue: number

The Y-value result of the hit-test operation for the second data point

xCategoryValue

xCategoryValue: number

The X-value of category result of the hit-test operation

xCoord

xCoord: number

The X-coordinate result of the hit-test operation, Y-coordinate for vertical chart

xValue

xValue: number

The X-value result of the hit-test operation

y1Coord

y1Coord: number

The Y1-coordinate result of the hit-test operation

y1Value

y1Value: number

XYY Series only: the Y1-value result of the hit-test operation

yCoord

yCoord: number

The Y-coordinate result of the hit-test operation, X-coordinate for vertical chart

yValue

yValue: number

The Y-value result of the hit-test operation

zValue

zValue: number

XYZ Series only: the Z-value result of the hit-test operation

Methods

Static empty

  • The default empty HitTestInfo instance

    Returns HitTestInfo

Generated using TypeDoc