Class SparklineBuilder

Namespace

SharpConsoleUI.Builders

Assembly

SharpConsoleUI.dll

Fluent builder for creating SparklineControl instances.

public class SparklineBuilder

Inheritance

object

SparklineBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SparklineBuilder()

Initializes a new instance of the SparklineBuilder class.

public SparklineBuilder()

Methods

Build()

Builds the SparklineControl instance.

public SparklineControl Build()

Returns

SparklineControl

Visible(bool)

Sets the visibility.

public SparklineBuilder Visible(bool visible)

Parameters

visible bool

Returns

SparklineBuilder

WithAlignment(HorizontalAlignment)

Sets the horizontal alignment.

public SparklineBuilder WithAlignment(HorizontalAlignment alignment)

Parameters

alignment HorizontalAlignment

Returns

SparklineBuilder

WithBackgroundColor(Color)

Sets the background color.

public SparklineBuilder WithBackgroundColor(Color color)

Parameters

color Color

Returns

SparklineBuilder

WithBarColor(Color)

Sets the bar color.

public SparklineBuilder WithBarColor(Color color)

Parameters

color Color

Returns

SparklineBuilder

WithBaseline(bool, char, Color?, TitlePosition)

Enables or disables the dotted baseline with optional customization.

public SparklineBuilder WithBaseline(bool show = true, char baselineChar = '┈', Color? color = null, TitlePosition position = TitlePosition.Bottom)

Parameters

show bool

Whether to show the baseline.

baselineChar char

Character to use for the baseline (default: ┈).

color Color?

Color for the baseline (default: Grey50).

position TitlePosition

Position of the baseline (Top or Bottom, default: Bottom).

Returns

SparklineBuilder

WithBidirectionalData(IEnumerable<double>, IEnumerable<double>)

Sets both primary and secondary data at once (for bidirectional mode).

public SparklineBuilder WithBidirectionalData(IEnumerable<double> primaryData, IEnumerable<double> secondaryData)

Parameters

primaryData IEnumerable<double>

secondaryData IEnumerable<double>

Returns

SparklineBuilder

WithBorder(BorderStyle)

Sets the border style.

public SparklineBuilder WithBorder(BorderStyle style)

Parameters

style BorderStyle

Returns

SparklineBuilder

WithBorder(BorderStyle, Color)

Sets the border style and color.

public SparklineBuilder WithBorder(BorderStyle style, Color color)

Parameters

style BorderStyle

color Color

Returns

SparklineBuilder

WithBorderColor(Color)

Sets the border color.

public SparklineBuilder WithBorderColor(Color color)

Parameters

color Color

Returns

SparklineBuilder

WithData(IEnumerable<double>)

Sets the initial data points.

public SparklineBuilder WithData(IEnumerable<double> dataPoints)

Parameters

dataPoints IEnumerable<double>

Returns

SparklineBuilder

WithGradient(ColorGradient)

Sets the color gradient for vertical color interpolation.

public SparklineBuilder WithGradient(ColorGradient gradient)

Parameters

gradient ColorGradient

Returns

SparklineBuilder

WithGradient(params Color[])

Sets the color gradient from an array of colors.

public SparklineBuilder WithGradient(params Color[] colors)

Parameters

colors Color[]

Returns

SparklineBuilder

WithGradient(string)

Sets the color gradient from a gradient specification string. Supports predefined gradients (cool, warm, spectrum, grayscale), arrow notation (blue→cyan→green), and :reverse suffix.

public SparklineBuilder WithGradient(string gradientSpec)

Parameters

gradientSpec string

Returns

SparklineBuilder

WithHeight(int)

Sets the graph height in lines.

public SparklineBuilder WithHeight(int height)

Parameters

height int

Returns

SparklineBuilder

WithInlineTitleBaseline(bool)

Sets whether to show the title inline with the baseline. Only applies when TitlePosition and BaselinePosition are the same (both Top or both Bottom). Format: "Title ┈┈┈┈┈┈┈┈┈" (title followed by baseline fill).

public SparklineBuilder WithInlineTitleBaseline(bool inline = true)

