API Reference

Class

HeatmapInsightCard

Namespace ChartForgeX.VisualBlocks

Dashboard heatmap card with an optional right-side insight rail and color key.

Inheritance

Object
HeatmapInsightCard

Methods

AddInsight(System.String arg1, System.String arg2) #

Adds one side-rail insight.

Parameters

arg1 System.String required
arg2 System.String required

AddRow(System.String arg1, System.Double[] arg2) #

Adds one heatmap row.

Parameters

arg1 System.String required
arg2 System.Double[] required

Create() #

Creates a new heatmap insight card.

WithColorKey(System.Double arg1, System.Double arg2, System.Nullable{ChartForgeX.Primitives.ChartColor} arg3, System.Nullable{ChartForgeX.Primitives.ChartColor} arg4, System.String arg5)

Sets the color key text and range.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg4 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg5 System.String required

WithColumns(System.String[] arg1) #

Sets heatmap column labels.

Parameters

arg1 System.String[] required

WithControls(System.String arg1, System.String arg2, System.String arg3) #

Sets the controls rendered above the matrix.

Parameters

arg1 System.String required
arg2 System.String required
arg3 System.String required

WithInsightTitle(System.String arg1) #

Sets the side insight title.

Parameters

arg1 System.String required

Properties

Columns #

Gets column labels.

Rows #

Gets heatmap rows.

Insights #

Gets side-rail insight items.

LeftControl #

Gets or sets the unselected control label.

SelectedControl #

Gets or sets the selected control label.

PeriodLabel #

Gets or sets the period label.

InsightTitle #

Gets or sets the side insight title.

ColorKeyLabel #

Gets or sets the color key label.

Minimum #

Gets or sets the heatmap minimum.

Maximum #

Gets or sets the heatmap maximum.

LowColor #

Gets or sets the low-value heatmap color.

HighColor #

Gets or sets the high-value heatmap color.