API Reference
ChartDescriptionFacts
The facts behind one automatic accessible sentence: the chart description (the SVG desc element), the accessible name of a calendar or map group, or the description of a topology diagram. ChartLabels.AccessibleTextFormatter and TopologyLabels.AccessibleTextFormatter receive them so hosts can write the sentence in their own language, including its plural forms.
Inheritance
- Object
- ChartDescriptionFacts
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 2
Constructors
public ChartDescriptionFacts(ChartDescriptionKind kind, String? title, IEnumerable<String> seriesNames, Int32 count, Int32 missingCount = 0, DateTime? firstDate = null, DateTime? lastDate = null, String? mapName = null, Int32 groupCount = 0, Int32 edgeCount = 0, Int32 zeroCount = 0) #Initializes the facts of one sentence, for example to test a formatter.
Parameters
- kind ChartForgeX.Core.ChartDescriptionKind
- Which sentence is described.
- title System.String?
- The chart title; null or white space when the chart has none.
- seriesNames System.Collections.Generic.IEnumerable<System.String>
- The described series names.
- count System.Int32
- The main count (see ChartDescriptionFacts.Count); zero or greater.
- missingCount System.Int32 = 0
- The number of days, regions, or tiles without a value; zero or greater.
- firstDate System.DateTime? = null
- The first day, for calendar sentences.
- lastDate System.DateTime? = null
- The last day, for calendar sentences.
- mapName System.String? = null
- The name of the region or tile map definition.
- groupCount System.Int32 = 0
- The number of groups, for topology descriptions; zero or greater.
- edgeCount System.Int32 = 0
- The number of edges, for topology descriptions; zero or greater.
- zeroCount System.Int32 = 0
- The number of calendar days at zero, for calendar sentences; zero or greater.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public ChartDescriptionKind Kind { get; } #Gets which sentence is described.
public String? Title { get; } #Gets the chart title, or null when the chart has none.
public IReadOnlyList<String> SeriesNames { get; } #Gets the described series names: every series with source data, or the one calendar or map series.
public Int32 Count { get; } #Gets the main count: described series, calendar days with a value, highlighted map points, filled map regions, or topology nodes, depending on ChartDescriptionFacts.Kind. A calendar day at zero is drawn neutral and counts in ChartDescriptionFacts.ZeroCount, not here, so a sentence can tell days with changes (ChartDescriptionFacts.Count) from days in the data (ChartDescriptionFacts.Count plus ChartDescriptionFacts.ZeroCount).
public Int32 MissingCount { get; } #Gets the number of calendar days without data, or of map regions without a value; zero for other kinds.
public Int32 ZeroCount { get; } #Gets the number of calendar days whose value is zero (days without changes, drawn neutral unless the day has a colour of its own); zero for other kinds.
public DateTime? FirstDate { get; } #Gets the first day of a calendar sentence.
public DateTime? LastDate { get; } #Gets the last day of a calendar sentence.
public String? MapName { get; } #Gets the name of the region or tile map definition, when there is one.
public Int32 GroupCount { get; } #Gets the number of groups of a topology diagram; zero for other kinds.
public Int32 EdgeCount { get; } #Gets the number of edges of a topology diagram; zero for other kinds.
public String EnglishText { get; } #Gets the English sentence ChartForgeX writes when no formatter is set.