Live Chat

We'll need to share your messages (and your email address if you're logged in) with our live chat provider, Drift. Here's their privacy policy.

If you don't want to do this, you can email us instead at contact@anvil.works.

plotly.graph_objs.layout.xaxis Module

Functions

plotly.graph_objs.layout.xaxis.Rangebreak([enabled=], [bounds=], [pattern=], [values=], [dvalue=], [name=], [templateitemname=]) → Rangebreak

Create a new ‘Rangebreak’ object

  • enabled - Determines whether this axis rangebreak is enabled or disabled. Please note that `rangebreaks` only work for *date* axis type.

  • bounds - Sets the lower and upper bounds of this axis rangebreak. Can be used with `pattern`.

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

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

  • dvalue - Sets the size of each `values` item. The default is one day in milliseconds.

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

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


plotly.graph_objs.layout.xaxis.Rangeselector([visible=], [button=], [x=], [xanchor=], [y=], [yanchor=], [font=], [bgcolor=], [activecolor=], [bordercolor=], [borderwidth=]) → Rangeselector

Create a new ‘Rangeselector’ object

  • visible - 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*.

  • button - Sets the specifications for each buttons. By default, a range selector comes with no buttons.

  • x - Sets the x position (in normalized coordinates) of the range selector.

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

  • y - Sets the y position (in normalized coordinates) of the range selector.

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

  • font - Sets the font of the range selector button text.

  • bgcolor - Sets the background color of the range selector buttons.

  • activecolor - Sets the background color of the active range selector button.

  • bordercolor - Sets the color of the border enclosing the range selector.

  • borderwidth - Sets the width (in px) of the border enclosing the range selector.


plotly.graph_objs.layout.xaxis.Rangeslider([bgcolor=], [bordercolor=], [borderwidth=], [autorange=], [range=], [thickness=], [visible=], [yaxis=]) → Rangeslider

Create a new ‘Rangeslider’ object

  • bgcolor - Sets the background color of the range slider.

  • bordercolor - Sets the border color of the range slider.

  • borderwidth - Sets the border width of the range slider.

  • autorange - 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*.

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

  • thickness - The height of the range slider as a fraction of the total plot area height.

  • visible - Determines whether or not the range slider will be visible. If visible, perpendicular axes will be set to `fixedrange`


plotly.graph_objs.layout.xaxis.Tickfont([family=], [size=], [color=]) → Tickfont

Create a new ‘Tickfont’ object

  • family - HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.


plotly.graph_objs.layout.xaxis.Tickformatstop([enabled=], [dtickrange=], [value=], [name=], [templateitemname=]) → Tickformatstop

Create a new ‘Tickformatstop’ object

  • enabled - Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

  • 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*

  • value - string - dtickformat for described zoom level, the same as *tickformat*

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

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


plotly.graph_objs.layout.xaxis.Title([text=], [font=], [standoff=]) → Title

Create a new ‘Title’ object

  • text - Sets the title of this axis. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

  • font - Sets this axis' title font. Note that the title's font used to be customized by the now deprecated `titlefont` attribute.

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


Globals





plotly.graph_objs.layout.xaxis