API Reference
ChartAxis
Defines renderer-neutral bounds, scale, ticks, labels, and visibility for one chart axis.
Inheritance
- Object
- ChartAxis
Usage
Explore 14 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 11
- Method ChartAxis.WithAutomaticBounds
- Method ChartAxis.WithBounds
- Method ChartAxis.WithLabelFormatter
- Method ChartAxis.WithReversal
- Method ChartAxis.WithScale
- Method ChartAxis.WithTimeScale
- Method ChartAxis.WithValueFormat
- Method ChartAxis.WithVisibility
- Property ChartOptions.SecondaryYAxis
- Property ChartOptions.XAxis
- Property ChartOptions.YAxis
Accepted by parameters 3
- Method Chart.ConfigureSecondaryYAxis
- Method Chart.ConfigureXAxis
- Method Chart.ConfigureYAxis
Constructors
public ChartAxis() #Methods
public ChartAxis WithBounds(Double minimum, Double maximum) #ChartAxisSets explicit bounds.
Parameters
- minimum System.Double
- maximum System.Double
public ChartAxis WithLabelFormatter(Func<Double, String>? formatter) #ChartAxisSets the label formatter.
Parameters
- formatter System.Func<System.Double, System.String>?
public ChartAxis WithReversal(Boolean reversed = true) #ChartAxisReverses the visual direction while retaining bounds and source values.
Parameters
- reversed System.Boolean = true
public ChartAxis WithScale(ChartScaleKind scale) #ChartAxisSets the mathematical scale.
Parameters
- scale ChartForgeX.Core.ChartScaleKind
public ChartAxis WithTimeScale(TimeZoneInfo? timeZone = null, Boolean showTimeZone = false, String? label = null) #ChartAxisUses a UTC time scale displayed in timeZone (UTC when null) and optionally shows the zone designator.
Parameters
- timeZone System.TimeZoneInfo? = null
- The display time zone, or null for UTC.
- showTimeZone System.Boolean = false
- Whether the axis title shows the zone designator.
- label System.String? = null
- An optional designator such as CET or Europe/Warsaw.
Returns
The current axis.
public ChartAxis WithValueFormat(ChartValueFormat? format) #ChartAxisSets the numeric display policy; null restores scale-aware automatic formatting.
Parameters
- format ChartForgeX.Core.ChartValueFormat?
public ChartAxis WithVisibility(Boolean visible = true) #ChartAxisSets axis visibility.
Parameters
- visible System.Boolean = true
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Double? Minimum { get; set; } #Gets or sets an explicit minimum. Null enables automatic bounds.
public Double? Maximum { get; set; } #Gets or sets an explicit maximum. Null enables automatic bounds.
public ChartScaleKind Scale { get; set; } #Gets or sets the mathematical axis scale.
public Double SymmetricLogarithmThreshold { get; set; } #Gets or sets the positive linear threshold used by symmetric logarithmic scaling.
public Int32 TickCount { get; set; } #Gets or sets the preferred number of generated ticks.
public ChartLabelDensity LabelDensity { get; set; } #Gets or sets label density.
public Double LabelAngle { get; set; } #Gets or sets label rotation in degrees, or an offset from the selected relative orientation.
public ChartAxisLabelOrientation LabelOrientation { get; set; } #Gets or sets how labels follow the axis. The default is a fixed screen orientation.
public Boolean Visible { get; set; } #Gets or sets a value indicating whether the axis and its labels are visible.
public Boolean Reversed { get; set; } #Gets or sets whether increasing values advance in the reverse visual direction. Bounds and source labels keep their original values.
public Boolean ShowLine { get; set; } #Gets or sets a value indicating whether the axis rule is visible.
public Func<Double, String>? LabelFormatter { get; set; } #Gets or sets a formatter for generated labels.
public ChartValueFormat? ValueFormat { get; set; } #Gets or sets the numeric display policy. Null uses the chart fallback or the scale-aware default for time axes.
public TimeZoneInfo? TimeZone { get; set; } #Gets or sets the display time zone for ChartScaleKind.Time axes. Axis values are UTC instants; null keeps ticks and labels in UTC. A zone moves tick alignment and labels to that zone's wall-clock time.
public String? TimeZoneLabel { get; set; } #Gets or sets the time-zone designator shown when ChartAxis.ShowTimeZone is enabled. Null uses UTC when ChartAxis.TimeZone is null, otherwise the zone identifier. Zone identifiers differ between Windows and IANA systems, so set an explicit label when output must match across platforms.
public Boolean ShowTimeZone { get; set; } #Gets or sets a value indicating whether time axes append the time-zone designator to the axis title, or show it as the title when no title is set. Only the x-axis title is decorated.
public List<ChartAxisLabel> Labels { get; } #Gets explicit value-to-label mappings.