F# Figure Reference: layout.yaxis

  • yaxis
    Parent: layout
    Type: object containing one or more of the keys listed below.
    • anchor
      Parent: layout.yaxis
      Type: enumerated , one of ( "free" | "/^x([2-9]|[1-9][0-9]+)?( domain)?$/" | "/^y([2-9]|[1-9][0-9]+)?( domain)?$/" )

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

    • automargin
      Parent: layout.yaxis
      Type: flaglist string. Any combination of "height", "width", "left", "right", "top", "bottom" joined with a "+" OR True or False.
      Examples: "height", "width", "height+width", "height+width+left", "True"

      Determines whether long tick labels automatically grow the figure margins.

    • autorange
      Parent: layout.yaxis
      Type: enumerated , one of ( True | False | "reversed" | "min reversed" | "max reversed" | "min" | "max" )
      Default: True

      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.

    • autorangeoptions
      Parent: layout.yaxis
      Type: object containing one or more of the keys listed below.
      • clipmax
        Parent: layout.yaxis.autorangeoptions
        Type: number or categorical coordinate string

        Clip autorange maximum if it goes beyond this value. Has no effect when `autorangeoptions.maxallowed` is provided.

      • clipmin
        Parent: layout.yaxis.autorangeoptions
        Type: number or categorical coordinate string

        Clip autorange minimum if it goes beyond this value. Has no effect when `autorangeoptions.minallowed` is provided.

      • include
        Parent: layout.yaxis.autorangeoptions
        Type: number or categorical coordinate string

        Ensure this value is included in autorange.

      • maxallowed
        Parent: layout.yaxis.autorangeoptions
        Type: number or categorical coordinate string

        Use this value exactly as autorange maximum.

      • minallowed
        Parent: layout.yaxis.autorangeoptions
        Type: number or categorical coordinate string

        Use this value exactly as autorange minimum.

    • autoshift
      Parent: layout.yaxis
      Type: boolean

      Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to True. Only has an effect if `anchor` is set to "free".

    • autotickangles
      Parent: layout.yaxis
      Type: IEnumerable
      Default: [0, 30, 90]

      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.

    • autotypenumbers
      Parent: layout.yaxis
      Type: enumerated , one of ( "convert types" | "strict" )
      Default: "convert types"

      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.

    • calendar
      Parent: layout.yaxis
      Type: enumerated , one of ( "chinese" | "coptic" | "discworld" | "ethiopian" | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura" )
      Default: "gregorian"

      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`

    • categoryarray
      Parent: layout.yaxis
      Type: IEnumerable<#IConvertible>

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

    • categoryorder
      Parent: layout.yaxis
      Type: enumerated , 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" )
      Default: "trace"

      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.

    • color
      Parent: layout.yaxis
      Type: color
      Default: "#444"

      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.

    • constrain
      Parent: layout.yaxis
      Type: enumerated , one of ( "range" | "domain" )

      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.

    • constraintoward
      Parent: layout.yaxis
      Type: enumerated , one of ( "left" | "center" | "right" | "top" | "middle" | "bottom" )

      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.

    • dividercolor
      Parent: layout.yaxis
      Type: color
      Default: "#444"

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

    • dividerwidth
      Parent: layout.yaxis
      Type: number
      Default: 1

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

    • domain
      Parent: layout.yaxis
      Type: IEnumerable
      Default: [0, 1]

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

    • dtick
      Parent: layout.yaxis
      Type: number or categorical coordinate string

      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"

    • exponentformat
      Parent: layout.yaxis
      Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" | "SI extended" )
      Default: "B"

      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.

    • fixedrange
      Parent: layout.yaxis
      Type: boolean

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

    • gridcolor
      Parent: layout.yaxis
      Type: color
      Default: "#eee"

      Sets the color of the grid lines.

    • griddash
      Parent: layout.yaxis
      Type: string
      Default: "solid"

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

    • gridwidth
      Parent: layout.yaxis
      Type: number greater than or equal to 0
      Default: 1

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

    • hoverformat
      Parent: layout.yaxis
      Type: string
      Default: ""

      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"

    • insiderange
      Parent: layout.yaxis
      Type: IEnumerable

      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.

    • labelalias
      Parent: layout.yaxis
      Type: number or categorical coordinate string

      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.

    • layer
      Parent: layout.yaxis
      Type: enumerated , one of ( "above traces" | "below traces" )
      Default: "above traces"

      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.

    • linecolor
      Parent: layout.yaxis
      Type: color
      Default: "#444"

      Sets the axis line color.

    • linewidth
      Parent: layout.yaxis
      Type: number greater than or equal to 0
      Default: 1

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

    • matches
      Parent: layout.yaxis
      Type: enumerated , one of ( "/^x([2-9]|[1-9][0-9]+)?( domain)?$/" | "/^y([2-9]|[1-9][0-9]+)?( domain)?$/" )

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

    • maxallowed
      Parent: layout.yaxis
      Type: number or categorical coordinate string

      Determines the maximum range of this axis.

    • minallowed
      Parent: layout.yaxis
      Type: number or categorical coordinate string

      Determines the minimum range of this axis.

    • minexponent
      Parent: layout.yaxis
      Type: number greater than or equal to 0
      Default: 3

      Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".

    • minor
      Parent: layout.yaxis
      Type: object containing one or more of the keys listed below.
      • dtick
        Parent: layout.yaxis.minor
        Type: number or categorical coordinate string

        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"

      • gridcolor
        Parent: layout.yaxis.minor
        Type: color
        Default: "#eee"

        Sets the color of the grid lines.

      • griddash
        Parent: layout.yaxis.minor
        Type: string
        Default: "solid"

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

      • gridwidth
        Parent: layout.yaxis.minor
        Type: number greater than or equal to 0

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

      • nticks
        Parent: layout.yaxis.minor
        Type: integer greater than or equal to 0
        Default: 5

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

      • showgrid
        Parent: layout.yaxis.minor
        Type: boolean

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

      • tick0
        Parent: layout.yaxis.minor
        Type: number or categorical coordinate string

        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.

      • tickcolor
        Parent: layout.yaxis.minor
        Type: color
        Default: "#444"

        Sets the tick color.

      • ticklen
        Parent: layout.yaxis.minor
        Type: number greater than or equal to 0

        Sets the tick length (in px).

      • tickmode
        Parent: layout.yaxis.minor
        Type: enumerated , one of ( "auto" | "linear" | "array" )

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

      • ticks
        Parent: layout.yaxis.minor
        Type: enumerated , one of ( "outside" | "inside" | "" )

        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.

      • tickvals
        Parent: layout.yaxis.minor
        Type: IEnumerable<#IConvertible>

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

      • tickwidth
        Parent: layout.yaxis.minor
        Type: number greater than or equal to 0

        Sets the tick width (in px).