Struct Groupby

pub struct Groupby<'a> { /* private fields */ }

Implementations

impl<'a> Groupby<'a>

pub fn enabled(&mut self, enabled: bool) -> &mut Self

Determines whether this group-by transform is enabled or disabled.

default: true

pub fn groups(&mut self, groups: &'a [f64]) -> &mut Self

Sets the groups in which the trace data will be split. For example, with x set to [1, 2, 3, 4] and groups set to [‘a’, ‘b’, ‘a’, ‘b’], the groupby transform with split in one trace with x [1, 3] and one trace with x [2, 4].

default: []

pub fn nameformat(&mut self, nameformat: &'a str) -> &mut Self

Pattern by which grouped traces are named. If only one trace is present, defaults to the group name ("%{group}"), otherwise defaults to the group name with trace name ("%{group} (%{trace})"). Available escape sequences are %{group}, which inserts the group name, and %{trace}, which inserts the trace name. If grouping GDP data by country when more than one trace is present, for example, the default “%{group} (%{trace})” would return “Monaco (GDP per capita)”.

pub fn groupssrc(&mut self, groupssrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for groups .

Trait Implementations

impl<'a> Default for Groupby<'a>

fn default() -> Groupby<'a>

Returns the “default value” for a type.

impl<'a> Serialize for Groupby<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.