Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HeatmapLegend

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

The HeatmapLegend displays a control which hosts a SciChartSurface in a specific Div on the chart. The legend contains a gradient fill and can be used in conjunction with UniformHeatmapRenderableSeries, NonUniformHeatmapRenderableSeries or SurfaceMeshRenderableSeries3D to allow the user to see what colors map to what values on the heatmap or surface.

remarks

This control will expand to fit its parent Div. Suggest placing the div to the right and floating 100px wide to create a good effect.

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

innerSciChartSurface

Methods

delete

  • delete(): void

Protected getDefaultGradientStops

Protected getDefaultXAxisOptions

  • getDefaultXAxisOptions(): { drawLabels: boolean; drawMajorGridLines: boolean; drawMajorTickLines: boolean; drawMinorGridLines: boolean; drawMinorTickLines: boolean }

  • Gets the default options to apply to the inner SciChartSurface xAxis. Must conform to IAxisBase2dOptions interface

    Returns { drawLabels: boolean; drawMajorGridLines: boolean; drawMajorTickLines: boolean; drawMinorGridLines: boolean; drawMinorTickLines: boolean }

    • drawLabels: boolean
    • drawMajorGridLines: boolean
    • drawMajorTickLines: boolean
    • drawMinorGridLines: boolean
    • drawMinorTickLines: boolean

Protected getDefaultYAxisOptions

  • getDefaultYAxisOptions(): { drawLabels: boolean; drawMajorGridLines: boolean; drawMajorTickLines: boolean; drawMinorGridLines: boolean; drawMinorTickLines: boolean; maxAutoTicks: number }

  • Gets the default options to apply to the inner SciChartSurface yAxis. Must conform to IAxisBase2dOptions interface

    Returns { drawLabels: boolean; drawMajorGridLines: boolean; drawMajorTickLines: boolean; drawMinorGridLines: boolean; drawMinorTickLines: boolean; maxAutoTicks: number }

    • drawLabels: boolean
    • drawMajorGridLines: boolean
    • drawMajorTickLines: boolean
    • drawMinorGridLines: boolean
    • drawMinorTickLines: boolean
    • maxAutoTicks: number

getZValues

  • getZValues(minimum: number, maximum: number): number[][]

  • Parameters

    • minimum: number
    • maximum: number

    Returns number[][]

Static create

  • Asynchronously creates a HeatmapLegend and @link TSciChart | WebAssembly Context} to occupy the div by element ID in your DOM.

    remarks

    This method is async and must be awaited

    Parameters

    Returns Promise<THeatmapLegend>

Generated using TypeDoc