UniformHeatmapHitTestProvider | API Documentation for SciChart.js

Hit-test provider for UniformHeatmapRenderableSeries. See base class BaseHitTestProvider for further info

Hierarchy

BaseHitTestProvider<UniformHeatmapRenderableSeries>
- UniformHeatmapHitTestProvider

Implements

IHitTestProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UniformHeatmapHitTestProvider(parentSeries: UniformHeatmapRenderableSeries, wasmContext: TSciChart): UniformHeatmapHitTestProvider

Inherited from OhlcSeriesHitTestProvider.constructor
- Defined in src/Charting/Visuals/RenderableSeries/HitTest/BaseHitTestProvider.ts
Creates an instance of the BaseHitTestProvider

Parameters
- parentSeries: UniformHeatmapRenderableSeries
  
  the parent RenderableSeries that this Hit-Test provider is attached to
- wasmContext: TSciChart
  
  the SciChart WebAssembly Context containing native methods and access to our WebGL2 WebAssembly Drawing Engine
Returns UniformHeatmapHitTestProvider

Properties

Protected currentRenderPassData

currentRenderPassData: RenderPassData

Readonly parentSeries

parentSeries: UniformHeatmapRenderableSeries

Protected webAssemblyContext

webAssemblyContext: TSciChart

Static Readonly DEFAULT_HIT_TEST_RADIUS

DEFAULT_HIT_TEST_RADIUS: number = 7.07

Methods

Protected getTranslatedHitTestPoint

getTranslatedHitTestPoint(x: number, y: number): Point

Inherited from OhlcSeriesHitTestProvider.getTranslatedHitTestPoint
- Defined in src/Charting/Visuals/RenderableSeries/HitTest/BaseHitTestProvider.ts
Parameters
- x: number
- y: number
Returns Point

hitTest

hitTest(x: number, y: number): HitTestInfo

Overrides BaseHitTestProvider.hitTest
- Defined in src/Charting/Visuals/RenderableSeries/HitTest/UniformHeatmapHitTestProvider.ts
inheritdoc

Parameters
- x: number
- y: number
Returns HitTestInfo

hitTestDataPoint

hitTestDataPoint(x: number, y: number): HitTestInfo

Overrides OhlcSeriesHitTestProvider.hitTestDataPoint
- Defined in src/Charting/Visuals/RenderableSeries/HitTest/UniformHeatmapHitTestProvider.ts
inheritdoc

Parameters
- x: number
- y: number
Returns HitTestInfo

hitTestForDataPointSelectionModifier

hitTestForDataPointSelectionModifier(x: number, y: number, hitTestRadius?: number): HitTestInfo

Implementation of IHitTestProvider.hitTestForDataPointSelectionModifier

Inherited from BaseHitTestProvider.hitTestForDataPointSelectionModifier
- Defined in src/Charting/Visuals/RenderableSeries/HitTest/BaseHitTestProvider.ts
description

Performs a hit-test for the DataPointSelectionModifier. This calls IHitTestProvider.hitTestDataPoint by default. The hitTestProvider for the renderableSeries can override this if different behaviour is desired, eg for columSeries we call hitTest instead. returns a HitTestInfo type with the results, Only for sorted values

remarks

For Retina displays and Browser zoom, ensure that X,Y points are scaled by DpiHelper.PIXEL_RATIO

Parameters
- x: number
  
  The mouse point X coordinate on the parent SciChartSurface. NOTE: For Retina displays and Browser zoom, ensure that X,Y points are scaled by DpiHelper.PIXEL_RATIO
- y: number
  
  The mouse point Y coordinate on the parent SciChartSurface. NOTE: For Retina displays and Browser zoom, ensure that X,Y points are scaled by DpiHelper.PIXEL_RATIO
- Default value hitTestRadius: number = BaseHitTestProvider.DEFAULT_HIT_TEST_RADIUS
  
  The radius in pixels to determine whether a mouse is over a data-point
Returns HitTestInfo

hitTestXSlice

hitTestXSlice(x: number, y: number): HitTestInfo

Overrides BaseHitTestProvider.hitTestXSlice
- Defined in src/Charting/Visuals/RenderableSeries/HitTest/UniformHeatmapHitTestProvider.ts
inheritdoc

Parameters
- x: number
- y: number
Returns HitTestInfo

update

update(renderPassData: RenderPassData): void

Implementation of IHitTestProvider.update

Inherited from OhlcSeriesHitTestProvider.update
- Defined in src/Charting/Visuals/RenderableSeries/HitTest/BaseHitTestProvider.ts
description

updates the current HitTestProvider with the latest renderPassData

Parameters
- renderPassData: RenderPassData
  
  the latest renderPassData from the parent series last draw operation
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

parentSeries: UniformHeatmapRenderableSeries

wasmContext: TSciChart

Returns UniformHeatmapHitTestProvider

Properties

Protected currentRenderPassData

Readonly parentSeries

Protected webAssemblyContext

Static Readonly DEFAULT_HIT_TEST_RADIUS

Methods

Protected getTranslatedHitTestPoint

Parameters

x: number

y: number

Returns Point

hitTest

Parameters

x: number

y: number

Returns HitTestInfo

hitTestDataPoint

Parameters

x: number

y: number

Returns HitTestInfo

hitTestForDataPointSelectionModifier

Parameters

x: number

y: number

Default value hitTestRadius: number = BaseHitTestProvider.DEFAULT_HIT_TEST_RADIUS

Returns HitTestInfo

hitTestXSlice

Parameters

x: number

y: number

Returns HitTestInfo

update

Parameters

renderPassData: RenderPassData

Returns void