Properties of layout.xaxis.
Usage
go_layout_xaxis(
arg = NULL,
...,
anchor = NULL,
automargin = NULL,
autorange = NULL,
autorangeoptions = NULL,
autotickangles = NULL,
autotypenumbers = NULL,
calendar = NULL,
categoryarray = NULL,
categoryorder = NULL,
color = NULL,
constrain = NULL,
constraintoward = NULL,
dividercolor = NULL,
dividerwidth = NULL,
domain = NULL,
domainpad = NULL,
dtick = NULL,
exponentformat = NULL,
fixedrange = NULL,
gridcolor = NULL,
griddash = NULL,
gridwidth = NULL,
hoverformat = NULL,
insiderange = NULL,
labelalias = NULL,
layer = NULL,
linecolor = NULL,
linewidth = NULL,
matches = NULL,
maxallowed = NULL,
minallowed = NULL,
minexponent = NULL,
minor = NULL,
minorloglabels = NULL,
mirror = NULL,
modebardisable = NULL,
nticks = NULL,
overlaying = NULL,
position = NULL,
range = NULL,
rangebreaks = NULL,
rangemode = NULL,
rangeselector = NULL,
rangeslider = NULL,
scaleanchor = NULL,
scaleratio = NULL,
separatethousands = NULL,
showdividers = NULL,
showexponent = NULL,
showgrid = NULL,
showline = NULL,
showspikes = NULL,
showticklabels = NULL,
showtickprefix = NULL,
showticksuffix = NULL,
side = NULL,
spikecolor = NULL,
spikedash = NULL,
spikemode = NULL,
spikesnap = NULL,
spikethickness = NULL,
tick0 = NULL,
tickangle = NULL,
tickcolor = NULL,
tickfont = NULL,
tickformat = NULL,
tickformatstops = NULL,
ticklabelindex = NULL,
ticklabelmode = NULL,
ticklabeloverflow = NULL,
ticklabelposition = NULL,
ticklabelshift = NULL,
ticklabelstandoff = NULL,
ticklabelstep = NULL,
ticklen = NULL,
tickmode = NULL,
tickprefix = NULL,
ticks = NULL,
tickson = NULL,
ticksuffix = NULL,
ticktext = NULL,
tickvals = NULL,
tickwidth = NULL,
title = NULL,
type = NULL,
uirevision = NULL,
unifiedhovertitle = NULL,
visible = NULL,
zeroline = NULL,
zerolinecolor = NULL,
zerolinelayer = NULL,
zerolinewidth = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_autorangeoptions(
arg = NULL,
...,
clipmax = NULL,
clipmin = NULL,
include = NULL,
maxallowed = NULL,
minallowed = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_domainpad(
arg = NULL,
...,
bottom = NULL,
left = NULL,
right = NULL,
top = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_minor(
arg = NULL,
...,
dtick = NULL,
gridcolor = NULL,
griddash = NULL,
gridwidth = NULL,
nticks = NULL,
showgrid = NULL,
tick0 = NULL,
tickcolor = NULL,
ticklen = NULL,
tickmode = NULL,
ticks = NULL,
tickvals = NULL,
tickwidth = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_rangebreak(
arg = NULL,
...,
bounds = NULL,
dvalue = NULL,
enabled = NULL,
name = NULL,
pattern = NULL,
templateitemname = NULL,
values = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_rangeselector(
arg = NULL,
...,
activecolor = NULL,
bgcolor = NULL,
bordercolor = NULL,
borderwidth = NULL,
buttons = NULL,
font = NULL,
visible = NULL,
x = NULL,
xanchor = NULL,
y = NULL,
yanchor = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_rangeselector_button(
arg = NULL,
...,
count = NULL,
label = NULL,
name = NULL,
step = NULL,
stepmode = NULL,
templateitemname = NULL,
visible = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_rangeselector_font(
arg = NULL,
...,
color = NULL,
family = NULL,
lineposition = NULL,
shadow = NULL,
size = NULL,
style = NULL,
textcase = NULL,
variant = NULL,
weight = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_rangeslider(
arg = NULL,
...,
autorange = NULL,
bgcolor = NULL,
bordercolor = NULL,
borderwidth = NULL,
range = NULL,
thickness = NULL,
visible = NULL,
yaxis = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_rangeslider_yaxis(
arg = NULL,
...,
range = NULL,
rangemode = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_tickfont(
arg = NULL,
...,
color = NULL,
family = NULL,
lineposition = NULL,
shadow = NULL,
size = NULL,
style = NULL,
textcase = NULL,
variant = NULL,
weight = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_tickformatstop(
arg = NULL,
...,
dtickrange = NULL,
enabled = NULL,
name = NULL,
templateitemname = NULL,
value = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_title(
arg = NULL,
...,
font = NULL,
standoff = NULL,
text = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_title_font(
arg = NULL,
...,
color = NULL,
family = NULL,
lineposition = NULL,
shadow = NULL,
size = NULL,
style = NULL,
textcase = NULL,
variant = NULL,
weight = NULL,
skip_invalid = FALSE
)
go_layout_xaxis_unifiedhovertitle(
arg = NULL,
...,
text = NULL,
skip_invalid = FALSE
)Arguments
- arg
Optional named list, or graph object of the same type, to initialise properties from (constructors). Named arguments take precedence.
- ...
Further properties, including nested properties in "magic underscore" form, e.g.
marker_size = 10formarker = list(size = 10). Property values may be one-sided formulas, evaluated indataforadd_*()functions.- anchor
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`. One of
"free", or a string matching"^x([2-9]|[1-9][0-9]+)?( domain)?$"or"^y([2-9]|[1-9][0-9]+)?( domain)?$".- automargin
Determines whether long tick labels automatically grow the figure margins. Any combination of
"height","width","left","right","top","bottom"joined with"+", or one ofTRUE,FALSE.- autorange
go_layout_xaxis(): 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 and it has a value for both the lower and upper bound, `autorange` is set to FALSE. Using "min" applies autorange only to set the minimum. Using "max" applies autorange only to set the maximum. Using "min reversed" applies autorange only to set the minimum on a reversed axis. Using "max reversed" applies autorange only to set the maximum on a reversed axis. Using "reversed" applies autorange on both ends and reverses the axis direction. One of"reversed","min reversed","max reversed","min","max",TRUE,FALSE.go_layout_xaxis_rangeslider(): Determines whether or not the range slider range is computed in relation to the input data. If `range` is provided, then `autorange` is set to FALSE. Logical.- autorangeoptions
Named list or
go_layout_xaxis_autorangeoptions()object.- autotickangles
When `tickangle` is set to "auto", it will be set to the first angle in this array that is large enough to prevent label overlap. Vector or list of up to 1 element(s).
- autotypenumbers
Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers. One of
"convert types","strict".- calendar
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` One of
"chinese","coptic","discworld","ethiopian","gregorian","hebrew","islamic","jalali","julian","mayan","nanakshahi","nepali","persian","taiwan","thai","ummalqura".- categoryarray
Sets the order in which categories on this axis appear. Only has an effect if `categoryorder` is set to "array". Used with `categoryorder`. Data array: a vector, factor, Date/POSIXct vector, matrix or list.
- categoryorder
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, geometric mean or median of all the values. One of
"trace","category ascending","category descending","array","total ascending","total descending","min ascending","min descending","max ascending","max descending","sum ascending","sum descending","mean ascending","mean descending","geometric mean ascending","geometric mean descending","median ascending","median descending".- color
go_layout_xaxis(): 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. Color: a CSS color string or R color name.go_layout_xaxis_rangeselector_font(),go_layout_xaxis_tickfont(),go_layout_xaxis_title_font(): Color: a CSS color string or R color name.- constrain
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", or by decreasing the "domain". Default is "domain" for axes containing image traces, "range" otherwise. One of
"range","domain".- constraintoward
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. One of
"left","center","right","top","middle","bottom".- dividercolor
Sets the color of the dividers Only has an effect on "multicategory" axes. Color: a CSS color string or R color name.
- dividerwidth
Sets the width (in px) of the dividers Only has an effect on "multicategory" axes. Number.
- domain
Sets the domain of this axis (in plot fraction). Vector or list of 2 element(s).
- domainpad
Sets the space in pixels to reserve inside the edges of `domain`. Because `domain` is a fraction of the plot area, the gap between subplots changes with the figure size. `domainpad` keeps the same size in pixels at all figure sizes, so it can hold content with a fixed size, such as a subplot title. x axes use `left` and `right`. y axes use `top` and `bottom`. If the padding needs more room than the domain has, the two pads shrink by the same factor, and the plot area keeps a length of at least 2 pixels. An axis that sets `overlaying` ignores its own `domainpad` and uses the `domainpad` of the axis it overlays, so that both axes share the same plot area. Named list or
go_layout_xaxis_domainpad()object.- dtick
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<f>", 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<n>" 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" Any value.
- exponentformat
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. "SI" uses prefixes from "femto" f (10^-15) to "tera" T (10^12). "SI extended" covers instead the full SI range from "quecto" q (10^-30) to "quetta" Q (10^30). If "SI" or "SI extended" is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation. One of
"none","e","E","power","SI","B","SI extended".- fixedrange
Determines whether or not this axis is zoom-able. If true, then zoom is disabled. Logical.
- gridcolor
Sets the color of the grid lines. Color: a CSS color string or R color name.
- griddash
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"). One of
"solid","dot","dash","longdash","dashdot","longdashdot", or a string matching"^\\d+(\\.\\d+)?(px|%)?((,|\\s)\\s*\\d+(\\.\\d+)?(px|%)?)*$".- gridwidth
Sets the width (in px) of the grid lines. Number in the interval [0, Inf].
- hoverformat
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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{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" String.
- insiderange
Could be used to set the desired inside range of this axis (excluding the labels) when `ticklabelposition` of the anchored axis has "inside". Not implemented for axes with `type` "log". This would be ignored when `range` is provided. Vector or list of 2 element(s).
- labelalias
Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use -1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax. Any value.
- layer
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. One of
"above traces","below traces".- linecolor
Sets the axis line color. Color: a CSS color string or R color name.
- linewidth
Sets the width (in px) of the axis line. Number in the interval [0, Inf].
- matches
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`. One of , or a string matching
"^x([2-9]|[1-9][0-9]+)?( domain)?$"or"^y([2-9]|[1-9][0-9]+)?( domain)?$".- maxallowed
go_layout_xaxis(): Determines the maximum range of this axis. Any value.go_layout_xaxis_autorangeoptions(): Use this value exactly as autorange maximum. Any value.- minallowed
go_layout_xaxis(): Determines the minimum range of this axis. Any value.go_layout_xaxis_autorangeoptions(): Use this value exactly as autorange minimum. Any value.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B". Number in the interval [0, Inf].
- minor
Named list or
go_layout_xaxis_minor()object.- minorloglabels
Determines how minor log labels are displayed. If "small digits", small digits i.e. 2 or 5 are displayed. If "complete", complete digits are displayed. If "none", no labels are displayed. One of
"small digits","complete","none".- mirror
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. One of
"ticks","all","allticks",TRUE,FALSE.- modebardisable
Disables certain modebar buttons for this axis. "autoscale" disables the autoscale buttons, "zoominout" disables the zoom-in and zoom-out buttons. Any combination of
"autoscale","zoominout"joined with"+", or one of"none".- nticks
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". Integer in the interval [0, Inf].
- overlaying
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. One of
"free", or a string matching"^x([2-9]|[1-9][0-9]+)?( domain)?$"or"^y([2-9]|[1-9][0-9]+)?( domain)?$".- position
Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to "free". Number in the interval [0, 1].
- range
go_layout_xaxis(): 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. Leaving either or both elements `null` impacts the default `autorange`. Vector or list of 2 element(s).go_layout_xaxis_rangeslider(): Sets the range of the range slider. If not set, defaults to the full xaxis range. If the axis `type` is "log", then you must take the log of your desired range. 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. Vector or list of 2 element(s).go_layout_xaxis_rangeslider_yaxis(): Sets the range of this axis for the rangeslider. Vector or list of 2 element(s).- rangebreaks
List of named lists or
go_layout_xaxis_rangebreak()objects.- rangemode
go_layout_xaxis(): 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. One of"normal","tozero","nonnegative".go_layout_xaxis_rangeslider_yaxis(): Determines whether or not the range of this axis in the rangeslider use the same value than in the main plot when zooming in/out. If "auto", the autorange will be used. If "fixed", the `range` is used. If "match", the current range of the corresponding y-axis on the main subplot is used. One of"auto","fixed","match".- rangeselector
Named list or
go_layout_xaxis_rangeselector()object.- rangeslider
Named list or
go_layout_xaxis_rangeslider()object.- scaleanchor
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. Setting `false` allows to remove a default constraint (occasionally, you may need to prevent a default `scaleanchor` constraint from being applied, eg. when having an image trace `yaxis: {scaleanchor: "x"}` is set automatically in order for pixels to be rendered as squares, setting `yaxis: {scaleanchor: false}` allows to remove the constraint). One of
FALSE, or a string matching"^x([2-9]|[1-9][0-9]+)?( domain)?$"or"^y([2-9]|[1-9][0-9]+)?( domain)?$".- scaleratio
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. Number in the interval [0, Inf].
- separatethousands
If "true", even 4-digit integers are separated Logical.
- showdividers
Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on "multicategory" axes. Logical.
- showexponent
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. One of
"all","first","last","none".- showgrid
Determines whether or not grid lines are drawn. If TRUE, the grid lines are drawn at every tick mark. Logical.
- showline
Determines whether or not a line bounding this axis is drawn. Logical.
- showspikes
Determines whether or not spikes (aka droplines) are drawn for this axis. Note that spikes will never be drawn when `hovermode` is FALSE. Logical.
- showticklabels
Determines whether or not the tick labels are drawn. Logical.
- showtickprefix
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. One of
"all","first","last","none".- showticksuffix
Same as `showtickprefix` but for tick suffixes. One of
"all","first","last","none".- side
Determines whether a x (y) axis is positioned at the "bottom" ("left") or "top" ("right") of the plotting area. One of
"top","bottom","left","right".- spikecolor
Sets the spike color. If undefined, will use the series color Color: a CSS color string or R color name.
- spikedash
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"). One of
"solid","dot","dash","longdash","dashdot","longdashdot", or a string matching"^\\d+(\\.\\d+)?(px|%)?((,|\\s)\\s*\\d+(\\.\\d+)?(px|%)?)*$".- 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 Any combination of
"toaxis","across","marker"joined with"+".- spikesnap
Determines whether spikelines are stuck to the cursor or to the closest datapoints. One of
"data","cursor","hovered data".- spikethickness
Sets the spike line width in pixels. Number.
- tick0
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<f>" (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. Any value.
- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically. Angle in degrees.
- tickcolor
Sets the tick color. Color: a CSS color string or R color name.
- tickfont
Sets the tick font. Named list or
go_layout_xaxis_tickfont()object.- tickformat
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-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{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" String.
- tickformatstops
List of named lists or
go_layout_xaxis_tickformatstop()objects.- ticklabelindex
Only for axes with `type` "date" or "linear". Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose `ticklabelindex` -1. This is useful for date axes with `ticklabelmode` "period" if you want to label the period that ends with each major tick instead of the period that begins there. Integer, or a vector of these.
- ticklabelmode
Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` "date" When set to "period", tick labels are drawn in the middle of the period between ticks. One of
"instant","period".- ticklabeloverflow
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". Otherwise on "category" and "multicategory" axes the default is "allow". In other cases the default is "hide past div". One of
"allow","hide past div","hide past domain".- ticklabelposition
Determines where tick labels are drawn with respect to the axis. Please note that top or bottom has no effect on x axes or when `ticklabelmode` is set to "period" or when `tickson` is set to "boundaries". Similarly, left or right has no effect on y axes or when `ticklabelmode` is set to "period" or when `tickson` is set to "boundaries". Has no effect on "multicategory" axes. When used on axes linked by `matches` or `scaleanchor`, no extra padding for inside labels would be added by autorange, so that the scales could match. One of
"outside","inside","outside top","inside top","outside left","inside left","outside right","inside right","outside bottom","inside bottom".- ticklabelshift
Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis. Integer.
- ticklabelstandoff
Sets the standoff distance (in px) between the axis tick labels and their default position. A positive `ticklabelstandoff` moves the labels farther away from the plot area if `ticklabelposition` is "outside", and deeper into the plot area if `ticklabelposition` is "inside". A negative `ticklabelstandoff` works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa. Integer.
- ticklabelstep
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array". Integer in the interval [1, Inf].
- ticklen
Sets the tick length (in px). Number in the interval [0, Inf].
- tickmode
go_layout_xaxis(): 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). If "sync", the number of ticks will sync with the overlayed axis set by `overlaying` property. When no other tick info is provided, overlaying (non-categorical) axes default to "sync", while other axes default to "auto". One of"auto","linear","array","sync".go_layout_xaxis_minor(): 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). One of"auto","linear","array".- tickprefix
Sets a tick label prefix. String.
- ticks
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. One of
"outside","inside","".- tickson
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. One of
"labels","boundaries".- ticksuffix
Sets a tick label suffix. String.
- ticktext
Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`. Data array: a vector, factor, Date/POSIXct vector, matrix or list.
- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`. Data array: a vector, factor, Date/POSIXct vector, matrix or list.
- tickwidth
Sets the tick width (in px). Number in the interval [0, Inf].
- title
String (the title text), named list or
go_layout_xaxis_title()object.- type
Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question. One of
"-","linear","log","date","category","multicategory".- uirevision
Controls persistence of user-driven changes in axis `range`, `autorange`, and `title` if in `editable: true` configuration. Defaults to `layout.uirevision`. Any value.
- unifiedhovertitle
Named list or
go_layout_xaxis_unifiedhovertitle()object.- visible
go_layout_xaxis(): 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 Logical.go_layout_xaxis_rangeselector(): Determines whether or not this range selector is visible. Note that range selectors are only available for x axes of `type` set to or auto-typed to "date". Logical.go_layout_xaxis_rangeselector_button(): Determines whether or not this button is visible. Logical.go_layout_xaxis_rangeslider(): Determines whether or not the range slider will be visible. If visible, perpendicular axes will be set to `fixedrange` Logical.- zeroline
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. Logical.
- zerolinecolor
Sets the line color of the zero line. Color: a CSS color string or R color name.
- zerolinelayer
Sets the layer on which this zeroline is displayed. If "above traces", this zeroline is displayed above all the subplot's traces If "below traces", this zeroline is displayed below all the subplot's traces, but above the grid lines. Limitation: "zerolinelayer" currently has no effect if the "zorder" property is set on any trace. One of
"above traces","below traces".- zerolinewidth
Sets the width (in px) of the zero line. Number.
- skip_invalid
If
TRUE, silently drop invalid properties instead of raising an error.- clipmax
Clip autorange maximum if it goes beyond this value. Has no effect when `autorangeoptions.maxallowed` is provided. Any value.
- clipmin
Clip autorange minimum if it goes beyond this value. Has no effect when `autorangeoptions.minallowed` is provided. Any value.
- include
Extends the autorange to include this value or array of values, even when they fall outside the data range. Has no effect on endpoints set by `autorangeoptions.minallowed` or `autorangeoptions.maxallowed`. Subject to `autorangeoptions.clipmin` and `autorangeoptions.clipmax`. Any value.
- bottom
Sets the space in pixels to reserve inside the bottom edge of `domain`. Applies to y axes only. Number in the interval [0, Inf].
- left
Sets the space in pixels to reserve inside the left edge of `domain`. Applies to x axes only. Number in the interval [0, Inf].
- right
Sets the space in pixels to reserve inside the right edge of `domain`. Applies to x axes only. Number in the interval [0, Inf].
- top
Sets the space in pixels to reserve inside the top edge of `domain`. Applies to y axes only. Number in the interval [0, Inf].
- bounds
Sets the lower and upper bounds of this axis rangebreak. Can be used with `pattern`. Vector or list of 2 element(s).
- dvalue
Sets the size of each `values` item. The default is one day in milliseconds. Number in the interval [0, Inf].
- enabled
go_layout_xaxis_rangebreak(): Determines whether this axis rangebreak is enabled or disabled. Please note that `rangebreaks` only work for "date" axis type. Logical.go_layout_xaxis_tickformatstop(): Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`. Logical.- name
When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. String.
- pattern
Determines a pattern on the time line that generates breaks. If "day of week" - days of the week in English e.g. 'Sunday' or `sun` (matching is case-insensitive and considers only the first three characters), as well as Sunday-based integers between 0 and 6. If "hour" - hour (24-hour clock) as decimal numbers between 0 and 24. for more info. Examples: - { pattern: 'day of week', bounds: [6, 1] } or simply { bounds: ['sat', 'mon'] } breaks from Saturday to Monday (i.e. skips the weekends). - { pattern: 'hour', bounds: [17, 8] } breaks from 5pm to 8am (i.e. skips non-work hours). One of
"day of week","hour","".- templateitemname
Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. String.
- values
Sets the coordinate values corresponding to the rangebreaks. An alternative to `bounds`. Use `dvalue` to set the size of the values along the axis. Vector or list of up to 1 element(s).
- activecolor
Sets the background color of the active range selector button. Color: a CSS color string or R color name.
- bgcolor
go_layout_xaxis_rangeselector(): Sets the background color of the range selector buttons. Color: a CSS color string or R color name.go_layout_xaxis_rangeslider(): Sets the background color of the range slider. Color: a CSS color string or R color name.- bordercolor
go_layout_xaxis_rangeselector(): Sets the color of the border enclosing the range selector. Color: a CSS color string or R color name.go_layout_xaxis_rangeslider(): Sets the border color of the range slider. Color: a CSS color string or R color name.- borderwidth
go_layout_xaxis_rangeselector(): Sets the width (in px) of the border enclosing the range selector. Number in the interval [0, Inf].go_layout_xaxis_rangeslider(): Sets the border width of the range slider. Integer in the interval [0, Inf].List of named lists or
go_layout_xaxis_rangeselector_button()objects.- font
go_layout_xaxis_rangeselector(): Sets the font of the range selector button text. Named list orgo_layout_xaxis_rangeselector_font()object.go_layout_xaxis_title(): Sets this axis' title font. Named list orgo_layout_xaxis_title_font()object.- x
Sets the x position (in normalized coordinates) of the range selector. Number in the interval [-2, 3].
- xanchor
Sets the range selector's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector. One of
"auto","left","center","right".- y
Sets the y position (in normalized coordinates) of the range selector. Number in the interval [-2, 3].
- yanchor
Sets the range selector's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector. One of
"auto","top","middle","bottom".- count
Sets the number of steps to take to update the range. Use with `step` to specify the update interval. Number in the interval [0, Inf].
- label
Sets the text label to appear on the button. String.
- step
The unit of measurement that the `count` value will set the range by. One of
"month","year","day","hour","minute","second","all".- stepmode
Sets the range update mode. If "backward", the range update shifts the start of range back "count" times "step" milliseconds. If "todate", the range update shifts the start of range back to the first timestamp from "count" times "step" milliseconds back. For example, with `step` set to "year" and `count` set to 1 the range update shifts the start of the range back to January 01 of the current year. Month and year "todate" are currently available only for the built-in (Gregorian) calendar. One of
"backward","todate".- family
HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available. String.
- lineposition
Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc. Any combination of
"under","over","through"joined with"+", or one of"none".- shadow
Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options. String.
- size
Number in the interval [1, Inf].
- style
Sets whether a font should be styled with a normal or italic face from its family. One of
"normal","italic".- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized. One of
"normal","word caps","upper","lower".- variant
Sets the variant of the font. One of
"normal","small-caps","all-small-caps","all-petite-caps","petite-caps","unicase".- weight
Sets the weight (or boldness) of the font. Integer in the interval [1, 1000].
- thickness
The height of the range slider as a fraction of the total plot area height. Number in the interval [0, 1].
- yaxis
Named list or
go_layout_xaxis_rangeslider_yaxis()object.- dtickrange
range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null" Vector or list of 2 element(s).
- value
string - dtickformat for described zoom level, the same as "tickformat" String.
- standoff
Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title `font.size` and the axis `linewidth`. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting `standoff` and turning on `automargin`, plotly.js will push the margins to fit the axis title at given standoff distance. Number in the interval [0, Inf].
- text
go_layout_xaxis_title(): Sets the title of this axis. String.go_layout_xaxis_unifiedhovertitle(): Template string used for rendering the title that appear on x or y unified hover box. 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-format/tree/v1.4.5#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-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. String.
Value
Each go_*() function returns a graph object of the same
class as its name; add_*() functions return the modified figure.
Details
go_layout_xaxis() and the nested object constructors below create
validated graph objects (named lists). Every property is checked against
the plotly.js schema when an object is created or modified (see
plotly_obj-modify()).
Nested objects documented here:
go_layout_xaxis_autorangeoptions()layout.xaxis.autorangeoptionsgo_layout_xaxis_domainpad()layout.xaxis.domainpad: Sets the space in pixels to reserve inside the edges of `domain`. Because `domain` is a fraction of the plot area, the gap between subplots changes with the figure size. `domainpad` keeps the same size in pixels at all figure sizes, so it can hold content with a fixed size, such as a subplot title. x axes use `left` and `right`. y axes use `top` and `bottom`. If the padding needs more room than the domain has, the two pads shrink by the same factor, and the plot area keeps a length of at least 2 pixels. An axis that sets `overlaying` ignores its own `domainpad` and uses the `domainpad` of the axis it overlays, so that both axes share the same plot area.go_layout_xaxis_minor()layout.xaxis.minorgo_layout_xaxis_rangebreak()layout.xaxis.rangebreakgo_layout_xaxis_rangeselector()layout.xaxis.rangeselectorgo_layout_xaxis_rangeselector_button()layout.xaxis.rangeselector.button: Sets the specifications for each buttons. By default, a range selector comes with no buttons.go_layout_xaxis_rangeselector_font()layout.xaxis.rangeselector.font: Sets the font of the range selector button text.go_layout_xaxis_rangeslider()layout.xaxis.rangeslidergo_layout_xaxis_rangeslider_yaxis()layout.xaxis.rangeslider.yaxisgo_layout_xaxis_tickfont()layout.xaxis.tickfont: Sets the tick font.go_layout_xaxis_tickformatstop()layout.xaxis.tickformatstopgo_layout_xaxis_title()layout.xaxis.titlego_layout_xaxis_title_font()layout.xaxis.title.font: Sets this axis' title font.go_layout_xaxis_unifiedhovertitle()layout.xaxis.unifiedhovertitle