Skip to content
ConsoleMonster
Class

ChartViewInputOptions

ConsoleMonster.Interactive

Edit on GitHub
Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Source
ChartViewInputOptions.cs:11
Base
AppInputOptions
Modifiers
sealed

An explorable chart shared by Ui.ChartView and New-ConsoleChartView.

Inheritance

Usage

Explore 53 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 25

Accepted by parameters 28

Constructors

public ChartViewInputOptions() #
ChartViewInputOptions.cs:11

Methods

public ChartView Build() #
ChartViewInputOptions.cs:18

Creates the persistent input after its key and chart are configured.

Returns

ChartView

Properties

public ChartPlot? Chart { get; set; } #
ChartViewInputOptions.cs:9

The chart to explore: a LineChart (converted implicitly), or any other ChartPlot.

public int Height { get; set; } #
ChartViewInputOptions.cs:11

Rows for the readout and the plot, legend included.

public IList<string>? PointLabels { get; set; } #
ChartViewInputOptions.cs:13

Labels for the points along X, read out with their values.

public string? LinkKey { get; set; } #
ChartViewInputOptions.cs:15

The app-state key shared with linked controls (see ILinkedSelection): the point under the crosshair.

Extension Methods

public static ChartViewInputOptions AddPointLabel(ChartViewInputOptions chartViewInputOptions, string item) #

Adds an item to ChartViewInputOptions.PointLabels: Labels for the points along X, read out with their values.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
item string required
The item.

Returns

ChartViewInputOptions The same instance.
AddPointLabels 2 overloads
public static ChartViewInputOptions AddPointLabels(ChartViewInputOptions chartViewInputOptions, params string[] items) #

Adds items to ChartViewInputOptions.PointLabels: Labels for the points along X, read out with their values.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
items string[] required
The items, in order.

Returns

ChartViewInputOptions The same instance.
public static ChartViewInputOptions AddPointLabels(ChartViewInputOptions chartViewInputOptions, IEnumerable<string> items) #

Adds items to ChartViewInputOptions.PointLabels: Labels for the points along X, read out with their values.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

ChartViewInputOptions The same instance.
public static ChartViewInputOptions Chart(ChartViewInputOptions chartViewInputOptions, ChartPlot? value) #

Sets ChartViewInputOptions.Chart: The chart to explore: a LineChart (converted implicitly), or any other ChartPlot.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value ConsoleMonster.Interactive.ChartPlot? required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { Chart = value };    Ui.ChartView().Chart(value);
public static ChartViewInputOptions Configure(ChartViewInputOptions chartViewInputOptions, Action<ChartViewInputOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.ChartViewInputOptions> required
Assignments applied in order.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { OnChange = value };    Ui.ChartView().Configure(configured => configured.OnChange = value);
Disabled 2 overloads
public static ChartViewInputOptions Disabled(ChartViewInputOptions chartViewInputOptions, bool value) #

Sets AppInputOptions.Disabled: Disables editing and keyboard focus.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value bool required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { Disabled = value };    Ui.ChartView().Disabled(value);
public static ChartViewInputOptions Disabled(ChartViewInputOptions chartViewInputOptions) #

Sets AppInputOptions.Disabled to true.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance to configure.

Returns

ChartViewInputOptions The same instance.
public static ChartViewInputOptions Height(ChartViewInputOptions chartViewInputOptions, int value) #

Sets ChartViewInputOptions.Height: Rows for the readout and the plot, legend included.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value int required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { Height = value };    Ui.ChartView().Height(value);
public static ChartViewInputOptions Key(ChartViewInputOptions chartViewInputOptions, string value) #

Sets AppInputOptions.Key: The unique application-state key.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value string required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { Key = value };    Ui.ChartView().Key(value);
public static ChartViewInputOptions Label(ChartViewInputOptions chartViewInputOptions, string? value) #

Sets AppInputOptions.Label: The visible label; null uses the key.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value string? required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { Label = value };    Ui.ChartView().Label(value);
public static ChartViewInputOptions LinkKey(ChartViewInputOptions chartViewInputOptions, string? value) #

Sets ChartViewInputOptions.LinkKey: The app-state key shared with linked controls (see ILinkedSelection): the point under the crosshair.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value string? required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { LinkKey = value };    Ui.ChartView().LinkKey(value);
public static ChartViewInputOptions PointLabels(ChartViewInputOptions chartViewInputOptions, IList<string>? value) #

Sets ChartViewInputOptions.PointLabels: Labels for the points along X, read out with their values.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value System.Collections.Generic.IList<string>? required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                            // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { PointLabels = value };    Ui.ChartView().PointLabels(value);
public static ChartViewInputOptions TabIndex(ChartViewInputOptions chartViewInputOptions, int value) #

Sets AppInputOptions.TabIndex: Keyboard focus order; equal values preserve declaration order.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value int required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { TabIndex = value };    Ui.ChartView().TabIndex(value);
public static ChartViewInputOptions ValidationMessage(ChartViewInputOptions chartViewInputOptions, string? value) #

Sets AppInputOptions.ValidationMessage: Initial validation text.

Parameters

chartViewInputOptions ConsoleMonster.Interactive.ChartViewInputOptions required
The instance.
value string? required
The value.

Returns

ChartViewInputOptions The same instance.

Examples

// C# initializer or property                                                                  // C# fluent
new global::ConsoleMonster.Interactive.ChartViewInputOptions { ValidationMessage = value };    Ui.ChartView().ValidationMessage(value);