JavaScript > Figure Reference > layout.smith

JavaScript Figure Reference: layout.smith

  • smith
    Parent: layout
    Type: object containing one or more of the keys listed below.
    • bgcolor
      Parent: layout.smith
      Type: color
      Default: "#fff"

      Set the background color of the subplot

    • domain
      Parent: layout.smith
      Type: object containing one or more of the keys listed below.
      • column
        Parent: layout.smith.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 smith subplot .

      • row
        Parent: layout.smith.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 smith subplot .

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

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

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

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

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

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

        Sets the color of the grid lines.

      • griddash
        Parent: layout.smith.imaginaryaxis
        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.smith.imaginaryaxis
        Type: number greater than or equal to 0
        Default: 1

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

      • hoverformat
        Parent: layout.smith.imaginaryaxis
        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"

      • labelalias
        Parent: layout.smith.imaginaryaxis
        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.smith.imaginaryaxis
        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.smith.imaginaryaxis
        Type: color
        Default: "#444"

        Sets the axis line color.

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

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

      • showgrid
        Parent: layout.smith.imaginaryaxis
        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.smith.imaginaryaxis
        Type: boolean
        Default: true

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

      • showticklabels
        Parent: layout.smith.imaginaryaxis
        Type: boolean
        Default: true

        Determines whether or not the tick labels are drawn.

      • showtickprefix
        Parent: layout.smith.imaginaryaxis
        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.smith.imaginaryaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • tickcolor
        Parent: layout.smith.imaginaryaxis
        Type: color
        Default: "#444"

        Sets the tick color.

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

        Sets the tick font.

        • color
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: color
        • family
          Parent: layout.smith.imaginaryaxis.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".

        • lineposition
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
          Examples: "under", "over", "under+over", "under+over+through", "none"
          Default: "none"

          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.

        • shadow
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: string
          Default: "none"

          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.

        • size
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: number greater than or equal to 1
        • style
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: enumerated , one of ( "normal" | "italic" )
          Default: "normal"

          Sets whether a font should be styled with a normal or italic face from its family.

        • textcase
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
          Default: "normal"

          Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

        • variant
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
          Default: "normal"

          Sets the variant of the font.

        • weight
          Parent: layout.smith.imaginaryaxis.tickfont
          Type: integer between or equal to 1 and 1000
          Default: normal

          Sets the weight (or boldness) of the font.

      • tickformat
        Parent: layout.smith.imaginaryaxis
        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"

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

        Sets the tick length (in px).

      • tickprefix
        Parent: layout.smith.imaginaryaxis
        Type: string
        Default: ""

        Sets a tick label prefix.

      • ticks
        Parent: layout.smith.imaginaryaxis
        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.smith.imaginaryaxis
        Type: string
        Default: ""

        Sets a tick label suffix.

      • tickvals
        Parent: layout.smith.imaginaryaxis
        Type: data array

        Sets the values at which ticks on this axis appear. Defaults to `realaxis.tickvals` plus the same as negatives and zero.

      • tickwidth
        Parent: layout.smith.imaginaryaxis
        Type: number greater than or equal to 0
        Default: 2

        Sets the tick width (in px).

      • visible
        Parent: layout.smith.imaginaryaxis
        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

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

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

        Sets the color of the grid lines.

      • griddash
        Parent: layout.smith.realaxis
        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.smith.realaxis
        Type: number greater than or equal to 0
        Default: 1

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

      • hoverformat
        Parent: layout.smith.realaxis
        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"

      • labelalias
        Parent: layout.smith.realaxis
        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.smith.realaxis
        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.smith.realaxis
        Type: color
        Default: "#444"

        Sets the axis line color.

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

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

      • showgrid
        Parent: layout.smith.realaxis
        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.smith.realaxis
        Type: boolean
        Default: true

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

      • showticklabels
        Parent: layout.smith.realaxis
        Type: boolean
        Default: true

        Determines whether or not the tick labels are drawn.

      • showtickprefix
        Parent: layout.smith.realaxis
        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.smith.realaxis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • side
        Parent: layout.smith.realaxis
        Type: enumerated , one of ( "top" | "bottom" )
        Default: "top"

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

      • tickangle
        Parent: layout.smith.realaxis
        Type: angle
        Default: 90

        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.smith.realaxis
        Type: color
        Default: "#444"

        Sets the tick color.

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

        Sets the tick font.

        • color
          Parent: layout.smith.realaxis.tickfont
          Type: color
        • family
          Parent: layout.smith.realaxis.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".

        • lineposition
          Parent: layout.smith.realaxis.tickfont
          Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
          Examples: "under", "over", "under+over", "under+over+through", "none"
          Default: "none"

          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.

        • shadow
          Parent: layout.smith.realaxis.tickfont
          Type: string
          Default: "none"

          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.

        • size
          Parent: layout.smith.realaxis.tickfont
          Type: number greater than or equal to 1
        • style
          Parent: layout.smith.realaxis.tickfont
          Type: enumerated , one of ( "normal" | "italic" )
          Default: "normal"

          Sets whether a font should be styled with a normal or italic face from its family.

        • textcase
          Parent: layout.smith.realaxis.tickfont
          Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
          Default: "normal"

          Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

        • variant
          Parent: layout.smith.realaxis.tickfont
          Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
          Default: "normal"

          Sets the variant of the font.

        • weight
          Parent: layout.smith.realaxis.tickfont
          Type: integer between or equal to 1 and 1000
          Default: normal

          Sets the weight (or boldness) of the font.

      • tickformat
        Parent: layout.smith.realaxis
        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"

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

        Sets the tick length (in px).

      • tickprefix
        Parent: layout.smith.realaxis
        Type: string
        Default: ""

        Sets a tick label prefix.

      • ticks
        Parent: layout.smith.realaxis
        Type: enumerated , one of ( "top" | "bottom" | "" )

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "top" ("bottom"), this axis' are drawn above (below) the axis line.

      • ticksuffix
        Parent: layout.smith.realaxis
        Type: string
        Default: ""

        Sets a tick label suffix.

      • tickvals
        Parent: layout.smith.realaxis
        Type: data array
        Default: 0.20.5125

        Sets the values at which ticks on this axis appear.

      • tickwidth
        Parent: layout.smith.realaxis
        Type: number greater than or equal to 0
        Default: 2

        Sets the tick width (in px).

      • visible
        Parent: layout.smith.realaxis
        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