Struct AreaChart 

pub struct AreaChart { /* private fields */ }

Area chart block representation.

Fields and Validations

For more details, see the official documentation.

Field	Type	Required	Validation
series	Vec<DataSeries>	Yes	Min 1, Max 6 items, Unique names, Labels must match axis categories
axis_config	AxisConfig	Yes	N/A

Example

use slack_messaging::blocks::data_visualization::charts::{data_points, DataSeries, AreaChart,
AxisConfig};

let area_chart = AreaChart::builder()
    .series(vec![
        DataSeries::builder()
            .name("Pied Piper Free Tier")
            .data(data_points(vec![
                ("Mon", 12000),
                ("Tue", 13500),
                ("Wed", 15200),
                ("Thu", 14800),
                ("Fri", 16400),
            ])?)
            .build()?,
        DataSeries::builder()
            .name("Pied Piper Paid Tier")
            .data(data_points(vec![
                ("Mon", 4500),
                ("Tue", 4800),
                ("Wed", 5100),
                ("Thu", 5600),
                ("Fri", 6200),
            ])?)
            .build()?,
    ])
    .axis_config(
        AxisConfig::builder()
            .categories(vec![
                "Mon",
                "Tue",
                "Wed",
                "Thu",
                "Fri",
            ])
            .x_label("Day")
            .y_label("Users")
            .build()?
    )
    .build()?;

let expected = serde_json::json!({
    "type": "area",
    "series": [
        {
            "name": "Pied Piper Free Tier",
            "data": [
                { "label": "Mon", "value": 12000 },
                { "label": "Tue", "value": 13500 },
                { "label": "Wed", "value": 15200 },
                { "label": "Thu", "value": 14800 },
                { "label": "Fri", "value": 16400 }
            ]
        },
        {
            "name": "Pied Piper Paid Tier",
            "data": [
                { "label": "Mon", "value": 4500 },
                { "label": "Tue", "value": 4800 },
                { "label": "Wed", "value": 5100 },
                { "label": "Thu", "value": 5600 },
                { "label": "Fri", "value": 6200 }
            ]
        }
    ],
    "axis_config": {
        "categories": [
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri"
        ],
        "x_label": "Day",
        "y_label": "Users"
    }
});

let json = serde_json::to_value(area_chart).unwrap();

assert_eq!(json, expected);

Implementations

impl AreaChart

pub fn builder() -> AreaChartBuilder

constract AreaChartBuilder object.

Trait Implementations

impl Clone for AreaChart

fn clone(&self) -> AreaChart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AreaChart

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

Formats the value using the given formatter.

impl From<AreaChart> for Chart

fn from(value: AreaChart) -> Self

Converts to this type from the input type.

impl PartialEq for AreaChart

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AreaChart

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AreaChart