Enum EmbeddedObjectVerb 

pub enum EmbeddedObjectVerb {
    AddChart {

        chart_type: String,
        domain: String,
        series: Vec<String>,
        sheet: Option<String>,
        title: Option<String>,
        subtitle: Option<String>,
        legend: Option<String>,
        stacked: Option<String>,
        header_count: Option<i64>,
        horizontal_axis_title: Option<String>,
        vertical_axis_title: Option<String>,
        pie_hole: Option<f64>,
        anchor: Option<String>,
        offset_x: Option<i64>,
        offset_y: Option<i64>,
        width: Option<i64>,
        height: Option<i64>,
        new_sheet: bool,
    
},
    UpdateChart {

        chart_id: i64,
        chart_type: Option<String>,
        domain: Option<String>,
        series: Vec<String>,
        sheet: Option<String>,
        title: Option<String>,
        subtitle: Option<String>,
        legend: Option<String>,
        stacked: Option<String>,
        header_count: Option<i64>,
        horizontal_axis_title: Option<String>,
        vertical_axis_title: Option<String>,
        pie_hole: Option<f64>,
    
},
    DeleteChart {
        chart_id: i64,
    },
    AddSlicer {
        sheet: Option<String>,
        range: String,
        column: i64,
        hide_values: Vec<String>,
        title: Option<String>,
        apply_to_pivot_tables: Option<bool>,
        anchor: String,
        offset_x: Option<i64>,
        offset_y: Option<i64>,
        width: Option<i64>,
        height: Option<i64>,
    },
    UpdateSlicer {
        slicer_id: i64,
        sheet: Option<String>,
        range: Option<String>,
        column: Option<i64>,
        hide_values: Vec<String>,
        clear_criteria: bool,
        title: Option<String>,
        apply_to_pivot_tables: Option<bool>,
    },
    DeleteSlicer {
        slicer_id: i64,
    },
    MoveChart {
        chart_id: i64,
        sheet: Option<String>,
        anchor: Option<String>,
        offset_x: Option<i64>,
        offset_y: Option<i64>,
        width: Option<i64>,
        height: Option<i64>,
        new_sheet: bool,
    },
    MoveSlicer {
        slicer_id: i64,
        sheet: Option<String>,
        anchor: Option<String>,
        offset_x: Option<i64>,
        offset_y: Option<i64>,
        width: Option<i64>,
        height: Option<i64>,
    },
    UpdateChartBorder {
        chart_id: i64,
        color: Option<String>,
        clear: bool,
    },
}

Which mutation to perform.

Variants

AddChart

Add a chart.

Fields

chart_type: String

column/bar/line/area/scatter/pie.

domain: String

The domain (category/x-axis) range.

series: Vec<String>

The data series ranges — exactly one for a pie chart, one or more for a basic chart.

sheet: Option<String>

Sheet title, supplying the prefix for domain/series/ anchor when they don’t carry their own.

title: Option<String>

The chart’s title.

subtitle: Option<String>

The chart’s subtitle.

legend: Option<String>

bottom/top/left/right/none.

stacked: Option<String>

none/stacked/percent — basic charts only.

header_count: Option<i64>

Leading rows/columns of the source range that are headers — basic charts only.

horizontal_axis_title: Option<String>

The horizontal (BOTTOM_AXIS) axis title — basic charts only.

vertical_axis_title: Option<String>

The vertical (LEFT_AXIS) axis title — basic charts only.

pie_hole: Option<f64>

0.0-1.0 center-hole radius — pie charts only.

anchor: Option<String>

The anchor cell, when not --new-sheet.

offset_x: Option<i64>

Additional horizontal offset from the anchor cell, in pixels.

offset_y: Option<i64>

Additional vertical offset from the anchor cell, in pixels.

width: Option<i64>

The chart’s width in pixels.

height: Option<i64>

The chart’s height in pixels.

new_sheet: bool

Put the chart on a brand-new sheet of its own, instead of anchoring it to an existing one. Mutually exclusive with anchor/offset_x/offset_y/width/height.

UpdateChart

Replace an existing chart’s spec.

Fields

chart_id: i64

Which chart to update, discovered via list-charts.

chart_type: Option<String>

Change the chart’s type, when set. Refused if it would switch between a basic chart and a pie chart.

domain: Option<String>

Replace the domain range, when set (requires series too).

series: Vec<String>

Replace every series wholesale, when non-empty.

sheet: Option<String>

