HtmlForgeX

API Reference

Class

ChartXkcd

Namespace HtmlForgeX
Assembly HtmlForgeX
Base Element
Modifiers sealed

Typed HtmlForgeX wrapper for chart.xkcd sketch-style SVG charts.

Inheritance

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public ChartXkcd() #

Initializes a new instance of the ChartXkcd class.

Methods

public ChartXkcd AddData(String label, Double value) #
Returns: ChartXkcd

Adds a label/value pair to the default dataset.

Parameters

label System.String requiredposition: 0
value System.Double requiredposition: 1
AddDataset 2 overloads
public ChartXkcd AddDataset(String label, params Double[] values) #
Returns: ChartXkcd

Adds a dataset with numeric values.

Parameters

label System.String requiredposition: 0
values System.Double[] requiredposition: 1
public ChartXkcd AddDataset(Action<ChartXkcdDataset> configure) #
Returns: ChartXkcd

Adds a dataset using a typed builder.

Parameters

configure System.Action{HtmlForgeX.ChartXkcdDataset} requiredposition: 0
public ChartXkcd AddLabels(params String[] labels) #
Returns: ChartXkcd

Adds categorical labels.

Parameters

labels System.String[] requiredposition: 0
public ChartXkcd AddPoint(Double x, Double y) #
Returns: ChartXkcd

Adds an XY point to the default dataset.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
BackgroundColor 2 overloads
public ChartXkcd BackgroundColor(RGBColor color) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the chart background color.

Parameters

color System.String requiredposition: 0
BackgroundColor(HtmlForgeX.RGBColor color) #

Sets the chart background color.

Parameters

color HtmlForgeX.RGBColor required
public ChartXkcd Bar() #
Returns: ChartXkcd

Sets chart type to bar.

Colors 2 overloads
public ChartXkcd Colors(params RGBColor[] colors) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets explicit dataset colors.

Parameters

colors System.String[] requiredposition: 0
Colors(HtmlForgeX.RGBColor[] colors) #

Sets explicit dataset colors.

Parameters

colors HtmlForgeX.RGBColor[] required
public ChartXkcd Combined() #
Returns: ChartXkcd

Sets chart type to combined bar/line.

public ChartXkcd Configure(Action<ChartXkcdOptions> configure) #
Returns: ChartXkcd
EditorBrowsable(2)

Configures advanced chart.xkcd options.

Parameters

configure System.Action{HtmlForgeX.ChartXkcdOptions} requiredposition: 0
public ChartXkcd DotSize(Double size) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets dot size for supported chart types.

Parameters

size System.Double requiredposition: 0
public ChartXkcd Doughnut(Double innerRadius = 0.5) #
Returns: ChartXkcd

Sets chart type to doughnut by using chart.xkcd pie with an inner radius.

Parameters

innerRadius System.Double = 0.5 optionalposition: 0
public ChartXkcd FollowTheme(Boolean enabled = true) #
Returns: ChartXkcd
EditorBrowsable(2)

Enables or disables document-theme synchronization.

Parameters

enabled System.Boolean = true optionalposition: 0
public ChartXkcd FontFamily(String fontFamily) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the font family.

Parameters

fontFamily System.String requiredposition: 0
public ChartXkcd InnerRadius(Double radius) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets inner radius for pie/doughnut charts.

Parameters

radius System.Double requiredposition: 0
public ChartXkcd LazyInit(Boolean enabled = true) #
Returns: ChartXkcd
EditorBrowsable(2)

Enables or disables lazy initialization.

Parameters

enabled System.Boolean = true optionalposition: 0
public ChartXkcd LegendPosition(ChartXkcdLegendPosition position) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the legend position.

Parameters

position HtmlForgeX.ChartXkcdLegendPosition requiredposition: 0
public ChartXkcd Line() #
Returns: ChartXkcd

Sets chart type to line.

public ChartXkcd Pie() #
Returns: ChartXkcd

Sets chart type to pie and uses a filled pie by default.

public ChartXkcd Radar() #
Returns: ChartXkcd

Sets chart type to radar.

