JavaScript Figure Reference: layout

  • title
    Parent: layout
    Type: object containing one or more of the keys listed below.
    • automargin
      Parent: layout.title
      Type: boolean

      Determines whether the title can automatically push the figure margins. If `yref='paper'` then the margin will expand to ensure that the title doesn’t overlap with the edges of the container. If `yref='container'` then the margins will ensure that the title doesn’t overlap with the plot area, tick labels, and axis titles. If `automargin=true` and the margins need to be expanded, then y will be set to a default 1 and yanchor will be set to an appropriate default to ensure that minimal margin space is needed. Note that when `yref='paper'`, only 1 or 0 are allowed y values. Invalid values will be reset to the default 1.

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

      Sets the title font.

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

        HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

      • lineposition
        Parent: layout.title.font
        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.title.font
        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.title.font
        Type: number greater than or equal to 1
      • style
        Parent: layout.title.font
        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.title.font
        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.title.font
        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.title.font
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

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

      Sets the padding of the title. Each padding value only applies when the corresponding `xanchor`/`yanchor` value is set accordingly. E.g. for left padding to take effect, `xanchor` must be set to "left". The same rule applies if `xanchor`/`yanchor` is determined automatically. Padding is muted if the respective anchor value is "middle"/"center".

      • b
        Parent: layout.title.pad
        Type: number
        Default: 0

        The amount of padding (in px) along the bottom of the component.

      • l
        Parent: layout.title.pad
        Type: number
        Default: 0

        The amount of padding (in px) on the left side of the component.

      • r
        Parent: layout.title.pad
        Type: number
        Default: 0

        The amount of padding (in px) on the right side of the component.

      • t
        Parent: layout.title.pad
        Type: number
        Default: 0

        The amount of padding (in px) along the top of the component.

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

        Sets the subtitle font.

        • color
          Parent: layout.title.subtitle.font
          Type: color
        • family
          Parent: layout.title.subtitle.font
          Type: string

          HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

        • lineposition
          Parent: layout.title.subtitle.font
          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.title.subtitle.font
          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.title.subtitle.font
          Type: number greater than or equal to 1
        • style
          Parent: layout.title.subtitle.font
          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.title.subtitle.font
          Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )