Struct plotly_types::traces::choropleth::Colorbar

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

Implementations

impl<'a> Colorbar<'a>

pub fn thicknessmode(&mut self, thicknessmode: Thicknessmode) -> &mut Self

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

default: pixels

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

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

default: 30

pub fn lenmode(&mut self, lenmode: Lenmode) -> &mut Self

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

default: fraction

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

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

default: 1

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

Sets the x position of the color bar (in plot fraction).

default: 1.02

pub fn xanchor(&mut self, xanchor: Xanchor) -> &mut Self

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar.

default: left

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

Sets the amount of padding (in px) along the x direction.

default: 10

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

Sets the y position of the color bar (in plot fraction).

default: 0.5

pub fn yanchor(&mut self, yanchor: Yanchor) -> &mut Self

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar.

default: middle

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

Sets the amount of padding (in px) along the y direction.

default: 10

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

Sets the axis line color.

default: #444

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

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

default: 1

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

Sets the axis line color.

default: #444

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

Sets the width (in px) or the border enclosing this color bar.

default: 0

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

Sets the color of padded area.

default: rgba(0,0,0,0)

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.

default: ``

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 color bar's tick label 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 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 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 separatethousands(&mut self, separatethousands: bool) -> &mut Self

If "true", even 4-digit integers are separated

default: false

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 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 title(&mut self) -> &mut Title<'a>

Trait Implementations

impl<'a> Default for Colorbar<'a>

fn default() -> Colorbar<'a>

Returns the "default value" for a type.

impl<'a> Serialize for Colorbar<'a>

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

Serialize this value into the given Serde serializer.