Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OhlcSeriesHitTestProvider

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected currentRenderPassData

currentRenderPassData: RenderPassData

Readonly parentSeries

parentSeries: BaseOhlcRenderableSeries

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

hitTest

  • hitTest(x: number, y: number, hitTestRadius?: number): HitTestInfo
  • description

    Performs a hit-test for series body at the specific mouse point (X,Y coordinate on the parent SciChartSurface), returning a HitTestInfo type with the results

    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 = 0

      The radius in pixels to determine whether a mouse is over a data-point

    Returns HitTestInfo

hitTestDataPoint

  • hitTestDataPoint(x: number, y: number, hitTestRadius?: number): HitTestInfo
  • description

    Performs a hit-test for the data point at the specific mouse point (X,Y coordinate on the parent SciChartSurface), returning a HitTestInfo type with the results

    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

hitTestForDataPointSelectionModifier

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

hitTestXSlice

update

  • description

    updates the current HitTestProvider with the latest renderPassData

    Parameters

    • renderPassData: RenderPassData

      the latest renderPassData from the parent series last draw operation

    Returns void

Generated using TypeDoc