JavaScript Figure Reference: layout.polar

  • polar
    Parent: layout
    Type: object containing one or more of the keys listed below.
    • angularaxis
      Parent: layout.polar
      Type: object containing one or more of the keys listed below.
      • autotypenumbers
        Parent: layout.polar.angularaxis
        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.

      • categoryarray
        Parent: layout.polar.angularaxis
        Type: data array

        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.polar.angularaxis
        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" | "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 or median of all the values.

      • color
        Parent: layout.polar.angularaxis
        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.

      • direction
        Parent: layout.polar.angularaxis
        Type: enumerated , one of ( "counterclockwise" | "clockwise" )
        Default: "counterclockwise"

        Sets the direction corresponding to positive angles.

      • dtick
        Parent: layout.polar.angularaxis
        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.polar.angularaxis
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        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.

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

        Sets the color of the grid lines.

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

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

      • hoverformat
        Parent: layout.polar.angularaxis
        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"

      • layer
        Parent: layout.polar.angularaxis
        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.polar.angularaxis
        Type: color
        Default: "#444"

        Sets the axis line color.

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

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

      • minexponent
        Parent: layout.polar.angularaxis
        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".

      • nticks
        Parent: layout.polar.angularaxis
        Type: integer greater than or equal to 0
        Default: 0

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

      • period
        Parent: layout.polar.angularaxis
        Type: number greater than or equal to 0

        Set the angular period. Has an effect only when `angularaxis.type` is "category".

      • rotation
        Parent: layout.polar.angularaxis
        Type: angle

        Sets that start position (in degrees) of the angular axis By default, polar subplots with `direction` set to "counterclockwise" get a `rotation` of "0" which corresponds to due East (like what mathematicians prefer). In turn, polar with `direction` set to "clockwise" get a rotation of "90" which corresponds to due North (like on a compass),

      • separatethousands
        Parent: layout.polar.angularaxis
        Type: boolean

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

      • showexponent
        Parent: layout.polar.angularaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        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.

      • showgrid
        Parent: layout.polar.angularaxis
        Type: boolean
        Default: true

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

      • showline
        Parent: layout.polar.angularaxis
        Type: boolean
        Default: true

        Determines whether or not a line bounding this axis is drawn.

      • showticklabels
        Parent: layout.polar.angularaxis
        Type: boolean
        Default: true

        Determines whether or not the tick labels are drawn.

      • showtickprefix
        Parent: layout.polar.angularaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        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.

      • showticksuffix
        Parent: layout.polar.angularaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • thetaunit
        Parent: layout.polar.angularaxis
        Type: enumerated , one of ( "radians" | "degrees" )
        Default: "degrees"

        Sets the format unit of the formatted "theta" values. Has an effect only when `angularaxis.type` is "linear".

      • tick0
        Parent: layout.polar.angularaxis
        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.

      • tickangle
        Parent: layout.polar.angularaxis
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickcolor
        Parent: layout.polar.angularaxis
        Type: color
        Default: "#444"

        Sets the tick color.

      • tickfont
        Parent: layout.polar.angularaxis
        Type: object containing one or more of the keys listed below.

        Sets the tick font.

        • color
          Parent: layout.polar.angularaxis.tickfont
          Type: color
        • family
          Parent: layout.polar.angularaxis.tickfont
          Type: string

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

        • size
          Parent: layout.polar.angularaxis.tickfont
          Type: number greater than or equal to 1
      • tickformat
        Parent: layout.polar.angularaxis
        Type: string
        Default: ""

        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"

      • tickformatstops
        Parent: layout.polar.angularaxis
        Type: array of object where each object has one or more of the keys listed below.
        • dtickrange
          Parent: layout.polar.angularaxis.tickformatstops[]
          Type: array

          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"

        • enabled
          Parent: layout.polar.angularaxis.tickformatstops[]
          Type: boolean
          Default: true

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

        • name
          Parent: layout.polar.angularaxis.tickformatstops[]
          Type: string

          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
          Parent: layout.polar.angularaxis.tickformatstops[]
          Type: string

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

        • value
          Parent: layout.polar.angularaxis.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

      • ticklen
        Parent: layout.polar.angularaxis
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickmode
        Parent: layout.polar.angularaxis
        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).

      • tickprefix
        Parent: layout.polar.angularaxis
        Type: string
        Default: ""

        Sets a tick label prefix.

      • ticks
        Parent: layout.polar.angularaxis
        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.

      • ticksuffix
        Parent: layout.polar.angularaxis
        Type: string
        Default: ""

        Sets a tick label suffix.

      • ticktext
        Parent: layout.polar.angularaxis
        Type: data array

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • tickvals
        Parent: layout.polar.angularaxis
        Type: data array

        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.polar.angularaxis
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • type
        Parent: layout.polar.angularaxis
        Type: enumerated , one of ( "-" | "linear" | "category" )
        Default: "-"

        Sets the angular axis type. If "linear", set `thetaunit` to determine the unit in which axis value are shown. If "category, use `period` to set the number of integer coordinates around polar axis.

      • uirevision
        Parent: layout.polar.angularaxis
        Type: number or categorical coordinate string

        Controls persistence of user-driven changes in axis `rotation`. Defaults to `polar<N>.uirevision`.

      • visible
        Parent: layout.polar.angularaxis
        Type: boolean
        Default: true

        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

    • bgcolor
      Parent: layout.polar
      Type: color
      Default: "#fff"

      Set the background color of the subplot

    • domain
      Parent: layout.polar
      Type: object containing one or more of the keys listed below.
      • column
        Parent: layout.polar.domain
        Type: integer greater than or equal to 0
        Default: 0

        If there is a layout grid, use the domain for this column in the grid for this polar subplot .

      • row
        Parent: layout.polar.domain
        Type: integer greater than or equal to 0
        Default: 0

        If there is a layout grid, use the domain for this row in the grid for this polar subplot .

      • x
        Parent: layout.polar.domain
        Type: array
        Default: [0, 1]

        Sets the horizontal domain of this polar subplot (in plot fraction).

      • y
        Parent: layout.polar.domain
        Type: array
        Default: [0, 1]

        Sets the vertical domain of this polar subplot (in plot fraction).

    • gridshape
      Parent: layout.polar
      Type: enumerated , one of ( "circular" | "linear" )
      Default: "circular"

      Determines if the radial axis grid lines and angular axis line are drawn as "circular" sectors or as "linear" (polygon) sectors. Has an effect only when the angular axis has `type` "category". Note that `radialaxis.angle` is snapped to the angle of the closest vertex when `gridshape` is "circular" (so that radial axis scale is the same as the data scale).

    • hole
      Parent: layout.polar
      Type: number between or equal to 0 and 1
      Default: 0

      Sets the fraction of the radius to cut out of the polar subplot.

    • radialaxis
      Parent: layout.polar
      Type: object containing one or more of the keys listed below.
      • angle
        Parent: layout.polar.radialaxis
        Type: angle

        Sets the angle (in degrees) from which the radial axis is drawn. Note that by default, radial axis line on the theta=0 line corresponds to a line pointing right (like what mathematicians prefer). Defaults to the first `polar.sector` angle.

      • autorange
        Parent: layout.polar.radialaxis
        Type: enumerated , one of ( true | false | "reversed" )
        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, then `autorange` is set to "false".

      • autotypenumbers
        Parent: layout.polar.radialaxis
        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.polar.radialaxis
        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.polar.radialaxis
        Type: data array

        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.polar.radialaxis
        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" | "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 or median of all the values.

      • color
        Parent: layout.polar.radialaxis
        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.

      • dtick
        Parent: layout.polar.radialaxis
        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.polar.radialaxis
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        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.

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

        Sets the color of the grid lines.

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

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

      • hoverformat
        Parent: layout.polar.radialaxis
        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"

      • layer
        Parent: layout.polar.radialaxis
        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.polar.radialaxis
        Type: color
        Default: "#444"

        Sets the axis line color.

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

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

      • minexponent
        Parent: layout.polar.radialaxis
        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".

      • nticks
        Parent: layout.polar.radialaxis
        Type: integer greater than or equal to 0
        Default: 0

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

      • range
        Parent: layout.polar.radialaxis
        Type: array

        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.

      • rangemode
        Parent: layout.polar.radialaxis
        Type: enumerated , one of ( "tozero" | "nonnegative" | "normal" )
        Default: "tozero"

        If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data. If "normal", the range is computed in relation to the extrema of the input data (same behavior as for cartesian axes).

      • separatethousands
        Parent: layout.polar.radialaxis
        Type: boolean

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

      • showexponent
        Parent: layout.polar.radialaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        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.

      • showgrid
        Parent: layout.polar.radialaxis
        Type: boolean
        Default: true

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

      • showline
        Parent: layout.polar.radialaxis
        Type: boolean
        Default: true

        Determines whether or not a line bounding this axis is drawn.

      • showticklabels
        Parent: layout.polar.radialaxis
        Type: boolean
        Default: true

        Determines whether or not the tick labels are drawn.

      • showtickprefix
        Parent: layout.polar.radialaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        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.

      • showticksuffix
        Parent: layout.polar.radialaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • side
        Parent: layout.polar.radialaxis
        Type: enumerated , one of ( "clockwise" | "counterclockwise" )
        Default: "clockwise"

        Determines on which side of radial axis line the tick and tick labels appear.

      • tick0
        Parent: layout.polar.radialaxis
        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.

      • tickangle
        Parent: layout.polar.radialaxis
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickcolor
        Parent: layout.polar.radialaxis
        Type: color
        Default: "#444"

        Sets the tick color.

      • tickfont
        Parent: layout.polar.radialaxis
        Type: object containing one or more of the keys listed below.

        Sets the tick font.

        • color
          Parent: layout.polar.radialaxis.tickfont
          Type: color
        • family
          Parent: layout.polar.radialaxis.tickfont
          Type: string

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

        • size
          Parent: layout.polar.radialaxis.tickfont
          Type: number greater than or equal to 1
      • tickformat
        Parent: layout.polar.radialaxis
        Type: string
        Default: ""

        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"

      • tickformatstops
        Parent: layout.polar.radialaxis
        Type: array of object where each object has one or more of the keys listed below.
        • dtickrange
          Parent: layout.polar.radialaxis.tickformatstops[]
          Type: array

          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"

        • enabled
          Parent: layout.polar.radialaxis.tickformatstops[]
          Type: boolean
          Default: true

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

        • name
          Parent: layout.polar.radialaxis.tickformatstops[]
          Type: string

          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
          Parent: layout.polar.radialaxis.tickformatstops[]
          Type: string

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

        • value
          Parent: layout.polar.radialaxis.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

      • ticklen
        Parent: layout.polar.radialaxis
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickmode
        Parent: layout.polar.radialaxis
        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).

      • tickprefix
        Parent: layout.polar.radialaxis
        Type: string
        Default: ""

        Sets a tick label prefix.

      • ticks
        Parent: layout.polar.radialaxis
        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.

      • ticksuffix
        Parent: layout.polar.radialaxis
        Type: string
        Default: ""

        Sets a tick label suffix.

      • ticktext
        Parent: layout.polar.radialaxis
        Type: data array

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • tickvals
        Parent: layout.polar.radialaxis
        Type: data array

        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.polar.radialaxis
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • title
        Parent: layout.polar.radialaxis
        Type: object containing one or more of the keys listed below.
        • font
          Parent: layout.polar.radialaxis.title
          Type: object containing one or more of the keys listed below.

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

          • color
            Parent: layout.polar.radialaxis.title.font
            Type: color
          • family
            Parent: layout.polar.radialaxis.title.font
            Type: string

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

          • size
            Parent: layout.polar.radialaxis.title.font
            Type: number greater than or equal to 1
        • text
          Parent: layout.polar.radialaxis.title
          Type: string
          Default: ""

          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.

      • type
        Parent: layout.polar.radialaxis
        Type: enumerated , one of ( "-" | "linear" | "log" | "date" | "category" )
        Default: "-"

        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.

      • uirevision
        Parent: layout.polar.radialaxis
        Type: number or categorical coordinate string

        Controls persistence of user-driven changes in axis `range`, `autorange`, `angle`, and `title` if in `editable: true` configuration. Defaults to `polar<N>.uirevision`.

      • visible
        Parent: layout.polar.radialaxis
        Type: boolean
        Default: true

        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

    • sector
      Parent: layout.polar
      Type: array
      Default: [0, 360]

      Sets angular span of this polar subplot with two angles (in degrees). Sector are assumed to be spanned in the counterclockwise direction with "0" corresponding to rightmost limit of the polar subplot.

    • uirevision
      Parent: layout.polar
      Type: number or categorical coordinate string

      Controls persistence of user-driven changes in axis attributes, if not overridden in the individual axes. Defaults to `layout.uirevision`.