RegisterLibraries() #
public ChartXkcd Settings(Action<ChartXkcdSettings> configure) #
Returns: ChartXkcd

Configures less-common options via a settings sub-builder.

Parameters

configure System.Action{HtmlForgeX.ChartXkcdSettings} requiredposition: 0
public ChartXkcd SetType(ChartXkcdType type) #
Returns: ChartXkcd

Sets the chart type.

Parameters

type HtmlForgeX.ChartXkcdType requiredposition: 0
public ChartXkcd ShowLabels(Boolean show = true) #
Returns: ChartXkcd
EditorBrowsable(2)

Shows or hides radar labels.

Parameters

show System.Boolean = true optionalposition: 0
public ChartXkcd ShowLegend(Boolean show = true) #
Returns: ChartXkcd
EditorBrowsable(2)

Shows or hides the legend.

Parameters

show System.Boolean = true optionalposition: 0
public ChartXkcd ShowLine(Boolean show = true) #
Returns: ChartXkcd
EditorBrowsable(2)

Connects or disconnects XY points with a line.

Parameters

show System.Boolean = true optionalposition: 0
Size 2 overloads
public ChartXkcd Size(TablerWidth width = null, TablerHeight height = null) #
Returns: ChartXkcd

Sets the SVG size.

Parameters

width HtmlForgeX.TablerWidth = null optionalposition: 0
height HtmlForgeX.TablerHeight = null optionalposition: 1
public ChartXkcd Size(String width = null, String height = null) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the SVG size from raw CSS lengths.

Parameters

width System.String = null optionalposition: 0
height System.String = null optionalposition: 1
public ChartXkcd StackedBar() #
Returns: ChartXkcd

Sets chart type to stacked bar.

StrokeColor 2 overloads
public ChartXkcd StrokeColor(RGBColor color) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the stroke color.

Parameters

color System.String requiredposition: 0
StrokeColor(HtmlForgeX.RGBColor color) #

Sets the stroke color.

Parameters

color HtmlForgeX.RGBColor required
public ChartXkcd TicksCount(Int32 count) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the radar tick count.

Parameters

count System.Int32 requiredposition: 0
public ChartXkcd TimeFormat(String timeFormat) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the XY time format.

Parameters

timeFormat System.String requiredposition: 0
public ChartXkcd Title(String title) #
Returns: ChartXkcd

Sets the chart title.

Parameters

title System.String requiredposition: 0
public override String ToString() #
Returns: String
public ChartXkcd Unxkcdify(Boolean unxkcdify = true) #
Returns: ChartXkcd
EditorBrowsable(2)

Enables or disables chart.xkcd's sketch effect.

Parameters

unxkcdify System.Boolean = true optionalposition: 0
public ChartXkcd XAxisLabel(String label) #
Returns: ChartXkcd

Sets the X-axis label.

Parameters

label System.String requiredposition: 0
public ChartXkcd XTickCount(Int32 count) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the X-axis tick count.

Parameters

count System.Int32 requiredposition: 0
public ChartXkcd XY() #
Returns: ChartXkcd

Sets chart type to XY.

public ChartXkcd YAxisLabel(String label) #
Returns: ChartXkcd

Sets the Y-axis label.

Parameters

label System.String requiredposition: 0
public ChartXkcd YTickCount(Int32 count) #
Returns: ChartXkcd
EditorBrowsable(2)

Sets the Y-axis tick count.

Parameters

count System.Int32 requiredposition: 0

Properties

public String Id { get; set; } #

Gets or sets the SVG element identifier.

public ChartXkcdType Type { get; set; } #

Gets or sets the chart type.

public String TitleText { get; set; } #

Gets or sets the chart title.

public String XLabel { get; set; } #

Gets or sets the X-axis label.

public String YLabel { get; set; } #

Gets or sets the Y-axis label.

public List<String> Labels { get; } #

Gets the categorical labels.

public ChartXkcdOptions Options { get; } #

Gets chart.xkcd rendering options.

public String Width { get; set; } #

Gets or sets the SVG width.

public String Height { get; set; } #

Gets or sets the SVG height.