PromptPlus

# PromptPlus ## **ChartBar** [](https://www.nuget.org/packages/PromptPlus) [](https://opensource.org/licenses/MIT) [](https://dotnet.microsoft.com/)

← Back to Home • Next: ChartBar — Methods →

---

An interactive horizontal bar chart the user can navigate, re-sort, and re-layout — picking one bar and confirming with Enter.

ChartBar renders a set of labeled numeric items as horizontal bars with values, percentages, and an optional legend. Unlike a static chart, it is a live control: arrow keys move a highlight between bars, hotkeys switch the layout and sort order, and pressing Enter returns the highlighted ChartItem.

☑️ Just need to display a bar chart with no interaction? Use the read-only ChartBar widget — same visuals, rendered with .Show() and no selection.

---

On this page

Sub-page	What you will find
Index (this page)	What it is, when to use it, first examples, the method map
Methods	Every fluent method — signature, parameters, defaults, and a snippet
Operations	Keyboard, ordering, legends, layouts, validation, paging
Styles	The ChartBarStyles regions and how to recolor them

---

When to use it

Use ChartBar when…	Consider instead…
The user compares numeric values and picks one	—
You only want to display a chart, no picking	ChartBar widget
The choices are plain text with no magnitude	Select
The data is tabular (multiple columns)	TableSelect

---

Minimal example

using PromptPlusLibrary;

var result = PromptPlus.Controls
    .ChartBar("Select item")
    .AddItem("Item A", 40)
    .AddItem("Item B", 85)
    .AddItem("Item C", 60)
    .Run();

if (!result.IsAborted)
    PromptPlus.Console.WriteLine($"You chose {result.Content?.Label}");

• ChartBar("Select item") creates the control; the prompt is shown above the chart.
• .AddItem(label, value) adds one bar; percentages are computed for you from the totals.
• .Run() renders the chart and blocks until Enter (confirm) or Esc (abort), returning a ResultPrompt<ChartItem?>.

---

A richer example

using PromptPlusLibrary;
using ConsolePlusLibrary;   // Color lives here

var result = PromptPlus.Controls
    .ChartBar("Select item")
    .Title("Sales by Region", TextAlignment.Center)
    .AddItem("North", 120, Color.Green)
    .AddItem("South", 80)
    .AddItem("East",  95)
    .AddItem("West",  110)
    .OrderBy(ChartBarOrder.Highest)   // sort bars by value, highest first
    .ShowLegends()                    // add the value + percentage legend
    .Run();

This combines a title, a custom bar color, an initial sort order, and the legend — see Operations for how these behave together at runtime.

---

Method map

Grouped by purpose. Full signatures and examples are on the Methods page.

Purpose	Methods
Add items	AddItem, Interaction
Chart layout & bars	Layout, BarType, Width, Title
Values & labels	Culture, FractionalDigits, MaxLengthLabel
Ordering & legend	OrderBy, ShowLegends
Hide / page elements	HideElements, PageSize
Runtime switchers	EnableLayoutSwitcher, EnableOrderingSwitcher
Validate on confirm	PredicateSelected, PredicateSelectedAsync
Dynamic description	ChangeDescription, ChangeDescriptionAsync
Appearance & behavior	Styles, Options
Run	Run

---

Return value

ChartBar returns ResultPrompt<ChartItem?> — the highlighted item at the moment Enter was pressed. It is a single item, not a sum or an aggregate value.

Member	Meaning
.Content	The highlighted ChartItem (null if aborted)
.IsAborted	true when the user pressed Esc

var result = PromptPlus.Controls
    .ChartBar("Select item")
    .AddItem("A", 40).AddItem("B", 85)
    .Run();

if (!result.IsAborted && result.Content is not null)
    PromptPlus.Console.WriteLine($"{result.Content.Label} = {result.Content.Value}");

The ChartItem type

ChartItem is a sealed class describing one bar:

Member	Type	Meaning
Id	string	The id you passed to AddItem (or an auto id)
Label	string	The display label
Value	double	The numeric value
Color	Color?	The bar color (auto-assigned if you did not set one)
Percent	double	The item’s share of the total, computed by the control
StyleBar	Style?	The style used to paint this bar

---

See also

• Methods — the full fluent API
• Operations — keyboard, ordering, legends, layouts, validation
• Styles — recolor the chart regions
• ChartBar widget — the read-only .Show() sibling
• Select · TableSelect — text and tabular pickers

This site is open source. Improve this page.