Parameters

inline bool

Returns

SparklineBuilder

WithMargin(Margin)

Sets the margin.

public SparklineBuilder WithMargin(Margin margin)

Parameters

margin Margin

Returns

SparklineBuilder

WithMargin(int, int, int, int)

Sets the margin.

public SparklineBuilder WithMargin(int left, int top, int right, int bottom)

Parameters

left int

top int

right int

bottom int

Returns

SparklineBuilder

WithMaxDataPoints(int)

Sets the maximum number of data points to keep.

public SparklineBuilder WithMaxDataPoints(int maxPoints)

Parameters

maxPoints int

Returns

SparklineBuilder

WithMaxValue(double)

Sets the maximum value for the graph scale.

public SparklineBuilder WithMaxValue(double maxValue)

Parameters

maxValue double

Returns

SparklineBuilder

WithMinValue(double)

Sets the minimum value for the graph scale.

public SparklineBuilder WithMinValue(double minValue)

Parameters

minValue double

Returns

SparklineBuilder

WithMode(SparklineMode)

Sets the rendering mode (Block or Braille). Block uses 9-level block characters, Braille uses 5-level braille patterns.

public SparklineBuilder WithMode(SparklineMode mode)

Parameters

mode SparklineMode

Returns

SparklineBuilder

WithName(string)

Sets the control name.

public SparklineBuilder WithName(string name)

Parameters

name string

Returns

SparklineBuilder

WithSecondaryBarColor(Color)

Sets the secondary bar color (for bidirectional mode).

public SparklineBuilder WithSecondaryBarColor(Color color)

Parameters

color Color

Returns

SparklineBuilder

WithSecondaryData(IEnumerable<double>)

Sets the secondary data points (for bidirectional mode).

public SparklineBuilder WithSecondaryData(IEnumerable<double> dataPoints)

Parameters

dataPoints IEnumerable<double>

Returns

SparklineBuilder

WithSecondaryGradient(ColorGradient)

Sets the secondary color gradient for bidirectional mode.

public SparklineBuilder WithSecondaryGradient(ColorGradient gradient)

Parameters

gradient ColorGradient

Returns

SparklineBuilder

WithSecondaryGradient(params Color[])

Sets the secondary color gradient from an array of colors.

public SparklineBuilder WithSecondaryGradient(params Color[] colors)

Parameters

colors Color[]

Returns

SparklineBuilder

WithSecondaryGradient(string)

Sets the secondary color gradient from a gradient specification string. Supports predefined gradients (cool, warm, spectrum, grayscale), arrow notation (blue→cyan→green), and :reverse suffix.

public SparklineBuilder WithSecondaryGradient(string gradientSpec)

Parameters

gradientSpec string

Returns

SparklineBuilder

WithSecondaryMaxValue(double)

Sets the secondary max value (for bidirectional mode).

public SparklineBuilder WithSecondaryMaxValue(double maxValue)

Parameters

maxValue double

Returns

SparklineBuilder

WithTitle(string)

Sets the title.

public SparklineBuilder WithTitle(string title)

Parameters

title string

Returns

SparklineBuilder

WithTitle(string, Color)

Sets the title and color.

public SparklineBuilder WithTitle(string title, Color color)

Parameters

title string

color Color

Returns

SparklineBuilder

WithTitleColor(Color)

Sets the title color.

public SparklineBuilder WithTitleColor(Color color)

Parameters

color Color

Returns

SparklineBuilder

WithTitlePosition(TitlePosition)

Sets the title position (Top or Bottom).

public SparklineBuilder WithTitlePosition(TitlePosition position)

Parameters

position TitlePosition

Returns

SparklineBuilder

WithVerticalAlignment(VerticalAlignment)

Sets the vertical alignment.

public SparklineBuilder WithVerticalAlignment(VerticalAlignment alignment)

Parameters

alignment VerticalAlignment

Returns

SparklineBuilder

WithWidth(int)

Sets the width.

public SparklineBuilder WithWidth(int width)

Parameters

width int

Returns

SparklineBuilder