Struct Yaxis

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

Implementations

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

Sets whether or not spikes starting from data points to this axis’ wall are shown on hover.

default: true

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

Sets whether or not spikes extending from the projection data points to this axis’ wall boundaries are shown on hover.

default: true

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

Sets the thickness (in px) of the spikes.

default: 2

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

Sets the color of the spikes.

default: #444

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

Sets whether or not this axis’ wall has a background color.

default: false

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

Sets the background color of this axis’ wall.

default: rgba(204, 204, 204, 0.5)

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

Sets whether or not this axis is labeled

default: true

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 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 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 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 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 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: rgb(204, 204, 204)

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 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 Yaxis<'a>

fn default() -> Yaxis<'a>

Returns the “default value” for a type.

impl<'a> Serialize for Yaxis<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.