public string Spec { get ; set ; }

Gets or sets the chart's spec as Flint chart JSON. Setting it replaces everything the fluent methods set, and redraws.

public string Error

Gets why the chart could not be drawn the last time it was tried, or null when it was (or has not been tried yet).

public bool IsDrawn

Gets whether a chart is on screen.

public static string ChartTypeName(FlintChartType type)

The name Flint gives type in a spec's chartType, e.g. "Scatter Plot".

public FlintChart ChartType(FlintChartType type)

Sets the chart type, keeping the data and the encodings, and redraws.

public FlintChart Columns(params string[] names)

Names the fields of the rows AddRow and Data{T} add, in order, and drops the rows there were.

public FlintChart AddRow(params object[] values)

Adds one row, a value per field named by Columns. A value can be a string, a number, a bool, a DateTime (written as an ISO date) or null.

public FlintChart Data<T>(IEnumerable<T> items, Func<T, object[]> values)

Adds a row per item, with a value per field named by Columns.

public FlintChart DataJson(string rowsJson)

Replaces the data with rows given as a JSON array of objects, one property per field.

public FlintChart DataUrl(string url)

Draws the data from a JSON or CSV file at url, in place of rows given here. The file is a request to whatever server hosts it.

public FlintChart ClearData()

Drops every row.

public FlintChart SemanticType(string field, FlintSemanticType type)

Says what field means, which decides how Flint encodes, scales and formats it.

public FlintChart RemoveEncoding(FlintChannel channel)

Takes channel off the chart.

public FlintChart X(string field)

Draws field along x.

public FlintChart Y(string field)

Draws field along y.

public FlintChart ColorBy(string field)

Colours the marks by field.

public FlintChart Title(string title)

The headline: what the chart says, in words.

public FlintChart Subtitle(string subtitle)

The reading of the headline: what is measured, of whom, when, in what units.

public FlintChart Label(string label)

A short line above the headline, such as a figure label.

public FlintChart Source(string text, string href = null)

Where the data comes from, drawn as the chart's source line; a link when href is given.

public FlintChart Property(string name, object value)

Sets one of the chart type's own properties (Flint's chartProperties), such as innerRadius, showPoints, stackMode, binCount, cornerRadius or region. null unsets it.

public FlintChart BaseSize(int width, int height)

The size the chart is laid out for when its data fits comfortably (Flint's default is 400 by 320); it still fits the width it has.

public FlintChart Tooltips(bool show = true)

Whether hovering a mark shows its values (on by default).

public FlintChart Interactions(params FlintInteraction[] interactions)

Replaces the chart's interactions (Flint's interaction_spec) with these presets; none removes them.

public FlintChart ChartTheme(IFlintTheme theme, bool overrideSpecTheme = false)

The theme the chart is drawn in when its spec names none (Tesserae by default), or in any case when overrideSpecTheme is set.

public FlintChart FillHeight(bool fill = true)

Lays the chart out for the height it is given (with .Height(...), .HS() or .Grow()) as well as its width. By default the chart chooses its own height for the width it has.

public FlintChart OnElementClick(Action<FlintChartClick> onClick)

Called when a mark, a series (a line or an area), a key entry or a category's axis label is clicked, with what was clicked and the rows of the data it stands for. A click reported here changes nothing on the chart; add ClickHighlight to also emphasise what was clicked.

public FlintChart OnError(Action<string> onError)

Called with the reason the chart cannot be drawn (a field that is not in the data, a channel the chart type does not have, the library failing to load), once per failed attempt.

public FlintChart Refresh()

Draws the chart again now, rather than once the current change settles.

Mark

One mark: a bar, a point, a slice, a cell. Its row (or the rows it sums) is in Rows.

Series

A line or an area, which stands for a whole series: every row of the series.

LegendEntry

An entry in the chart's key: every row of that series or category.

AxisLabel

A category's label on an axis: every row of that category.

public FlintChartClickTarget Target { get; }

What kind of thing was clicked.

public string Role { get; }

The role Flint gives what was clicked, e.g. bar, symbol, arc, line, legend-item, axis-label.

public IReadOnlyList<FlintChartRow> Rows { get; }

The rows of the chart's data the clicked thing stands for: one for a mark drawn from one row, more for a series, a key entry, a category or a mark that sums several.

public FlintChartRow Row

The first of Rows, or null.

public string Field { get; }

For a key entry or an axis label, the field it names; otherwise null.

public object Value { get; }

For a key entry or an axis label, the value it names (a category, a series); otherwise null.

internal static FlintChartClick From(object detail)

Reads Flint's interaction event; null for anything that is not a click on something.

public string[] Fields

The fields the row has, in its own order.

public object this[string field]

The value of field as it was given: a string, a number, a boolean or null.

public bool Has(string field)

Whether the row has field.

public string GetString(string field)

The value of field as text, or null when the row has none.

public double? GetNumber(string field)

The value of field as a number, or null when it is not one.

public string ToJson()

The row as JSON.

ScatterPlot

Points at x and y. Channels: x, y, color, size, shape, detail, opacity, column, row.

MarginalPlot

A scatter plot with the distribution of each axis on its margin. Channels: x, y, color, size, shape, opacity.

Regression

A scatter plot with its fitted trend line (regressionMethod: linear, log, exp, pow, quad, poly). Channels: x, y, size, color, column, row.

ConnectedScatterPlot

Points joined in the order of a field. Channels: x, y, order, color, detail, column, row.

RangedDotPlot

The span between two values of each category, drawn as two dots and a rule. Channels: x, y, color.

StripPlot

