Python > Figure Reference > layout.smith

Python Figure Reference: layout.smith

  • smith
    Code: fig.update_smiths(...)
    Type: dict containing one or more of the keys listed below.
    • bgcolor
      Code: fig.update_smiths(bgcolor=<VALUE>)
      Type: color
      Default: "#fff"

      Set the background color of the subplot

    • domain
      Code: fig.update_smiths(domain=dict(...))
      Type: dict containing one or more of the keys listed below.
      • column
        Code: fig.update_smiths(domain_column=<VALUE>)
        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
        Code: fig.update_smiths(domain_row=<VALUE>)
        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
        Code: fig.update_smiths(domain_x=list(...))
        Type: list
        Default: [0, 1]

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

      • y
        Code: fig.update_smiths(domain_y=list(...))
        Type: list
        Default: [0, 1]

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

    • imaginaryaxis
      Code: fig.update_smiths(imaginaryaxis=dict(...))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_smiths(imaginaryaxis_color=<VALUE>)
        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
        Code: fig.update_smiths(imaginaryaxis_gridcolor=<VALUE>)
        Type: color
        Default: "#eee"

        Sets the color of the grid lines.

      • griddash
        Code: fig.update_smiths(imaginaryaxis_griddash=<VALUE>)
        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
        Code: fig.update_smiths(imaginaryaxis_gridwidth=<VALUE>)
        Type: number greater than or equal to 0
        Default: 1

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

      • hoverformat
        Code: fig.update_smiths(imaginaryaxis_hoverformat=<VALUE>)
        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
        Code: fig.update_smiths(imaginaryaxis_labelalias=<VALUE>)
        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
        Code: fig.update_smiths(imaginaryaxis_layer=<VALUE>)
        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
        Code: fig.update_smiths(imaginaryaxis_linecolor=<VALUE>)
        Type: color
        Default: "#444"

        Sets the axis line color.

      • linewidth
        Code: fig.update_smiths(imaginaryaxis_linewidth=<VALUE>)
        Type: number greater than or equal to 0
        Default: 1

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