Struct plotly_types::traces::treemap::Treemap

pub struct Treemap<'a> { /* fields omitted */ }

Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The treemap sectors are determined by the entries in labels or ids and in parents.

Implementations

impl<'a> Treemap<'a>

pub fn visible(&mut self, visible: Visible) -> &mut Self

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

default: true

pub fn opacity(&mut self, opacity: f64) -> &mut Self

Sets the opacity of the trace.

default: 1

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

Sets the trace name. The trace name appear as the legend item and on hover.

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

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

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

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

pub fn meta(&mut self, meta: Any) -> &mut Self

Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

pub fn hoverlabel(&mut self) -> &mut Hoverlabel<'a>

pub fn stream(&mut self) -> &mut Stream<'a>

pub fn uirevision(&mut self, uirevision: Any) -> &mut Self

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

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

Sets the labels of each of the sectors.

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

Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be "ids" themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

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

Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

pub fn branchvalues(&mut self, branchvalues: Branchvalues) -> &mut Self

Determines how the items in values are summed. When set to total, items in values are taken to be value of all its descendants. When set to remainder, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

default: remainder

pub fn count(&mut self) -> &mut Count

Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.

default: leaves

pub fn level(&mut self, level: Any) -> &mut Self

Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an "id" if ids is filled in, otherwise plotly attempts to find a matching item in labels.

pub fn maxdepth(&mut self, maxdepth: u64) -> &mut Self

Sets the number of rendered sectors from any given level. Set maxdepth to -1 to render all the levels in the hierarchy.

default: -1

pub fn tiling(&mut self) -> &mut Tiling

pub fn marker(&mut self) -> &mut Marker<'a>

pub fn pathbar(&mut self) -> &mut Pathbar<'a>

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

Sets text elements associated with each sector. If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

pub fn textinfo(&mut self) -> &mut Textinfo

Determines which trace information appear on the graph.

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

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

default: ``

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

Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace hoverinfo must contain a text flag.

default: ``

pub fn hoverinfo(&mut self) -> &mut Hoverinfo

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

default: label+text+value+name

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

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

default: ``

pub fn textfont(&mut self) -> &mut Textfont<'a>

Sets the font used for textinfo.

pub fn insidetextfont(&mut self) -> &mut Insidetextfont<'a>

Sets the font used for textinfo lying inside the sector.

pub fn outsidetextfont(&mut self) -> &mut Outsidetextfont<'a>

Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and insidetextfont would be used.

pub fn textposition(&mut self, textposition: Textposition) -> &mut Self

Sets the positions of the text elements.

default: top left

pub fn domain(&mut self) -> &mut Domain<'a>

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

Sets the source reference on Chart Studio Cloud for ids .

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

Sets the source reference on Chart Studio Cloud for customdata .

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

Sets the source reference on Chart Studio Cloud for meta .

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

Sets the source reference on Chart Studio Cloud for labels .

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

Sets the source reference on Chart Studio Cloud for parents .

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

Sets the source reference on Chart Studio Cloud for values .

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

Sets the source reference on Chart Studio Cloud for text .

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

Sets the source reference on Chart Studio Cloud for texttemplate .

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

Sets the source reference on Chart Studio Cloud for hovertext .

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

Sets the source reference on Chart Studio Cloud for hoverinfo .

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

Sets the source reference on Chart Studio Cloud for hovertemplate .

Trait Implementations

impl<'a> Default for Treemap<'a>

fn default() -> Treemap<'a>

Returns the "default value" for a type.

impl<'a> Serialize for Treemap<'a>

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

Serialize this value into the given Serde serializer.