Every value of a measure as a tick or dot along one axis per category. Channels: x, y, color, size, column, row.

BarChart

One bar per category. Channels: x, y, color, opacity, column, row.

GroupedBarChart

Bars side by side within each category, one per group. Channels: x, y, group, color, column, row.

StackedBarChart

Bars stacked within each category, by color (stackMode: stacked, normalize, center). Channels: x, y, color, column, row.

LollipopChart

A stem and a dot per category. Channels: x, y, color, column, row.

WaterfallChart

Running totals as floating bars, rises and falls in their own colours. Channels: x, y, color, column, row.

GanttChart

Tasks as bars from x to x2 along a timeline. Channels: y, x, x2, color, detail, column, row.

BulletChart

A measure against its goal, as a bar on qualitative bands. Channels: y, x, goal, color, column, row.

Histogram

A measure binned into counts (binCount). Channels: x, color, column, row.

DensityPlot

A smoothed distribution of a measure. Channels: x, color, column, row.

RidgelinePlot

One density per category, overlapping like ridges. Channels: x, y, color.

EcdfPlot

The cumulative share of rows at or below each value. Channels: x, color, detail, column, row.

ViolinPlot

The distribution of a measure per category, mirrored. Channels: x, y, color, row.

Boxplot

Quartiles, whiskers and outliers of a measure per category. Channels: x, y, color, opacity, column, row.

PyramidChart

Two distributions back to back, such as a population by age and sex. Channels: x, y, color.

CandlestickChart

Open, high, low and close per period. Channels: x, open, high, low, close, column, row.

LineChart

A measure over a continuous axis, one line per color. Channels: x, y, color, strokeDash, detail, opacity, column, row.

Sparkline

A small line without axes, for a trend at a glance. Channels: x, y, color, detail, row, column.

BumpChart

The rank of each series over time. Channels: x, y, color, detail, column, row.

SlopeChart

A change between two points in time, one line per series. Channels: x, y, color, detail, column, row.

AreaChart

A line with the area under it filled, stacked by color. Channels: x, y, color, opacity, column, row.

Streamgraph

Stacked areas around a moving centre line. Channels: x, y, color, column, row.

RangeAreaChart

The band between y and y2 over x. Channels: x, y, y2, color, column, row.

PieChart

Shares of a whole as slices; the measure is size. Channels: size, color, column, row.

DonutChart

A pie with a hole (innerRadius). Channels: size, color, column, row.

RoseChart

Equal-angle wedges whose radius is the measure. Channels: x, y, color, column, row.

RadarChart

Measures on spokes around a centre, one polygon per series. Channels: x, y, color, column, row.

Heatmap

A grid of x by y cells coloured by a measure. Channels: x, y, color, column, row.

CalendarHeatmap

A measure per day, laid out as weeks of a year. Channels: x, color.

BarTable

A table with an inline bar per row. Channels: y, x, color, column, row.

KpiCard

One headline number per metric, with its goal. Channels: metric, value, goal.

Table

The rows themselves, as a table. No channels.

Map

Points at longitude and latitude on a map (region). Channels: longitude, latitude, color, size, opacity.

Choropleth

Regions of a map coloured by a measure (region, level). Channels: id, color, detail.

Column

Small multiples: one panel per value, side by side.

Row

Small multiples: one panel per value, one under another.

Inspect

Move the pointer to read values with guides.

InspectIndex

Move along one axis to read every series at that position.

ClickHighlight

Click a mark, key entry or axis label to emphasise it and mute the rest.

AxisHighlight

Hover or click a category's axis label to emphasise it.

ClickGroupFocus

Click a mark to emphasise every mark of its group.

HoverGroupFocus

Hover a mark to preview its group.

ClickAnnotate

Click a mark to pin an annotation on it.

Select

Drag a rectangle to emphasise the marks inside it.

LassoSelect

Draw a freehand region to emphasise the marks inside it.

BrushX

Drag an interval along x.

BrushY

Drag an interval along y.

BrushAngle

Drag an angular sector on a polar chart.

BrushZoom

Drag a rectangle to zoom to it.

LinkedBrush

Brush marks and emphasise every mark of their group.

LegendToggle

Click a key entry to hide or restore its series.

LongPress

Hold on a mark to emphasise it.

DoubleActivate

Double-click a mark to emphasise it.

Navigate

Drag to pan, wheel or pinch to zoom.

DragReorder

Drag a mark or an axis label to reorder the categories.

AccessibleNavigation

Tab into the chart and walk it with the keyboard.

internal static bool TryChartType(string name, out FlintChartType type)

The chart type Flint calls name, if it is one of them.

public FlintEncoding(string field)

Parameters

field

The field of the data the channel draws.

public string Field { get; set; }

The field of the data the channel draws.

public FlintEncodingType? Type { get; set; }

The encoding type, in place of the one the semantic type implies.

public FlintAggregate? Aggregate { get; set; }

How the rows behind one mark are summed.

public bool? SortAscending { get; set; }

Sorts the channel's categories by their value, ascending (true) or descending (false).

public string SortBy { get; set; }

The field the channel's categories are sorted by, with SortAscending.

public string Scheme { get; set; }

Colour channel: a Vega scheme name (viridis, redblue), in place of the theme's ramp.

public string[] SchemeColors { get; set; }

Colour channel: the stops a ramp or palette runs through, low end first, as #rrggbb.

public bool Reverse { get; set; }

Colour channel: runs the scale the other way round.

public string Title { get; set; }

The name the channel's axis or key prints, in place of the field's; an empty string prints none.

internal object ToSpec()

The encoding as Flint reads it.