Skip to content
ChartForgeX

API Reference

Class

ChartCalendarOptions

Namespace ChartForgeX.Core
Assembly ChartForgeX
Modifiers sealed

Controls the week layout, localized names, and cell sizing of calendar heatmaps in a chart.

Inheritance

  • Object
  • ChartCalendarOptions

Usage

Explore 2 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 1

Accepted by parameters 1

Constructors

public ChartCalendarOptions() #

Properties

public DayOfWeek FirstDayOfWeek { get; set; } #

Gets or sets the weekday in the top row. Weeks begin on this day. Default: Sunday.

public IReadOnlyList<String>? DayNames { get; set; } #

Gets or sets seven non-empty weekday names indexed by DayOfWeek, Sunday first. Null uses invariant abbreviations. Both assignment and retrieval copy the names.

public IReadOnlyList<String>? MonthNames { get; set; } #

Gets or sets twelve non-empty month names, January first. Null uses invariant abbreviations. Both assignment and retrieval copy the names.

public Double? CellSize { get; set; } #

Gets or sets a preferred cell size in pixels, between two and two hundred. Cells shrink to fit the plot. Null fills the plot; a preferred size takes precedence over ChartCalendarOptions.MaximumCellSize.

public Double? MaximumCellSize { get; set; } #

Gets or sets the largest size, in pixels, cells grow to when filling the plot. Null leaves them unlimited.

public Double? Gap { get; set; } #

Gets or sets a cell gap from zero to twenty-four pixels. Null chooses 3.5 px, or 2.5 px above 32 weeks.