Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHeatmapSeries

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

Defines the interface to a Heatmap DataSeries in SciChart's High Performance Real-time JavaScript Charts

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly changeCount

changeCount: number

Gets the change count for this data series. Allows to indentify when data series was changed

containsNaN

containsNaN: boolean

Gets or sets whether the Y data contains NaN values. Set containsNaN = false for the performance optimization when the series has no NaNs

dataChanged

dataChanged: EventHandler<IDataChangeArgs>

An EventHandler which is raised when the data changes.

remarks

To subscribe to dataChanged, use the following code:

const dataSeries = new XyDataSeries(wasmContext);
const callback = () => {
   // Data has changed
};
dataSeries.dataChanged.subscribe(callback);

To unsubscribe from dataChanged, use the following code:

const dataSeries = new XyDataSeries(wasmContext);
dataSeries.dataChanged.unsubscribe(callback);

Readonly dataDistributionCalculator

dataDistributionCalculator: IDataDistributionCalculator

Gets the IDataDistributionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm

dataSeriesName

dataSeriesName: string

Gets the DataSeries name. This is used in legend controls and tooltips to identify the series

hasValues

hasValues: boolean

When true, the DataSeries has values, else it is empty

Readonly id

id: string

A unique Id for the IDataSeries

isEvenlySpaced

isEvenlySpaced: boolean

Gets or sets whether the X-values are evenly spaced or not. See remarks at IDataSeries.isEvenlySpaced for further information

remarks

The user must specify this flag (defaults to true) in order to choose the correct, and fastest algorithms for drawing, indexing and ranging. If you experience glitches or strange drawing, it may be because you have set data with uneven spacing in X but not set this flag.

isSorted

isSorted: boolean

Gets or sets whether the X-values are sorted ascending or not. See remarks at IDataSeries.isSorted for further information

remarks

The user must specify this flag (defaults to true) in order to choose the correct, and fastest algorithms for drawing, indexing and ranging. If you experience glitches or strange drawing, it may be because you have set unsorted data but not set this flag.

minXSpacing

minXSpacing: number

Readonly type

type: EDataSeriesType

Gets the EDataSeriesType type of the DataSeries

xRange

xRange: NumberRange

Gets the range in the X-direction for this DataSeries

Methods

clear

  • clear(): void

  • Clear all values from the DataSeries

    Returns void

count

  • count(): number

  • Gets the count of data-points in the DataSeries

    Returns number

delete

  • delete(): void

  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

getIndicesRange

  • Gets the integer indices of the XValues array that are currently in the VisibleRange passed in, and an undefined range otherwise.

    Parameters

    • visibleRange: NumberRange

      The VisibleRange to get the indices range

    • Optional isCategoryData: boolean

      If True the renderable series uses CategoryAxis

    • Optional downSearchMode: ESearchMode

      Specifies the search mode used to look for the index of visibleRange.Min

    • Optional upSearchMode: ESearchMode

      Specifies the search mode used to look for the index of visibleRange.Max

    Returns NumberRange

    numberRange The indices to the X-Data that are currently in range.

getIsDeleted

  • getIsDeleted(): boolean

  • Returns true if this DataSeries has been deleted and native memory destroyed

    Returns boolean

getNativeIndexes

  • getNativeIndexes(): SCRTDoubleVector

  • Gets a native / WebAssembly Vector of Indexes in the DataSeries

    Returns SCRTDoubleVector

getNativeXValues

  • getNativeXValues(): SCRTDoubleVector

  • Gets a native / WebAssembly vector of X-values in the DataSeries

    Returns SCRTDoubleVector

getNativeYValues

  • getNativeYValues(): SCRTDoubleVector

  • Gets a native / WebAssembly vector of Y-values in the DataSeries

    Returns SCRTDoubleVector

getWindowedYRange

getXRange

toJSON

  • toJSON(excludeData?: boolean): any

  • Convert the object to a definition that can be serialized to JSON, or used directly with the builder api

    Parameters

    • Optional excludeData: boolean

      if set true, data values will not be included in the json.

    Returns any

Generated using TypeDoc