HtmlForgeX

API Reference

Class

ApexHeatmapColorScale

Namespace HtmlForgeX
Assembly HtmlForgeX

Represents heatmap color scale definition with value ranges.

Inheritance

  • Object
  • ApexHeatmapColorScale

Constructors

public ApexHeatmapColorScale() #

Methods

public ApexHeatmapColorScale AddRange(Double from, Double to, String color, String name = null) #
Returns: ApexHeatmapColorScale

Adds a range that maps values to a specific color.

Parameters

from System.Double requiredposition: 0
Inclusive lower bound of the range.
to System.Double requiredposition: 1
Inclusive upper bound of the range.
color System.String requiredposition: 2
CSS color value used for the range.
name System.String = null optionalposition: 3
Optional display label for the range.

Returns

The same ApexHeatmapColorScale instance for chaining.

public ApexHeatmapColorScale SetInverse(Boolean inverse) #
Returns: ApexHeatmapColorScale

Sets whether the heatmap color scale is inverted.

Parameters

inverse System.Boolean requiredposition: 0
True to invert the scale; otherwise false.

Returns

The same ApexHeatmapColorScale instance for chaining.

Properties

public Nullable<Boolean> Inverse { get; set; } #
JsonPropertyName("inverse") JsonIgnore(Condition = 3)

Gets or sets whether the heatmap color scale should be inverted.

public List<ApexHeatmapRange> Ranges { get; set; } #
JsonPropertyName("ranges") JsonIgnore(Condition = 3)

Gets the collection of value ranges used to colorize the heatmap.