API Reference
Class
HeatmapInsightCard
Dashboard heatmap card with an optional right-side insight rail and color key.
Inheritance
- FactualVisualBlock<HeatmapInsightCard>
- HeatmapInsightCard
Usage
Explore 16 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 16
- Method HeatmapInsightCard.AddInsight
- Method HeatmapInsightCard.AddRow
- Method HeatmapInsightCard.Create
- Method HeatmapInsightCard.WithCard
- Method HeatmapInsightCard.WithColorKey
- Method HeatmapInsightCard.WithColumns
- Method HeatmapInsightCard.WithHostFrame
- Method HeatmapInsightCard.WithInsightTitle
- Method HeatmapInsightCard.WithPadding
- Method HeatmapInsightCard.WithPeriodLabel
- Method HeatmapInsightCard.WithPngOutputScale
- Method HeatmapInsightCard.WithSize
- Method HeatmapInsightCard.WithSubtitle
- Method HeatmapInsightCard.WithTheme
- Method HeatmapInsightCard.WithTitle
- Method HeatmapInsightCard.WithTransparentBackground
Constructors
public HeatmapInsightCard() #Methods
public HeatmapInsightCard AddInsight(String label, String detail) #Returns:
HeatmapInsightCardAdds one side-rail insight.
Parameters
- label System.String
- detail System.String
public HeatmapInsightCard AddRow(String label, params Double[] values) #Returns:
HeatmapInsightCardAdds one heatmap row.
Parameters
- label System.String
- values System.Double[]
public static HeatmapInsightCard Create() #Returns:
HeatmapInsightCardCreates a new heatmap insight card.
public HeatmapInsightCard WithColorKey(Double minimum, Double maximum, ChartColor? lowColor = null, ChartColor? highColor = null, String? label = null) #Returns:
HeatmapInsightCardSets the color key text and range.
Parameters
- minimum System.Double
- maximum System.Double
- lowColor ChartForgeX.Primitives.ChartColor? = null
- highColor ChartForgeX.Primitives.ChartColor? = null
- label System.String? = null
public HeatmapInsightCard WithColumns(params String[] columns) #Returns:
HeatmapInsightCardSets heatmap column labels.
Parameters
- columns System.String[]
public HeatmapInsightCard WithInsightTitle(String title) #Returns:
HeatmapInsightCardSets the side insight title.
Parameters
- title System.String
public HeatmapInsightCard WithPeriodLabel(String label) #Returns:
HeatmapInsightCardSets the factual period or range displayed above the heatmap.
Parameters
- label System.String
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public override RgbaImage RenderRgba() #Returns:
RgbaImageInherited from 0, Culture=neutral, PublicKeyToken=null]]
public override String RenderSvg(String idScope) #Returns:
StringInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- idScope String
public HeatmapInsightCard WithCard(Boolean enabled = true) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
public HeatmapInsightCard WithHostFrame(Boolean hostOwnsFrame = true) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- hostOwnsFrame Boolean = true
WithPadding 2 overloads
public HeatmapInsightCard WithPadding(Double padding) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- padding Double
public HeatmapInsightCard WithPadding(Double left, Double top, Double right, Double bottom) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- left Double
- top Double
- right Double
- bottom Double
public HeatmapInsightCard WithPngOutputScale(Int32 scale) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Int32
public HeatmapInsightCard WithSize(Int32 width, Int32 height) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- width Int32
- height Int32
public HeatmapInsightCard WithSubtitle(String subtitle) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- subtitle String
public HeatmapInsightCard WithTheme(ChartTheme theme) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- theme ChartTheme
public HeatmapInsightCard WithTitle(String title) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- title String
public HeatmapInsightCard WithTransparentBackground(Boolean enabled = true) #Returns:
HeatmapInsightCardInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
Properties
public IReadOnlyList<String> Columns { get; } #Gets column labels.
public IReadOnlyList<HeatmapInsightRow> Rows { get; } #Gets heatmap rows.
public IReadOnlyList<HeatmapInsightItem> Insights { get; } #Gets side-rail insight items.
public String PeriodLabel { get; set; } #Gets or sets the period label.
public String InsightTitle { get; set; } #Gets or sets the side insight title.
public String ColorKeyLabel { get; set; } #Gets or sets the color key label.
public Double Minimum { get; set; } #Gets or sets the heatmap minimum.
public Double Maximum { get; set; } #Gets or sets the heatmap maximum.
public ChartColor LowColor { get; set; } #Gets or sets the low-value heatmap color.
public ChartColor HighColor { get; set; } #Gets or sets the high-value heatmap color.
Inherited Properties
public String Title { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public String Subtitle { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisualBlockOptions Options { get; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public virtual String AccessibleName { get; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]