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

A JavaScript Heatmap chart type rendering a 2-dimensional array of data as color values between X,Y bounds in SciChart's High Performance Real-time JavaScript Chart Library

description

Heatmaps are 2-dimensional arrays of data, rendered as a color-map on the chart. The UniformHeatmapRenderableSeries assumes the cells are equal size, and spaced along the X,Y axis according to properties on the UniformHeatmapDataSeries.

For a code sample how to initialize a uniform heatmap, see below

// Create an empty 2D array using the helper function zeroArray2D
const zValues: number[][] = zeroArray2D([height, width]);
// todo: fill the zValues 2d array with values

// Create a UniformHeatmapDataSeries passing in zValues
const heatmapDataSeries = new UniformHeatmapDataSeries(wasmContext, 0, 1, 0, 1, zValues);

// Create a Heatmap RenderableSeries with the color map. ColorMap.minimum/maximum defines the values in
// HeatmapDataSeries which correspond to gradient stops at 0..1
const heatmapSeries = new UniformHeatmapRenderableSeries(wasmContext, {
       dataSeries: heatmapDataSeries,
       colorMap: new HeatmapColorMap({
           minimum: 0,
          maximum: 200,
          gradientStops: [
              { offset: 0, color: "#00008B" },
              { offset: 0.2, color: "#6495ED" },
              { offset: 0.4, color: "#006400" },
              { offset: 0.6, color: "#7FFF00" },
              { offset: 0.8, color: "#FFFF00" },
              { offset: 1.0, color: "#FF0000" }
          ]
      })
  });

// Add heatmap to the chart
sciChartSurface.renderableSeries.add(heatmapSeries);

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected animationToken

animationToken: AnimationToken

Protected dataSeriesProperty

dataSeriesProperty: IDataSeries

drawingProviders

drawingProviders: ISeriesDrawingProvider[] = []

Gets a list of Series Drawing Providers, which perform specific drawing operations in the series

hitTestProvider

hitTestProvider: IHitTestProvider

Gets the current IHitTestProvider, used to call methods IHitTestProvider.hitTest, IHitTestProvider.getNearestPoint2D and IHitTestProvider.getNearestHorizontalPoint and provide info about the series data-points at mouse or touch locations

Readonly id

id: string = generateGuid()

A unique, auto-generated Id for the IRenderableSeries

invalidateParentCallback

invalidateParentCallback: () => void

A callback which tells the parent SciChartSurface that it must be redrawn, e.g. when a property changes

Type declaration

    • (): void
    • Returns void

Readonly isStacked

isStacked: false = false

Returns true if the series is a stacked series or not

parentSurface

parentSurface: SciChartSurface

The parent SciChartSurface that this RenderableSeries is attached to

Readonly rolloverModifierProps

rolloverModifierProps: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps()

Readonly rolloverModifierProps1

rolloverModifierProps1: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps()

Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips Is being used for Y1 tooltips for FastBandRenderableSeries

Readonly type

type: ESeriesType = ESeriesType.UniformHeatmapSeries

Protected webAssemblyContext

webAssemblyContext: TSciChart

yAnimationValues

yAnimationValues: DoubleVector

Y vector with animation values

Accessors

animation

colorMap

  • Gets or sets the HeatmapColorMap, which maps heatmap z-values to colors

    Returns HeatmapColorMap

  • Gets or sets the HeatmapColorMap, which maps heatmap z-values to colors

    Parameters

    Returns void

dataSeries

drawNaNAs

effect

isDigitalLine

  • get isDigitalLine(): boolean
  • set isDigitalLine(isDigitalLine: boolean): void
  • When true, if this series draws a line, the line will be a digital (step) line

    inheritdoc

    Returns boolean

  • When true, if this series draws a line, the line will be a digital (step) line

    inheritdoc

    Parameters

    • isDigitalLine: boolean

    Returns void

isRunningAnimation

  • get isRunningAnimation(): boolean

isSpline

  • get isSpline(): boolean
  • Returns true if the series uses spline interpolation

    inheritdoc

    Returns boolean

isVisible

  • get isVisible(): boolean
  • set isVisible(isVisible: boolean): void
  • When true, the series is visible and drawn

    inheritdoc

    Returns boolean

  • When true, the series is visible and drawn

    inheritdoc

    Parameters

    • isVisible: boolean

    Returns void

opacity

  • get opacity(): number
  • set opacity(value: number): void
  • An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

    inheritdoc

    Returns number

  • An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

    inheritdoc

    Parameters

    • value: number

    Returns void

paletteProvider

pointMarker

  • A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only

    inheritdoc

    Returns IPointMarker

  • A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only

    inheritdoc

    Parameters

    Returns void

stroke

  • get stroke(): string
  • set stroke(htmlColorCode: string): void
  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns string

  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Parameters

    • htmlColorCode: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(value: number): void
  • The Stroke Thickness for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns number

  • The Stroke Thickness for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Parameters

    • value: number

    Returns void

useLinearTextureFiltering

  • get useLinearTextureFiltering(): boolean
  • set useLinearTextureFiltering(value: boolean): void
  • Gets or sets whether to make the heatmap linearly interpolated or smoothed between cells

    Returns boolean

  • Gets or sets whether to make the heatmap linearly interpolated or smoothed between cells

    Parameters

    • value: boolean

    Returns void

xAxis

xAxisId

  • get xAxisId(): string
  • set xAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

yAxis

yAxisId

  • get yAxisId(): string
  • set yAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

Methods

Protected afterAnimationComplete

  • afterAnimationComplete(): void

Protected animate

  • animate(): void

applyTheme

Protected beforeAnimationStart

  • beforeAnimationStart(): void

checkIsOutOfDataRange

  • checkIsOutOfDataRange(xValue: number, yValue: number, isSorted?: boolean): boolean

Protected colorMapPropertyChanged

Protected dataSeriesDataChanged

  • dataSeriesDataChanged(): void
  • Is being called when the data for the underlying DataSeries changes

    Returns void

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

draw

getBaseXValues

  • getBaseXValues(): number[]

getDataPointWidth

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

getNativeXValues

  • getNativeXValues(): DoubleVector

getNativeYValues

  • getNativeYValues(): DoubleVector

getXRange

getYRange

hasDataSeries

  • hasDataSeries(): boolean

hasDataSeriesValues

  • hasDataSeriesValues(): boolean

hasFillPaletteProvider

  • hasFillPaletteProvider(): boolean

hasPointMarkerPaletteProvider

  • hasPointMarkerPaletteProvider(): boolean

hasStrokePaletteProvider

  • hasStrokePaletteProvider(): boolean

Protected newHitTestProvider

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

Protected onAnimate

  • onAnimate(progress: number): void
  • Internal method that runs on each animation tick

    Parameters

    • progress: number

      The current animation progress, a value from 0 to 1

    Returns void

onAttach

onDetach

  • onDetach(): void

pushPalettedColors

Generated using TypeDoc