IntelligenceX

API Reference

Class

HeatmapDocument

Namespace IntelligenceX.Visualization.Heatmaps
Assembly IntelligenceX
Modifiers sealed

Represents a reusable calendar-style heatmap document.

Inheritance

  • Object
  • HeatmapDocument

Usage

Explore 8 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.

Accepted by parameters 3

Constructors

public HeatmapDocument(String title, String? subtitle, HeatmapPalette palette, IReadOnlyList<HeatmapSection> sections, String? units = null, DayOfWeek weekStart = Sunday, Boolean showIntensityLegend = true, String? legendLowLabel = null, String? legendHighLabel = null, IReadOnlyList<HeatmapLegendItem>? legendItems = null, Boolean showDocumentHeader = true, Boolean showSectionHeaders = true, Boolean compactWeekdayLabels = false) #

Parameters

title String requiredposition: 0
subtitle String? requiredposition: 1
palette HeatmapPalette requiredposition: 2
sections IReadOnlyList<HeatmapSection> requiredposition: 3
units String? = null optionalposition: 4
weekStart DayOfWeek = Sunday optionalposition: 5
showIntensityLegend Boolean = true optionalposition: 6
legendLowLabel String? = null optionalposition: 7
legendHighLabel String? = null optionalposition: 8
legendItems IReadOnlyList<HeatmapLegendItem>? = null optionalposition: 9
showDocumentHeader Boolean = true optionalposition: 10
showSectionHeaders Boolean = true optionalposition: 11
compactWeekdayLabels Boolean = false optionalposition: 12

Methods

public JsonObject ToJson() #
Returns: JsonObject

Properties

public String Title { get; } #
public String? Subtitle { get; } #
public String? Units { get; } #
public HeatmapPalette Palette { get; } #
public IReadOnlyList<HeatmapSection> Sections { get; } #
public DayOfWeek WeekStart { get; } #
public Boolean ShowIntensityLegend { get; } #
public String LegendLowLabel { get; } #
public String LegendHighLabel { get; } #
public IReadOnlyList<HeatmapLegendItem> LegendItems { get; } #
public Boolean ShowDocumentHeader { get; } #
public Boolean ShowSectionHeaders { get; } #
public Boolean CompactWeekdayLabels { get; } #