API Reference
Class
HeatmapDocument
Represents a reusable calendar-style heatmap document.
Inheritance
- Object
- HeatmapDocument
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
- subtitle String
- palette HeatmapPalette
- sections IReadOnlyList<HeatmapSection>
- units String = null
- weekStart DayOfWeek = Sunday
- showIntensityLegend Boolean = true
- legendLowLabel String = null
- legendHighLabel String = null
- legendItems IReadOnlyList<HeatmapLegendItem> = null
- showDocumentHeader Boolean = true
- showSectionHeaders Boolean = true
- compactWeekdayLabels Boolean = false
Methods
public JsonObject ToJson() #Returns:
JsonObjectInherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
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; } #