Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

RenderPassData contains properties which are passed to BaseRenderableSeries at the time of drawing

Hierarchy

Index

Constructors

constructor

  • Creates an instance of RenderPassData

    Parameters

    • indexRange: NumberRange | undefined

      The min and max index to data-range currently visible on the SciChartSurface

    • getxCoordinateCalculator: () => CoordinateCalculatorBase

      A function to get the XAxis Coordinate Calculator, used to transform between pixel and data-coordinates

    • getyCoordinateCalculator: () => CoordinateCalculatorBase

      A function to get the YAxis Coordinate Calculator, used to transform between pixel and data-coordinates

    • isVerticalChart: boolean

      A flag indicating if the chart is currently vertically arranged (XAxis on the left, YAxis on the top/bottom)

    • Optional pointSeries: IPointSeries

      The point series

    • Optional resamplingHash: number

      The resampling hash value, used for caching

    • Optional visibleIndices: Int32Array

      When set, the authoritative list of data/storage row indices to process this pass. Label generation iterates this list instead of the contiguous indexRange window. Used by permuted views (e.g. a grid after a sort/filter) where the visible rows are non-contiguous in storage, so a single indexRange cannot express them. Undefined for the normal contiguous-window case (behaviour unchanged).

    Returns RenderPassData

Properties

Readonly getxCoordinateCalculator

getxCoordinateCalculator: () => CoordinateCalculatorBase

A function to get the XAxis Coordinate Calculator, used to transform between pixel and data-coordinates

Type declaration

Readonly getyCoordinateCalculator

getyCoordinateCalculator: () => CoordinateCalculatorBase

A function to get the YAxis Coordinate Calculator, used to transform between pixel and data-coordinates

Type declaration

Readonly indexRange

indexRange: NumberRange | undefined

The min and max index to data-range currently visible on the SciChartSurface

Readonly isVerticalChart

isVerticalChart: boolean

A flag indicating if the chart is currently vertically arranged (XAxis on the left, YAxis on the top/bottom)

Optional Readonly pointSeries

pointSeries: IPointSeries

The point series

Optional Readonly resamplingHash

resamplingHash: number

The resampling hash value, used for caching

Optional Readonly visibleIndices

visibleIndices: Int32Array

When set, the authoritative list of data/storage row indices to process this pass. Label generation iterates this list instead of the contiguous indexRange window. Used by permuted views (e.g. a grid after a sort/filter) where the visible rows are non-contiguous in storage, so a single indexRange cannot express them. Undefined for the normal contiguous-window case (behaviour unchanged).

Accessors

xCoordinateCalculator

yCoordinateCalculator

Generated using TypeDoc