Struct Xaxis

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

Implementations

impl<'a> Xaxis<'a>

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

A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false

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

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

default: #444

pub fn title(&mut self) -> &mut Title<'a>

pub fn autorange(&mut self, autorange: Autorange) -> &mut Self

Determines whether or not the range of this axis is computed in relation to the input data. See rangemode for more info. If range is provided, then autorange is set to false.

default: true

pub fn rangemode(&mut self, rangemode: Rangemode) -> &mut Self

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

default: normal

pub fn range(&mut self, range: &'a InfoArray) -> &mut Self

Sets the range of this axis. If the axis type is log, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axis type is date, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is category, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

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

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

default: false

pub fn scaleanchor(&mut self, scaleanchor: Scaleanchor) -> &mut Self

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden.

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

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

default: 1

pub fn constrain(&mut self, constrain: Constrain) -> &mut Self

If this axis needs to be compressed (either due to its own scaleanchor and scaleratio or those of the other axis), determines how that happens: by increasing the range (default), or by decreasing the domain.

default: range

pub fn constraintoward(&mut self, constraintoward: Constraintoward) -> &mut Self

If this axis needs to be compressed (either due to its own scaleanchor and scaleratio or those of the other axis), determines which direction we push the originally specified plot area. Options are left, center (default), and right for x axes, and top, middle (default), and bottom for y axes.

pub fn matches(&mut self, matches: Matches) -> &mut Self

If set to another axis id (e.g. x2, y), the range of this axis will match the range of the corresponding axis in data-coordinates space. Moreover, matching axes share auto-range values, category lists and histogram auto-bins. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Moreover, note that matching axes must have the same type.

pub fn tickmode(&mut self, tickmode: Tickmode) -> &mut Self

Sets the tick mode for this axis. If auto, the number of ticks is set via nticks. If linear, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (linear is the default value if tick0 and dtick are provided). If array, the placement of the ticks is set via tickvals and the tick text is ticktext. (array is the default value if tickvals is provided).

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

Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to auto.

default: 0

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

Sets the placement of the first tick on this axis. Use with dtick. If the axis type is log, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick=L (see dtick for more info). If the axis type is date, it should be a date string, like date data. If the axis type is category, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

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

Sets the step in-between ticks on this axis. Use with tick0. Must be a positive number, or special strings available to log and date axes. If the axis type is log, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. log has several special values; L, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = L0.5 will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use D1 (all digits) or D2 (only 2 and 5). tick0 is ignored for D1 and D2. If the axis type is date, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. date also has special values M gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to 2000-01-15 and dtick to M3. To set ticks every 4 years, set dtick to M48

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

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

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

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

pub fn ticks(&mut self, ticks: Ticks) -> &mut Self

Determines whether ticks are drawn or not. If **, this axis’ ticks are not drawn. If outside (inside), this axis’ are drawn outside (inside) the axis lines.

pub fn tickson(&mut self, tickson: Tickson) -> &mut Self

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

default: labels

pub fn mirror(&mut self, mirror: Mirror) -> &mut Self

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

default: false

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

Sets the tick length (in px).

default: 5

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

Sets the tick width (in px).

default: 1

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

Sets the tick color.

default: #444

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

Determines whether or not the tick labels are drawn.

default: true

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

Determines whether long tick labels automatically grow the figure margins.

default: false

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

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

default: false

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

Sets the spike color. If undefined, will use the series color

default: null

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

Sets the width (in px) of the zero line.

default: 3

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

Sets the dash style of lines. Set to a dash type string (solid, dot, dash, longdash, dashdot, or longdashdot) or a dash length list in px (eg 5px,10px,2px,2px).

default: dash

pub fn spikemode(&mut self) -> &mut Spikemode

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

default: toaxis

pub fn spikesnap(&mut self, spikesnap: Spikesnap) -> &mut Self

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

default: data

pub fn tickfont(&mut self) -> &mut Tickfont<'a>

Sets the tick font.

pub fn tickangle(&mut self, tickangle: Angle) -> &mut Self

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

default: auto

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

Sets a tick label prefix.

default: ``

pub fn showtickprefix(&mut self, showtickprefix: Showtickprefix) -> &mut Self

If all, all tick labels are displayed with a prefix. If first, only the first tick is displayed with a prefix. If last, only the last tick is displayed with a suffix. If none, tick prefixes are hidden.

default: all

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

Sets a tick label suffix.

default: ``

pub fn showticksuffix(&mut self, showticksuffix: Showticksuffix) -> &mut Self

Same as showtickprefix but for tick suffixes.

default: all

pub fn showexponent(&mut self, showexponent: Showexponent) -> &mut Self

If all, all exponents are shown besides their significands. If first, only the exponent of the first tick is shown. If last, only the exponent of the last tick is shown. If none, no exponents appear.

default: all

pub fn exponentformat(&mut self, exponentformat: Exponentformat) -> &mut Self

Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If none, it appears as 1,000,000,000. If e, 1e+9. If E, 1E+9. If power, 1x10^9 (with 9 in a super script). If SI, 1G. If B, 1B.

default: B

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

If “true”, even 4-digit integers are separated

default: false

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

Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3’s date formatter: %{n}f for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat %H~%M~%S.%2f would display 09~15~23.46

default: ``

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

Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format We add one item to d3’s date formatter: %{n}f for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat %H~%M~%S.%2f would display 09~15~23.46

default: ``

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

Determines whether or not a line bounding this axis is drawn.

default: false

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

Sets the axis line color.

default: #444

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

Sets the width (in px) of the axis line.

default: 1

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

Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.

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

Sets the color of the grid lines.

default: #eee

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

Sets the width (in px) of the grid lines.

default: 1

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

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

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

Sets the line color of the zero line.

default: #444

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

Sets the width (in px) of the zero line.

default: 1

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

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

default: true

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

Sets the color of the dividers Only has an effect on multicategory axes.

default: #444

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

Sets the width (in px) of the dividers Only has an effect on multicategory axes.

default: 1

pub fn anchor(&mut self, anchor: Anchor) -> &mut Self

If set to an opposite-letter axis id (e.g. x2, y), this axis is bound to the corresponding opposite-letter axis. If set to free, this axis’ position is determined by position.

pub fn side(&mut self, side: Side) -> &mut Self

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

pub fn overlaying(&mut self, overlaying: Overlaying) -> &mut Self

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

pub fn layer(&mut self, layer: Layer) -> &mut Self

Sets the layer on which this axis is displayed. If above traces, this axis is displayed above all the subplot’s traces If below traces, this axis is displayed below all the subplot’s traces, but above the grid lines. Useful when used together with scatter-like traces with cliponaxis set to false to show markers and/or text nodes above this axis.

default: above traces

pub fn domain(&mut self, domain: &'a InfoArray) -> &mut Self

Sets the domain of this axis (in plot fraction).

default: [0,1]

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

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

default: 0

pub fn categoryorder(&mut self, categoryorder: Categoryorder) -> &mut Self

Specifies the ordering logic for the case of categorical variables. By default, plotly uses trace, which specifies the order that is present in the data supplied. Set categoryorder to category ascending or category descending if order should be determined by the alphanumerical order of the category names. Set categoryorder to array to derive the ordering from the attribute categoryarray. If a category is not found in the categoryarray array, the sorting behavior for that attribute will be identical to the trace mode. The unspecified categories will follow the categories in categoryarray. Set categoryorder to total ascending or total descending if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean or median of all the values.

default: trace

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

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to array. Used with categoryorder.

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

pub fn rangeslider(&mut self) -> &mut Rangeslider<'a>

pub fn rangeselector(&mut self) -> &mut Rangeselector<'a>

pub fn calendar(&mut self, calendar: Calendar) -> &mut Self

Sets the calendar system to use for range and tick0 if this is a date axis. This does not set the calendar for interpreting data on this axis, that’s specified in the trace or via the global layout.calendar

default: gregorian

Trait Implementations

impl<'a> Default for Xaxis<'a>

fn default() -> Xaxis<'a>

Returns the “default value” for a type.

impl<'a> Serialize for Xaxis<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.