Struct plotly_types::traces::scattergl::Scattergl

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

The data visualized as scatter point or lines is set in x and y using the WebGL plotting engine. Bubble charts are achieved by setting marker.size and/or marker.color to a numerical arrays.

Implementations

impl<'a> Scattergl<'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 showlegend(&mut self, showlegend: bool) -> &mut Self

Determines whether or not an item corresponding to this trace is shown in the legend.

default: true

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

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

default: ``

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 selectedpoints(&mut self, selectedpoints: Any) -> &mut Self

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

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: all

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 x(&mut self, x: &'a [f64]) -> &mut Self

Sets the x coordinates.

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

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

default: 0

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

Sets the x coordinate step. See x0 for more info.

default: 1

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

Sets the y coordinates.

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

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

default: 0

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

Sets the y coordinate step. See y0 for more info.

default: 1

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

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

default: ``

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

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

default: ``

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

Sets the positions of the text elements with respects to the (x,y) coordinates.

default: middle center

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

Sets the text font.

pub fn mode(&mut self) -> &mut Mode

Determines the drawing mode for this scatter trace.

pub fn line(&mut self) -> &mut Line<'a>

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

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

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

default: false

pub fn fill(&mut self, fill: Fill) -> &mut Self

Sets the area to fill with a solid color. Defaults to none unless this trace is stacked, then it gets tonexty (tonextx) if orientation is v (h) Use with fillcolor if not none. tozerox and tozeroy fill to x=0 and y=0 respectively. tonextx and tonexty fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like tozerox and tozeroy. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

default: none

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

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

pub fn selected(&mut self) -> &mut Selected<'a>

pub fn unselected(&mut self) -> &mut Unselected<'a>

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

Sets the opacity of the trace.

default: 1

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. 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 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.

default: ``

pub fn error_x(&mut self) -> &mut ErrorX<'a>

pub fn error_y(&mut self) -> &mut ErrorY<'a>

pub fn xcalendar(&mut self, xcalendar: Xcalendar) -> &mut Self

Sets the calendar system to use with x date data.

default: gregorian

pub fn ycalendar(&mut self, ycalendar: Ycalendar) -> &mut Self

Sets the calendar system to use with y date data.

default: gregorian

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

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

default: x

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

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

default: y

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 hoverinfosrc(&mut self, hoverinfosrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for hoverinfo .

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

Sets the source reference on Chart Studio Cloud for x .

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

Sets the source reference on Chart Studio Cloud for y .

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

Sets the source reference on Chart Studio Cloud for text .

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

Sets the source reference on Chart Studio Cloud for hovertext .

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

Sets the source reference on Chart Studio Cloud for textposition .

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

Sets the source reference on Chart Studio Cloud for hovertemplate .

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

Sets the source reference on Chart Studio Cloud for texttemplate .

Trait Implementations

impl<'a> Default for Scattergl<'a>

fn default() -> Scattergl<'a>

Returns the "default value" for a type.

impl<'a> Serialize for Scattergl<'a>

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

Serialize this value into the given Serde serializer.