Sheet title, supplying the prefix for domain/series when they don’t carry their own.

title: Option<String>

Change the title, when set.

subtitle: Option<String>

Change the subtitle, when set.

legend: Option<String>

Change the legend position, when set.

stacked: Option<String>

Change the stacking mode, when set — basic charts only.

header_count: Option<i64>

Change the header row/column count, when set — basic charts only.

horizontal_axis_title: Option<String>

Change the horizontal axis title, when set — basic charts only.

vertical_axis_title: Option<String>

Change the vertical axis title, when set — basic charts only.

pie_hole: Option<f64>

Change the pie-hole radius, when set — pie charts only.

DeleteChart

Remove a chart.

Fields

chart_id: i64

Which chart to remove, discovered via list-charts.

AddSlicer

Add a slicer.

Fields

sheet: Option<String>

Sheet title, supplying the prefix for range/anchor when they don’t carry their own.

range: String

The range the slicer filters.

column: i64

The absolute 0-based sheet column (0 = column A) the filter criteria apply to — not an offset within range. Must fall inside range’s columns.

hide_values: Vec<String>

Values to hide in column.

title: Option<String>

A human-readable name for the slicer.

apply_to_pivot_tables: Option<bool>

Whether the slicer also filters pivot tables built from range.

anchor: String

The anchor cell.

offset_x: Option<i64>

Additional horizontal offset from the anchor cell, in pixels.

offset_y: Option<i64>

Additional vertical offset from the anchor cell, in pixels.

width: Option<i64>

The slicer’s width in pixels.

height: Option<i64>

The slicer’s height in pixels.

UpdateSlicer

Change an existing slicer’s range, filter column/criteria, title, or pivot-table linkage.

Fields

slicer_id: i64

Which slicer to change, discovered via list-slicers.

sheet: Option<String>

Sheet title, supplying the prefix for range when it doesn’t carry its own.

range: Option<String>

Replace the filtered range, when set.

column: Option<i64>

Replace the filtered column, when set — an absolute 0-based sheet column (0 = column A), which must fall inside the slicer’s (new or existing) range.

hide_values: Vec<String>

Replace the hidden-value criteria, when non-empty.

clear_criteria: bool

Reset the filter criteria to empty.

title: Option<String>

Change the title, when set.

apply_to_pivot_tables: Option<bool>

Change the pivot-table linkage, when set.

DeleteSlicer

Remove a slicer.

Fields

slicer_id: i64

Which slicer to remove, discovered via list-slicers.

MoveChart

Move and/or resize an existing chart (issue #1837).

Fields

chart_id: i64

Which chart to move, discovered via list-charts.

sheet: Option<String>

Sheet title, supplying the prefix for anchor when it doesn’t carry its own.

anchor: Option<String>

The new anchor cell, when the chart stays (or becomes) an overlay. Required for a chart on its own sheet, which has no existing anchor to carry forward.

offset_x: Option<i64>

Additional horizontal offset from the anchor cell, in pixels.

offset_y: Option<i64>

Additional vertical offset from the anchor cell, in pixels.

width: Option<i64>

The chart’s new width in pixels.

height: Option<i64>

The chart’s new height in pixels.

new_sheet: bool

Move the chart onto a brand-new sheet of its own. Mutually exclusive with every other field but chart_id.

MoveSlicer

Move and/or resize an existing slicer (issue #1837). No own-sheet placement — a slicer can only ever be an overlay.

Fields

slicer_id: i64

Which slicer to move, discovered via list-slicers.

sheet: Option<String>

Sheet title, supplying the prefix for anchor when it doesn’t carry its own.

anchor: Option<String>

The new anchor cell, when set.

offset_x: Option<i64>

Additional horizontal offset from the anchor cell, in pixels.

offset_y: Option<i64>

Additional vertical offset from the anchor cell, in pixels.

width: Option<i64>

The slicer’s new width in pixels.

height: Option<i64>

The slicer’s new height in pixels.

UpdateChartBorder

Set or clear a chart’s border colour (issue #1837).

Fields

chart_id: i64

Which chart to update, discovered via list-charts.

color: Option<String>

The new border colour, as #RRGGBB. Mutually exclusive with clear.

clear: bool

Remove the chart’s border entirely. Mutually exclusive with color.

Trait Implementations

impl Clone for EmbeddedObjectVerb

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddedObjectVerb

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

Formats the value using the given formatter.

impl PartialEq for EmbeddedObjectVerb

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EmbeddedObjectVerb