API Reference
ChartLabels
Holds the words ChartForgeX writes into rendered charts on its own (markers, tooltips, and default titles), so hosts can localize them. Defaults are English; set values before rendering, or before calling builders that use them.
Inheritance
- Object
- ChartLabels
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
- Property ChartOptions.Labels
Accepted by parameters 1
- Method Chart.ConfigureLabels
Constructors
public ChartLabels() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String Now { get; set; } #Gets or sets the label of the current-time line in Gantt lanes. Default Now.
public String Ongoing { get; set; } #Gets or sets the tooltip word used in place of the end time of an open item. Default ongoing.
public String SoFar { get; set; } #Gets or sets the tooltip suffix after the duration of an open item. Default so far.
public String HourOfDay { get; set; } #Gets or sets the default x-axis title of hour-by-weekday heatmaps, followed by the zone designator in parentheses. Set it before calling Chart.AddHourWeekdayHeatmap. Default Hour of day.
public String Level { get; set; } #Gets or sets the interactive tooltip row name for the intensity level of sequential heatmap cells. Default Level; a changed value is emitted as data-cfx-label-level on the heatmap for the HTML adapter.
public String Less { get; set; } #Gets or sets the word at the weak end of calendar and map colour scales. Default Less.
public String More { get; set; } #Gets or sets the word at the strong end of calendar and map colour scales. Default More.
public String NoData { get; set; } #Gets or sets the word for calendar days, map regions, and independent color measurements without a value, in scales and tooltips. Default No data.
public String Color { get; set; } #Gets or sets the default title and tooltip row name of an independent numeric color measurement. Default Color.
public String Size { get; set; } #Gets or sets the interactive tooltip row name of a Bubble size measurement. Default Size.
public String AuthoredValue { get; set; } #Gets or sets the tooltip row name for a supplied group size that differs from its resolved size. Default Provided value.
public String Remainder { get; set; } #Gets or sets the tooltip row name for the unallocated part of an inclusive Sunburst group total. Default Remainder.
public String AllValues { get; set; } #Gets or sets the caption for a discrete color scale with one unbounded band. Default All values.
public String Value { get; set; } #Gets or sets the word between the bounds of an interior discrete color band, for example 10 ≤ value < 20. Default value.
public String Change { get; set; } #Gets or sets the waterfall tooltip row name for a supplied change. Default Change.
public String OpeningBalance { get; set; } #Gets or sets the default waterfall opening-balance axis caption and tooltip row name. Default Opening balance.
public String Subtotal { get; set; } #Gets or sets the default waterfall subtotal axis caption and tooltip row name. Default Subtotal.
public String Total { get; set; } #Gets or sets the default waterfall total axis caption and tooltip row name. Default Total.
public String UntitledChart { get; set; } #Gets or sets the accessible name of a chart without a title (the SVG title element and the HTML page title). Default ChartForgeX chart.
public Func<ChartDescriptionFacts, String?>? AccessibleTextFormatter { get; set; } #Gets or sets a function that writes the automatic accessible sentences from their ChartDescriptionFacts: the chart description (the SVG desc element) and the accessible names of calendar, dotted map, region map, and tile map groups; ChartDescriptionFacts.Kind says which. Null (the default), or a function returning null or white space for a sentence, writes ChartDescriptionFacts.EnglishText. A description set through Chart.ConfigureAccessibility still wins and the function is not called for it. Exceptions thrown by the function are not caught; they surface from the render call.
public Func<DateTime, String?>? DateFormatter { get; set; } #Gets or sets a function that writes a day in the accessible name and hover title of a calendar heatmap cell, for example day => day.ToString("D", culture). Null (the default), or a function returning null or white space, writes the ISO date (yyyy-MM-dd). The machine-readable data-cfx-date attribute always stays ISO. Exceptions thrown by the function are not caught; they surface from the render call.