Struct Chart 

pub struct Chart<K: Kind> { /* private fields */ }

A D3 chart. Render it in a Maud template.

use autumn_plugin_d3::{Chart, Format};

let chart = Chart::bar([("Apples", 3.0), ("Pears", 5.0)])
    .label("Fruit sold")
    .y_label("Units")
    .format(Format::integer());
let html = autumn_web::html! { (chart) }.into_string();
assert!(html.contains(r#"data-d3="bar""#), "{html}");
assert!(html.contains("<table"), "fallback table: {html}");

Implementations

impl<K: Kind> Chart<K>

pub fn attribute(&self, name: &str) -> Option<&str>

The value of an emitted data-d3-* option attribute, for example "data-d3-label". For data-d3 use kind; for data-d3-data use data_json.

pub fn kind(&self) -> &str

The data-d3 kind name.

pub fn id(self, id: impl Into<String>) -> Self

Sets the element id.

pub fn class(self, class: impl Into<String>) -> Self

Adds CSS classes to the figure, after d3-chart.

pub fn label(self, label: impl Into<String>) -> Self

Sets the accessible name of the chart. It is also the table caption. Without it, the runtime uses the caption text.

pub fn caption(self, caption: impl Into<String>) -> Self

Adds a visible <figcaption>.

pub fn format(self, format: Format) -> Self

Sets the value format (axis ticks and tooltips).

pub fn x_label(self, label: impl Into<String>) -> Self

Sets the x title (bottom axis) and the first table header.

pub fn y_label(self, label: impl Into<String>) -> Self

Sets the value title (value axis) and the value table header.

pub fn colors(self, colors: impl IntoIterator<Item = Color>) -> Self

Sets the series colors, in order. They replace the palette. At most 16 colors are used.

pub fn aspect(self, ratio: f64) -> Self

Sets the plot width / height ratio. The value is clamped to 0.2..=10. The default is 16 / 9 (from d3.css).

pub fn duration(self, duration: Duration) -> Self

Sets the transition time. Zero turns transitions off. At most 10 s.

pub fn animate_reduced_motion(self) -> Self

Animates also for users who ask for reduced motion.

pub fn src(self, url: impl Into<String>) -> Self

Loads the data from a same-origin JSON URL. The JSON has the same shape as the inline data. Inline data, if any, shows first.

pub fn refresh(self, every: Duration) -> Self

Loads src again at this interval. The interval is clamped to 1 s ..= 24 h. Without src, the runtime ignores it.

pub const fn table(self, show: bool) -> Self

Includes the fallback data table (default true).

pub fn data_json(&self) -> Option<String>

The JSON for data-d3-data, if the chart has inline data.

impl<K: BuiltIn> Chart<K>

pub fn from_src(url: impl Into<String>) -> Self

Makes a chart with no inline data. It loads the data from url.

use autumn_plugin_d3::{Bar, Chart};

let chart = Chart::<Bar>::from_src("/api/sales.json");
assert_eq!(chart.attribute("data-d3-src"), Some("/api/sales.json"));

impl<K: Axes> Chart<K>

pub fn y_min(self, min: f64) -> Self

Sets the lower end of the value axis. The data can extend it.

pub fn y_max(self, max: f64) -> Self

Sets the upper end of the value axis. The data can extend it.

impl<K: Xy> Chart<K>

pub fn x_scale(self, scale: Scale) -> Self

Sets the x scale type. With Scale::Time, x is Unix milliseconds.

pub fn y_scale(self, scale: Scale) -> Self

Sets the y scale type. Scale::Time is not a y scale; it means Scale::Linear.

pub fn x_format(self, format: Format) -> Self

Sets the x tick format. Time scales ignore it.

impl<K: Curved> Chart<K>

pub fn curve(self, curve: Curve) -> Self

Sets the line interpolation.

pub fn dots(self) -> Self

Draws a dot on each point.

impl<K: Legend> Chart<K>

pub fn legend(self, show: bool) -> Self

Shows or hides the legend. The default shows it for two or more series or slices.

impl Chart<Bar>

pub fn bar<D: Into<Datum>>(data: impl IntoIterator<Item = D>) -> Self

Makes a bar chart. Repeated labels draw as separate bars.

pub fn horizontal(self) -> Self

Draws horizontal bars.

impl Chart<Pie>

pub fn pie<D: Into<Datum>>(data: impl IntoIterator<Item = D>) -> Self

Makes a pie chart. Repeated labels draw as separate slices.

pub fn donut(self, inner: f64) -> Self

Makes a donut. inner is the hole radius as a fraction of the outer radius, clamped to 0..=0.95.

impl Chart<Line>

pub fn line(series: impl IntoIterator<Item = Series>) -> Self

Makes a line chart.

impl Chart<Area>

pub fn area(series: impl IntoIterator<Item = Series>) -> Self

Makes an area chart. Each series fills down to zero (or to the lower end of the value axis).

impl Chart<Scatter>

pub fn scatter(series: impl IntoIterator<Item = Series>) -> Self

Makes a scatter chart.

pub fn radius(self, px: f64) -> Self

Sets the dot radius in pixels, clamped to 1..=50. Default 4.

impl Chart<Custom>

pub fn custom(name: impl Into<String>) -> Result<Self, Error>

Makes a custom chart. name is the kind name that AutumnD3.register uses in JavaScript.

Errors

Error::InvalidKind when name is not 1–64 characters of a-z, 0-9, and -, starting with a letter, or when it is a built-in kind name.

use autumn_plugin_d3::Chart;

let chart = Chart::custom("network").unwrap().json(&[1, 2, 3]).unwrap();
assert_eq!(chart.data_json().as_deref(), Some("[1,2,3]"));
assert!(Chart::custom("Bad Name").is_err());

pub fn json<T: Serialize + ?Sized>(self, data: &T) -> Result<Self, Error>

Sets the inline data from any serializable value.

Errors

Error::Json when the value does not serialize (for example, a map with non-string keys).

Trait Implementations

impl<K: Clone + Kind> Clone for Chart<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: Debug + Kind> Debug for Chart<K>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<K: PartialEq + Kind> PartialEq for Chart<K>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<K: Kind> Render for Chart<K>

fn render(&self) -> Markup

Renders self as a block of Markup.

fn render_to(&self, buffer: &mut String)

Appends a representation of self to the given buffer.

impl<K: PartialEq + Kind> StructuralPartialEq for Chart<K>