ChartOptions
ConsoleMonster.Widgets
Presence-aware numeric chart configuration, shared by the C# factory and PowerShell.
Inheritance
- object
- ChartOptions
Usage
Explore 116 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 53
- Method Ui.Chart
- Extension method ChartOptions.AddItem
- Extension method ChartOptions.AddItems
- Extension method ChartOptions.AddSeries
- Extension method ChartOptions.Capacity
- Extension method ChartOptions.CountColumn
- Extension method ChartOptions.Critical
- Extension method ChartOptions.Edges
- Extension method ChartOptions.Height
- Extension method ChartOptions.Label
- Extension method ChartOptions.LabelColumn
- Extension method ChartOptions.Maximum
- Extension method ChartOptions.MaxLegendColumns
- Extension method ChartOptions.Minimum
- Extension method ChartOptions.PercentColumn
- Extension method ChartOptions.Role
- Extension method ChartOptions.Shape
- Extension method ChartOptions.ShowLatest
- Extension method ChartOptions.ShowLegend
- Extension method ChartOptions.ShowValues
- Extension method ChartOptions.Signed
- Extension method ChartOptions.Type
- Extension method ChartOptions.Unit
- Extension method ChartOptions.ValueColumn
- Extension method ChartOptions.Values
- Extension method ChartOptions.Warning
- Extension method ChartOptions.WidgetId
- Method ChartOptionsFluent.AddItem
- Method ChartOptionsFluent.AddItems
- Method ChartOptionsFluent.AddSeries
- Method ChartOptionsFluent.Capacity
- Method ChartOptionsFluent.CountColumn
- Method ChartOptionsFluent.Critical
- Method ChartOptionsFluent.Edges
- Method ChartOptionsFluent.Height
- Method ChartOptionsFluent.Label
- Method ChartOptionsFluent.LabelColumn
- Method ChartOptionsFluent.Maximum
- Method ChartOptionsFluent.MaxLegendColumns
- Method ChartOptionsFluent.Minimum
- Method ChartOptionsFluent.PercentColumn
- Method ChartOptionsFluent.Role
- Method ChartOptionsFluent.Shape
- Method ChartOptionsFluent.ShowLatest
- Method ChartOptionsFluent.ShowLegend
- Method ChartOptionsFluent.ShowValues
- Method ChartOptionsFluent.Signed
- Method ChartOptionsFluent.Type
- Method ChartOptionsFluent.Unit
- Method ChartOptionsFluent.ValueColumn
- Method ChartOptionsFluent.Values
- Method ChartOptionsFluent.Warning
- Method ChartOptionsFluent.WidgetId
Accepted by parameters 63
- Method ContentBuilder.Chart
- Method ContentBuilder.Chart
- Method UiConstruction.Build
- Method UiConstruction.Build``1
- Method UiConstruction.Export
- Method UiConstruction.Show
- Method Chart.Create
- Extension method ChartOptions.AddItem
- Extension method ChartOptions.AddItems
- Extension method ChartOptions.AddSeries
- Extension method ChartOptions.Build
- Extension method ChartOptions.Build``1
- Extension method ChartOptions.Capacity
- Extension method ChartOptions.CountColumn
- Extension method ChartOptions.Critical
- Extension method ChartOptions.Edges
- Extension method ChartOptions.Export
- Extension method ChartOptions.Height
- Extension method ChartOptions.Label
- Extension method ChartOptions.LabelColumn
- Extension method ChartOptions.Maximum
- Extension method ChartOptions.MaxLegendColumns
- Extension method ChartOptions.Minimum
- Extension method ChartOptions.PercentColumn
- Extension method ChartOptions.Role
- Extension method ChartOptions.Shape
- Extension method ChartOptions.Show
- Extension method ChartOptions.ShowLatest
- Extension method ChartOptions.ShowLegend
- Extension method ChartOptions.ShowValues
- Extension method ChartOptions.Signed
- Extension method ChartOptions.Type
- Extension method ChartOptions.Unit
- Extension method ChartOptions.ValueColumn
- Extension method ChartOptions.Values
- Extension method ChartOptions.Warning
- Extension method ChartOptions.WidgetId
- Method ChartOptionsFluent.AddItem
- Method ChartOptionsFluent.AddItems
- Method ChartOptionsFluent.AddSeries
- Method ChartOptionsFluent.Capacity
- Method ChartOptionsFluent.CountColumn
- Method ChartOptionsFluent.Critical
- Method ChartOptionsFluent.Edges
- Method ChartOptionsFluent.Height
- Method ChartOptionsFluent.Label
- Method ChartOptionsFluent.LabelColumn
- Method ChartOptionsFluent.Maximum
- Method ChartOptionsFluent.MaxLegendColumns
- Method ChartOptionsFluent.Minimum
- Method ChartOptionsFluent.PercentColumn
- Method ChartOptionsFluent.Role
- Method ChartOptionsFluent.Shape
- Method ChartOptionsFluent.ShowLatest
- Method ChartOptionsFluent.ShowLegend
- Method ChartOptionsFluent.ShowValues
- Method ChartOptionsFluent.Signed
- Method ChartOptionsFluent.Type
- Method ChartOptionsFluent.Unit
- Method ChartOptionsFluent.ValueColumn
- Method ChartOptionsFluent.Values
- Method ChartOptionsFluent.Warning
- Method ChartOptionsFluent.WidgetId
Constructors
public ChartOptions() #Inherited Methods
Properties
public string? WidgetId { get; set; } #The live identifier; omitted uses the chart kind.
public int? Height { get; set; } #The plot height; omitted uses the selected kind default.
public bool ShowLatest { get; set; } #Whether the latest sparkline value is shown.
public ColumnFormat? CountColumn { get; set; } #The stacked numeric-column format.
public ColumnFormat? PercentColumn { get; set; } #The stacked percent-column format.
public bool Signed { get; set; } #Whether Bar charts reserve space on both sides of zero.
public int MaxLegendColumns { get; set; } #Maximum Stacked legend columns; zero fits the available width.
public int? Capacity { get; set; } #Retained Line, Scatter or Sparkline samples; null keeps that kind's default.
public IList<ChartSeries> Series { get; } #Typed line/scatter series, retaining per-series colors.
Extension Methods
public static ChartOptions AddItem(ChartOptions chartOptions, ChartItem item) #Adds an item to ChartOptions.Items: Labelled bars or stacked segments.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- item ConsoleMonster.Widgets.ChartItem
- The item.
public static ChartOptions AddItems(ChartOptions chartOptions, params ChartItem[] items) #Adds items to ChartOptions.Items: Labelled bars or stacked segments.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- items ConsoleMonster.Widgets.ChartItem[]
- The items, in order.
public static ChartOptions AddItems(ChartOptions chartOptions, IEnumerable<ChartItem> items) #Adds items to ChartOptions.Items: Labelled bars or stacked segments.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ChartItem>
- The items, in order.
public static ChartOptions AddSeries(ChartOptions chartOptions, ChartSeries item) #Adds an item to ChartOptions.Series: Typed line/scatter series, retaining per-series colors.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- item ConsoleMonster.Widgets.ChartSeries
- The item.
public static ChartOptions AddSeries(ChartOptions chartOptions, params ChartSeries[] items) #Adds items to ChartOptions.Series: Typed line/scatter series, retaining per-series colors.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- items ConsoleMonster.Widgets.ChartSeries[]
- The items, in order.
public static ChartOptions AddSeries(ChartOptions chartOptions, IEnumerable<ChartSeries> items) #Adds items to ChartOptions.Series: Typed line/scatter series, retaining per-series colors.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ChartSeries>
- The items, in order.
public static IWidget Build(ChartOptions options) #Creates the selected chart through the shared validated factory.
Parameters
- options ConsoleMonster.Widgets.ChartOptions
- The configured definition.
public static T Build<T>(ChartOptions options) #Materializes a numeric chart and verifies the concrete handle type.
Type Parameters
- T
- The expected renderer.
Parameters
- options ConsoleMonster.Widgets.ChartOptions
- The definition.
Returns
T The typed renderer.public static ChartOptions Capacity(ChartOptions chartOptions, int? value) #Sets ChartOptions.Capacity: Retained Line, Scatter or Sparkline samples; null keeps that kind's default.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value int?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Capacity = value }; Ui.Chart().Capacity(value);public static ChartOptions CountColumn(ChartOptions chartOptions, ColumnFormat? value) #Sets ChartOptions.CountColumn: The stacked numeric-column format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value ConsoleMonster.Layout.ColumnFormat?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { CountColumn = value }; Ui.Chart().CountColumn(value);public static ChartOptions CountColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #Configures ChartOptions.CountColumn in place: The stacked numeric-column format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- configure System.Action<ConsoleMonster.Layout.ColumnFormat>
- Configures the value.
public static ChartOptions Critical(ChartOptions chartOptions, double? value) #Sets ChartOptions.Critical: The critical threshold.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value double?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Critical = value }; Ui.Chart().Critical(value);public static ChartOptions Edges(ChartOptions chartOptions, double[]? value) #Sets ChartOptions.Edges: Strictly ascending histogram bucket edges.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value double[]?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Edges = value }; Ui.Chart().Edges(value);public static void Export(ChartOptions definition, string path, string? format = null, ExportOptions? options = null, IFrameExportProvider? provider = null) #Exports the configured definition through the shared core/add-on dispatcher.
Parameters
- definition ConsoleMonster.Widgets.ChartOptions
- The configured definition.
- path string
- The destination.
- format string? = null
- The format.
- options ConsoleMonster.Export.ExportOptions? = null
- The export options.
- provider ConsoleMonster.Export.IFrameExportProvider? = null
- An optional add-on provider.
public static ChartOptions Height(ChartOptions chartOptions, int? value) #Sets ChartOptions.Height: The plot height; omitted uses the selected kind default.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value int?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Height = value }; Ui.Chart().Height(value);public static ChartOptions Label(ChartOptions chartOptions, string? value) #Sets ChartOptions.Label: The sparkline label.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Label = value }; Ui.Chart().Label(value);public static ChartOptions LabelColumn(ChartOptions chartOptions, ColumnFormat? value) #Sets ChartOptions.LabelColumn: The stacked legend-label format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value ConsoleMonster.Layout.ColumnFormat?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { LabelColumn = value }; Ui.Chart().LabelColumn(value);public static ChartOptions LabelColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #Configures ChartOptions.LabelColumn in place: The stacked legend-label format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- configure System.Action<ConsoleMonster.Layout.ColumnFormat>
- Configures the value.
public static ChartOptions Maximum(ChartOptions chartOptions, double? value) #Sets ChartOptions.Maximum: The upper numeric limit.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value double?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Maximum = value }; Ui.Chart().Maximum(value);public static ChartOptions MaxLegendColumns(ChartOptions chartOptions, int value) #Sets ChartOptions.MaxLegendColumns: Maximum Stacked legend columns; zero fits the available width.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { MaxLegendColumns = value }; Ui.Chart().MaxLegendColumns(value);public static ChartOptions Minimum(ChartOptions chartOptions, double? value) #Sets ChartOptions.Minimum: The lower numeric limit.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value double?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Minimum = value }; Ui.Chart().Minimum(value);public static ChartOptions PercentColumn(ChartOptions chartOptions, ColumnFormat? value) #Sets ChartOptions.PercentColumn: The stacked percent-column format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value ConsoleMonster.Layout.ColumnFormat?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { PercentColumn = value }; Ui.Chart().PercentColumn(value);public static ChartOptions PercentColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #Configures ChartOptions.PercentColumn in place: The stacked percent-column format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- configure System.Action<ConsoleMonster.Layout.ColumnFormat>
- Configures the value.
public static ChartOptions Role(ChartOptions chartOptions, ThemeToken? value) #Sets ChartOptions.Role: The chart color role.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value ConsoleMonster.Styling.ThemeToken?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Role = value }; Ui.Chart().Role(value);public static ChartOptions Shape(ChartOptions chartOptions, BarShape value) #Sets ChartOptions.Shape: The bar shape.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value ConsoleMonster.Widgets.BarShape
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Shape = value }; Ui.Chart().Shape(value);public static void Show(ChartOptions definition, TerminalProfile? profile = null, ITerminalWriter? writer = null) #Displays the configured definition through the shared widget pipeline.
Parameters
- definition ConsoleMonster.Widgets.ChartOptions
- The configured definition.
- profile ConsoleMonster.Capabilities.TerminalProfile? = null
- The terminal profile.
- writer ConsoleMonster.Output.ITerminalWriter? = null
- The output writer.
public static ChartOptions ShowLatest(ChartOptions chartOptions, bool value) #Sets ChartOptions.ShowLatest: Whether the latest sparkline value is shown.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ShowLatest = value }; Ui.Chart().ShowLatest(value);public static ChartOptions ShowLatest(ChartOptions chartOptions) #Sets ChartOptions.ShowLatest to true.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance to configure.
public static ChartOptions ShowLegend(ChartOptions chartOptions, bool value) #Sets ChartOptions.ShowLegend: Whether Stacked charts show their legend.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ShowLegend = value }; Ui.Chart().ShowLegend(value);public static ChartOptions ShowLegend(ChartOptions chartOptions) #Sets ChartOptions.ShowLegend to true.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance to configure.
public static ChartOptions ShowValues(ChartOptions chartOptions, bool value) #Sets ChartOptions.ShowValues: Whether Bar charts show each numeric value.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ShowValues = value }; Ui.Chart().ShowValues(value);public static ChartOptions ShowValues(ChartOptions chartOptions) #Sets ChartOptions.ShowValues to true.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance to configure.
public static ChartOptions Signed(ChartOptions chartOptions, bool value) #Sets ChartOptions.Signed: Whether Bar charts reserve space on both sides of zero.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Signed = value }; Ui.Chart().Signed(value);public static ChartOptions Signed(ChartOptions chartOptions) #Sets ChartOptions.Signed to true.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance to configure.
public static ChartOptions Type(ChartOptions chartOptions, ChartType value) #Sets ChartOptions.Type: The numeric chart kind.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value ConsoleMonster.Widgets.ChartType
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Type = value }; Ui.Chart().Type(value);public static ChartOptions Unit(ChartOptions chartOptions, string? value) #Sets ChartOptions.Unit: The unit on numeric labels.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Unit = value }; Ui.Chart().Unit(value);public static ChartOptions ValueColumn(ChartOptions chartOptions, ColumnFormat? value) #Sets ChartOptions.ValueColumn: The bar numeric-column format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value ConsoleMonster.Layout.ColumnFormat?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ValueColumn = value }; Ui.Chart().ValueColumn(value);public static ChartOptions ValueColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #Configures ChartOptions.ValueColumn in place: The bar numeric-column format.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- configure System.Action<ConsoleMonster.Layout.ColumnFormat>
- Configures the value.
public static ChartOptions Values(ChartOptions chartOptions, double[]? value) #Sets ChartOptions.Values: Initial numeric samples.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value double[]?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Values = value }; Ui.Chart().Values(value);public static ChartOptions Warning(ChartOptions chartOptions, double? value) #Sets ChartOptions.Warning: The warning threshold.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value double?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Warning = value }; Ui.Chart().Warning(value);public static ChartOptions WidgetId(ChartOptions chartOptions, string? value) #Sets ChartOptions.WidgetId: The live identifier; omitted uses the chart kind.
Parameters
- chartOptions ConsoleMonster.Widgets.ChartOptions
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { WidgetId = value }; Ui.Chart().WidgetId(value);