Type object
File match visivo.yml visivo.yaml visivo_project.yml visivo_project.yaml *.visivo.yml *.visivo.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/visivo/latest.json
Source https://docs.visivo.io/assets/visivo_schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
defaults Defaults | null
Default: null
dbt Dbt | null
Default: null
project_file_path string | null
Default: null
project_dir string | null
Default: null
cli_version string | null

The version of the CLI that created the project.

Default: "1.0.79"
includes Include[]
Default:
[]
destinations SlackDestination | EmailDestination | ConsoleDestination[]
Default:
[]
alerts Alert[]
Default:
[]
sources SqliteSource | PostgresqlSource | MysqlSource | SnowflakeSource | BigQuerySource | RedshiftSource | DuckdbSource | CSVFileSource | ExcelFileSource | ClickhouseSource[]

A list of source objects.

Default:
[]
models SqlModel | CsvScriptModel | LocalMergeModel[]
Default:
[]
traces Trace[]
Default:
[]
insights Insight[]
Default:
[]
markdowns Markdown[]

A list of markdown objects for displaying formatted text in dashboards.

Default:
[]
tables Table[]
Default:
[]
charts Chart[]
Default:
[]
selectors Selector[]
Default:
[]
inputs SingleSelectInput | MultiSelectInput[]
Default:
[]
dashboards Dashboard | ExternalDashboard[]
Default:
[]
metrics Metric[]

A list of global metric objects that can reference multiple models.

Default:
[]
relations Relation[]

A list of relation objects defining how models can be joined.

Default:
[]
dimensions Dimension[]

A list of project-level dimension objects that can be used across models.

Default:
[]

Definitions

AggregationEnum string

The options for aggregating table columns. Details on the calculations below:

**count** - Finds the number of rows in a group<br>

**extent** - Finds the minimum and maximum values of a group of rows<br>

**max** - Finds the maximum value of a group of rows<br>

**mean** - Finds the average value of a group of rows<br>

**median** - Finds the median value of a group of rows<br>

**min** - Finds the minimum value of a group of rows<br>

**sum** - sums the values of a group of rows<br>

**uniqueCount** - Finds the number of unique values of a group of rows<br>

**unique** - Finds the unique values of a group of rows
Alert object
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
if_ string

A EvalString that must evaluate to true for the alert to fire

Default: null
destinations SlackDestination | EmailDestination | ConsoleDestination[]
Default:
[]
Attachment object
path string | null

A unique path to this object

Default: null
schema_name string
Default: "Name of the schema to attach the source under."
source object

SqliteSources hold the connection information to SQLite data sources.

!!! example {% raw %}

=== "Simple"

    ``` yaml
    sources:
      - name: sqlite_source
        database: local/file/local.db
        type: sqlite
    ```

=== "Additional Attached"
    Attaching other SQLite databases allows you to join models between databases.

    ``` yaml
    sources:
      - name: sqlite_source
        database: local/file/local.db
        type: sqlite
        attach:
          - schema_name: static
            name: static_source
            database: local/static/file/local.db
            type: sqlite
    ```

    The above source can be then used in a model and the sql for that model might look similar to: `SELECT * FROM local AS l JOIN static.data AS sd ON l.static_id=sd.id`

{% endraw %}

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
12 nested properties
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "sqlite"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
after_connect string | null
Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
attach Attachment[] | null

List of other local SQLite database sources to attach in the connection that will be available in the base SQL query.

Default: null
BigQuerySource object

BigQuerySources hold the connection information to Google BigQuery instances.

!!! info "BigQuery Authentication" You can authenticate BigQuery in one of two ways: 1. Pass a base64 encoded service account key to the credentials_base64 field. 2. Set the absolute file path to the credentials file in a environment variable named GOOGLE_APPLICATION_CREDENTIALS.

=== "Base64 Encoded Credentials"
    Using encoding the service key json credential file to base64 can be a useful way to authenticate BigQuery
    without logging into Google Cloud Console each time and makes it easier to manage credentials in CI/CD pipelines.

    However utilizing base64 encoding requires a few extra steps:

    1. Create a Google Cloud Service Account
        1. Go to the [Google Cloud Console](https://console.cloud.google.com)
        2. Select your project
        3. Navigate to "IAM & Admin" > "Service Accounts"
        4. Click "Create Service Account"
        5. Give it a name and description
        6. Grant it the "BigQuery Admin" role (or more restrictive custom role)
        7. Click "Done"
    2. Create and download credentials
        1. Find your service account in the list
        2. Click the three dots menu > "Manage keys"
        3. Click "Add Key" > "Create new key"
        4. Choose JSON format
        5. Click "Create" - this downloads your credentials file
    3. Convert credentials to base64
        ```bash
        # On Linux/Mac
        python -m base64 < credentials.json > encoded.txt

        # On Windows PowerShell
        [Convert]::ToBase64String([System.IO.File]::ReadAllBytes("credentials.json")) > encoded.txt
        ```
    4. Use the contents of encoded.txt as your credentials_base64 value. You can store the single line key in your untracked env file and use the `{% raw %}{{ env_var('VAR_NAME') }}{% endraw %}` syntax to reference the environment variable in your Visivo config.

=== "`GOOGLE_APPLICATION_CREDENTIALS` Environment Variable"
    If you use gcloud locally you probably have this environment variable configured already.

    Run `echo $GOOGLE_APPLICATION_CREDENTIALS` in your terminal. If it returns your crendetials then
    you're all set. and can configure a BigQuerySource without the `credentials_base64` field.

    If you don't have the environment variable, follow these steps:

    1. Create a Google Cloud Service Account
        1. Go to the [Google Cloud Console](https://console.cloud.google.com)
        2. Select your project
        3. Navigate to "IAM & Admin" > "Service Accounts"
        4. Click "Create Service Account"
        5. Give it a name and description
        6. Grant it the "BigQuery Admin" role (or more restrictive custom role)
        7. Click "Done"
    2. Create and download credentials
        1. Find your service account in the list
        2. Click the three dots menu > "Manage keys"
        3. Click "Add Key" > "Create new key"
        4. Choose JSON format
        5. Click "Create" - this downloads your credentials file
    3. Set the environment variable
        You can set the environment variable in your shell profile file.
        ```bash
        export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/credentials.json"
        ```
        or in your untracked .env file.
        ```
        GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/credentials.json
        ```
    This method is easier to manage and does not require any extra steps to authenticate.

The service account needs at minimum the "BigQuery User" role to execute queries.
For more restricted access, you can create a custom role with just the required permissions:

- bigquery.jobs.create
- bigquery.tables.get
- bigquery.tables.getData
- bigquery.tables.list

!!! example

=== "Simple"

    ``` yaml
        sources:
          - name: bigquery_source
            type: bigquery
            project: my-project-id
            database: my_dataset
            credentials_base64: {% raw %}{{ env_var('BIGQUERY_BASE64_ENCODED_CREDENTIALS') }}{% endraw %}
    ```

Note: Recommended environment variable use is covered in the sources overview.

project string required

The Google Cloud project ID that contains your BigQuery dataset.

type string required
Constant: "bigquery"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
after_connect string | null
Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
database string | null

The default BigQuery dataset to use for queries.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
credentials_base64 string | string | null

The Google Cloud service account credentials JSON string base64 encoded. Turn your JSON into a base64 string in the command line with python -m base64 < credentials.json > encoded.txt. Not required if GOOGLE_APPLICATION_CREDENTIALS environment variable is set.

Default: null
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 8
CSVFileSource object
type string required
Constant: "csv"
file string required

Path to the CSV file.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
delimiter string | null

CSV delimiter.

Default: ","
encoding string | null

CSV file encoding.

Default: "utf-8"
has_header boolean | null

Whether CSV has a header row.

Default: true
Chart object

Overview

Charts enable you to combine one or more traces with layout configurations (titles, axis labels, ect.).

!!! tip

You can add traces of **different types** to a chart. For example, you may want to display an [`indicator`](../Trace/Props/Indicator/)
on top of a [`bar`](../Trace/Props/Bar/) to show how what the bars add up to.

You can also configure interactivity in your charts by setting up a selector.

Common Configurations

Single Trace

This is the most common and simplest chart setup. You will use this when you want to display a single trace. !!! example "Single Trace"

??? note "Code"

    ``` yaml
    models:
      - name: Array of Numbers
        args: ["curl", "-s", "<https://raw.githubusercontent.com/visivo-io/data/refs/heads/main/y_values.csv>"]

    traces:
      - name: Simple Scatter
        model: ref(Array of Numbers)
        props:
          type: scatter
          x: ?{ ln(numbers_column)}
          y: ?{numbers_column}
          mode: markers
          marker:
            size: ?{ abs(sin(exp(numbers_column) - 5)*100) }
            opacity: ?{ abs(cos(exp(numbers_column) - 5)*100)/100 }
        filters:
          - ?{ numbers_column < 400 }
        order_by:
          - ?{numbers_column}

    charts:
      - name: Single Trace Chart
        traces:
          - ref(Simple Scatter)
        layout:
          title:
            text: "Single Trace"
    ```
![](../../../assets/example-charts/single-trace.png)

Duel Axis

When you want to display two different types of data on the same chart, duel axis can come in handy. !!! tip

You can actually create a third, and fourth axis ([see plotly docs](https://plotly.com/javascript/multiple-axes/#multiple-y-axes)), however, we do not recommended using more than two yaxes.

Here's a working example that you can copy and paste into your project: !!! example "Duel Y Axes"

??? note "Code"

    ``` yaml
    models:
      - name: Series of Numbers
        args: ["curl", "-s", "<https://raw.githubusercontent.com/visivo-io/data/refs/heads/main/y_values.csv>"]

    traces:
      - name: Yaxis Trace
        model: ref(Series of Numbers)
        props:
          type: bar
          y: ?{numbers_column}
          marker:
            color: '#713B57'
            opacity: .7
        order_by:
          - ?{numbers_column}

      - name: Yaxis2 Trace
        model: ref(Series of Numbers)
        props:
          type: scatter
          y: ?{ (500 -  numbers_column) }
          yaxis: 'y2'
          line:
            shape: spline
            smoothing: .1
            color: orange

        order_by:
          - ?{numbers_column}

    charts:
      - name: Duel Axis
        traces:
          - ref(Yaxis2 Trace)
          - ref(Yaxis Trace)
        layout:
          title:
            text: "Dual Axis"
          legend:
            orientation: "h"
          yaxis:
            title:
              text: "yaxis title"
              font:
                size: 18
                color: '#713B57'
          yaxis2:
            title:
              text: "yaxis2 title"
              font:
                size: 18
                color: orange
            side: right
            overlaying: 'y'
            anchor: 'y'
            showgrid: false

    ```
![](../../../assets/example-charts/duel-axis.png)

Position Traces with Domains

You can use domains to position traces on your chart. This is useful when you want to display multiple traces on your chart. The domain attribute in the trace props enables you to position your traces relative to 0,0 coordinates of the chart.

Here's some working examples that you can copy and paste into your project: !!! example "Trend Line + Multiple Indicators"

??? note "Code"

    ``` yaml
    models:
      - name: Numbers From Remote CSV
        args: ["curl", "-s", "<https://raw.githubusercontent.com/visivo-io/data/refs/heads/main/y_values.csv>"]

    traces:
      - name: Line Trace
        model: ref(Numbers From Remote CSV)
        props:
          type: scatter
          y: ?{numbers_column}
          line:
            shape: spline
            color: orange

      - name: Average Value
        model: ref(Numbers From Remote CSV)
        columns:
          avg_numbers_column: avg(numbers_column)
        props:
          type: indicator
          value: column(avg_numbers_column)[0]
          number:
            font:
              size: 35
            suffix: " avg"
          domain:
            y: [0, .7]
            x: [.5, 1]

      - name: Total Value
        model: ref(Numbers From Remote CSV)
        columns:
          sum_numbers_column: sum(numbers_column)
        props:
          type: indicator
          value: column(sum_numbers_column)[0]
          number:
            font:
              size: 35
            suffix: " sum"
          domain:
            y: [.5, 1]
            x: [.2, .5]

    charts:
      - name: Big Number Over Line Chart
        traces:
          - ref(Average Value)
          - ref(Total Value)
          - ref(Line Trace)
        layout:
          title:
            text: "Indicator + Scatter Plot"
    ```
![](../../../assets/example-charts/position-traces-with-domains.png)
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
selector string | string | Selector | null

The selector for the choosing which trace data is shown.

Default: null
traces string | string | Trace[]

A list of traces either written in line in the chart or called using the ref() function. Supports both for backward compatibility and future interactivity features.

Default:
[]
insights string | string | Insight[]

A list of insights either written in line in the chart or called using the ref() function. Supports both for backward compatibility and future interactivity features.

Default:
[]
layout Layout | null

A layout configuration that must adhere to the layout.schema.json file.

Default: null
ClickhouseSource object

ClickhouseSources hold the connection information to ClickHouse data sources. Supports both self-hosted ClickHouse and ClickHouse Cloud.

!!! example

=== "Simple (Self-hosted with Native TCP)"

    ``` yaml
        sources:
          - name: clickhouse_source
            type: clickhouse
            host: localhost
            port: 9000
            database: default
            username: default
            password: {% raw %}{{ env_var('CLICKHOUSE_PASSWORD') }}{% endraw %}
    ```

=== "HTTP Protocol"

    ``` yaml
        sources:
          - name: clickhouse_http
            type: clickhouse
            host: localhost
            port: 8123
            database: default
            username: default
            password: {% raw %}{{ env_var('CLICKHOUSE_PASSWORD') }}{% endraw %}
            protocol: http
    ```

=== "ClickHouse Cloud"

    ``` yaml
        sources:
          - name: clickhouse_cloud
            type: clickhouse
            host: your-instance.clickhouse.cloud
            port: 8443
            database: default
            username: default
            password: {% raw %}{{ env_var('CLICKHOUSE_PASSWORD') }}{% endraw %}
            protocol: http
            secure: true
    ```

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "clickhouse"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
after_connect string | null
Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The ClickHouse port. Default 9000 for native TCP, use 8123 for HTTP.

Default: 9000
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
protocol string | null

Connection protocol: 'native' (TCP, recommended) or 'http'.

Default: "native"
secure boolean | null

Use secure TLS connection. Required for ClickHouse Cloud with HTTP protocol.

Default: false
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 1
ConsoleDestination object
type string required
Constant: "console"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
called boolean
Default: false
message string
Default: "Console Destination Run"
CsvScriptModel object

CSV Script Models are a type of model that executes a command with a given set of args. This command needs to return a well formatted :fontawesome-solid-file-csv: with a header row to stdout.

Visivo will be able to access the generate file as a model by storing a duckdb file in the source directory.

!!! example {% raw %}

=== "Echo"

    Echoing all of your data is probably not a very practical example, but it does nicely demonstrate how the feature works!
    ``` yaml
    models:
      - name: csv
        table_name: csv
        args:
            - echo
            - |
              x,y
              1,9
              2,1
              3,2
              4,3
              5,5
              6,8
    ```

=== "Python Script"

    In this example we'll use python to generate a csv of processes running on your machine and make that csv available to Visivo as
    a model for analysis.
    ``` python title="created_processes_csv.py"
    import subprocess
    import csv
    import sys

    # Define the CSV file to write
    csv_file = "data/processes.csv"

    # Execute the 'ps aux' command
    result = subprocess.run(["ps", "aux"], stdout=subprocess.PIPE, text=True)

    # Split the output into lines
    lines = result.stdout.strip().split("/n")

    # Write CSV to stdout
    writer = csv.writer(sys.stdout)
    writer.writerow(
        ["USER","PID","%CPU","%MEM","VSZ","RSS","TTY","STAT","START","TIME","COMMAND"]
    )  # Header

    for line in lines[1:]:  # Skip the header line from the ps output
        row = line.split(None, 10)  # Split on whitespace, but only for the first 10 columns
        writer.writerow(row)
    ```
    With your script ready to go, all you have to do is convert `python create_processes_csv.py` into the args list format in a model.
    ``` yaml
    models:
      - name: processes
        table_name: processes
        args:
          - python
          - create_processes_csv.py
    ```{% endraw %}

=== "CSV File"

    One of the best use cases for this type of model is to store a static csv in your project and cat it into a model.
    This great because it's simple and allows you to version control your csv data.
    ``` csv title="file.csv"
    columns,go,up,here
    1,text,more text,6
    2,stuff,more stuff,7
    ```
    Then just `cat` the csv file in a model.
    ``` yaml
    models:
      - name: file_model
        table_name: file_model
        args:
          - cat
          - file.csv
    ```

The args are python subprocess list args and you can read their source documentation here.

name string required

The unique name of the object across the entire project.

args string[] required

An array of the variables that build your command to run.

path string | null

A unique path to this object

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
table_name string

The name to give the resulting models table

Default: "model"
pattern=[a-zA-Z0-9_]
allow_empty boolean

Whether to allow the command to return an empty csv.

Default: false
Dashboard object

Dashboards are lists of rows that enable you to build your dashboard grid.

!!! tip

By leveraging [`visivo serve`](./../../../cli/#serve) while building you can quickly optimize your layout. Simply re-size your row heights and item widths, save the file and quickly see the new layout of your dashboard on localhost:8000.

Within the rows you are able to organize and display charts, tables, selectors and markdown from your project as items.

!!! note

``` yaml title="visivo.project.yml"
dashboards:
  - name: Layout Example
    rows:
      - height: medium
        items: #item.width default is 1
          - chart: ...
          - chart: ...
          - chart: ...
      - height: large
        items:
          - width: 2
            table: ...
          - width: 1
            markdown: ...
      - height: small
        items:
          - width: 2
            selector: ...
          - chart: ...
          - chart: ...
          - width: 2
            chart: ...
```

Above you can see how changing the row heights and item widths impacts the layout of the dashboard.

!!! example

`row.height` defaults to `medium` and `item.width` defaults to `1`. Specifying those fields are optional if you want to use the default values
``` yaml
dashboards:
  - name: any-name-you-want  #unique name of your dashboard
    rows:
      - height: medium
        items:
          - width: 2  #widths are evaluated relative to other items in the row
            table: ref(a-table-name)
          - width 1  #this chart will be 1/3 of the row
            chart: ref(a-chart-name)
      - height: small
        items:
          - markdown: "# Some inline **markdown**"
          - chart: ref(another-chart)
          - width: 2
            chart: ref(a-third-chart)
```
name string required

The unique name of the dashboard across the entire project

path string | null

A unique path to this object

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
level integer | string | null

The importance level of the dashboard (either an index number or level title)

Default: null
tags string[]

A list of tags associated with the dashboard

description string | null

A description of the dashboard's purpose and contents

Default: null
type string

The type of dashboard (always 'internal')

Default: "internal"
Constant: "internal"
rows Row[]

A list of Row objects

Default:
[]
Dbt object

Configuration for pulling models and sources from a dbt project.

The integration will create models and sources from the dbt project and store them in the output directory.

It will pull all the "targets" defined in the profiles.yml file as sources. Each of these sources will be named in the format "prefix + dbt_profile + dbt_target".

Then it will create each of the dbt models as Visivo models pointing to the default profile and target. These models will be named in the format "prefix + dbt_model".

Using all the default values:

dbt:
  enabled: true

Or specify the input and/or output file and locations:

dbt:
  output_file: includes/dbt.yml
  dbt_project_yml_location: dbt
  profiles_yml_location: dbt
enabled boolean | null

Whether to enable the dbt phase. Defaults to true.

Default: true
output_file string | null

The file to store the dbt models and sources relative to the working directory. Defaults to the '$output_directory/dbt.yml'. It is useful to store the file in a different location so it can be checked into source control.

Default: null
dbt_project_yml_location string | null

Location for the dbt_project.yml file relative to the working directory. Defaults to the current working directory.

Default: null
profiles_yml_location string | null

Location for the profiles.yml file relative to the working directory. Defaults to the current working directory.

Default: null
prefix string

Prefix for the dbt models and sources. Defaults to no prefix. You may want to add one if the dbt model names are in conflict with other models in your project.

Default: ""
Defaults object
alert_name string | null

The name of an alert defined elsewhere in the Visivo project.

Default: null
source_name string | null

The name of a source defined elsewhere in the Visivo project.

Default: null
threads integer | null

The number of threads to use when running queries.

Default: 8
levels Level[]

Enables you to customize the project level view of your dashboards. Ordered list of dashboard levels with titles and descriptions

Examples: {"description":"The most important dashboards and metrics for the organization","title":"Overview"}, {"description":"The most important dashboards & metrics for a department","title":"Department"}
telemetry_enabled boolean | null

Controls whether anonymous usage telemetry is collected for this project. When set to false, no telemetry data will be sent. Can also be disabled globally via VISIVO_TELEMETRY_DISABLED environment variable.

Default: null
Dimension object

A Dimension represents a computed field at the row level that can be used for grouping or filtering.

Unlike metrics which are aggregates, dimensions are calculated for each row and can be used in GROUP BY clauses or as filter conditions. They allow you to define reusable calculated fields without repeating the logic in every query.

!!! example yaml models: - name: orders sql: SELECT * FROM orders_table dimensions: - name: order_month expression: "DATE_TRUNC('month', order_date)" description: "Month when the order was placed" - name: is_high_value expression: "CASE WHEN amount > 1000 THEN true ELSE false END" description: "Whether this is a high-value order"

expression string required

SQL expression that computes the dimension value for each row. Can reference any field from the parent model.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
data_type string | null

SQL data type of the dimension (e.g., VARCHAR, INTEGER, DATE). Automatically detected for implicit dimensions extracted from model columns.

Default: null
description string | null

Human-readable description of what this dimension represents.

Default: null
DuckdbAttachment object
path string | null

A unique path to this object

Default: null
schema_name string
Default: "Name of the schema to attach the source under."
source object

DuckdbSources hold the connection information to DuckDB data sources.

!!! example

=== "Simple"

    ``` yaml
        sources:
          - name: duckdb_source
            type: duckdb
            database: local/file/database.db
            connection_pool_size: 2
    ```

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
12 nested properties
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "duckdb"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 1
attach DuckdbAttachment[] | null

List of other local Duckdb database sources to attach in the connection that will be available in the base SQL query.

Default: null
DuckdbSource object

DuckdbSources hold the connection information to DuckDB data sources.

!!! example

=== "Simple"

    ``` yaml
        sources:
          - name: duckdb_source
            type: duckdb
            database: local/file/database.db
            connection_pool_size: 2
    ```

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "duckdb"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 1
attach DuckdbAttachment[] | null

List of other local Duckdb database sources to attach in the connection that will be available in the base SQL query.

Default: null
EmailDestination object

You can configure email destinations for any SMTP provider. Here's an example of this configuration looks in your yaml file:

destinations:
  - name: email-destination #any unique name of your choosing
    type: email
    subject: "[ALERT] Your Visivo Tests Have Failed" #can be any message you want
    to: someone@your_company.com
    port: 2525 #is this port by default
    host: your_company_email_server.com
    username: someones_username
    password: {% raw %}{{ env_var('EMAIL_PASSWORD')}}{% endraw %} #We'd recommend using environment variables here for security

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
type string

The type of alert destination.

Default: null
Constant: "email"
subject string

Subject of the alert email.

Default: "Visivo Destination"
to string

The email to send the alert to.

Default: null
port integer

The port of the email server that the destination is connecting to.

Default: 2525
host string

The host of the email server that the destination is connecting to.

Default: null
username string

The username for authenticating the email server.

Default: null
password string

The password for authenticating the email server.

Default: null
ExcelFileSource object
type string required
Constant: "xls"
file string required

Path to the Excel file.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
delimiter string | null

Excel delimiter.

Default: ","
encoding string | null

Excel file encoding.

Default: "utf-8"
has_header boolean | null

Whether Excel has a header row.

Default: true
ExternalDashboard object

Represents an external dashboard that links to another system or URL

name string required

The unique name of the dashboard across the entire project

href string required

URL to the external dashboard

format=uriminLength=1maxLength=2083
path string | null

A unique path to this object

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
level integer | string | null

The importance level of the dashboard (either an index number or level title)

Default: null
tags string[]

A list of tags associated with the dashboard

description string | null

A description of the dashboard's purpose and contents

Default: null
type string

The type of dashboard (always 'external')

Default: "external"
Constant: "external"
HeightEnum string
Include object

Include's can be used to break apart a project file with references to other files. This includes files from remote github repositories.

Read more about includes here

path string

The path or git reference to external yml files or directories to include in this project

Default: null
depth integer | null

Directory traversal depth. None=fully recursive, 0=current directory only, 1=one level deep, etc. Only applies to directory paths.

Default: null
exclusions string[]

Patterns to exclude from directory inclusion. Supports glob patterns and regex. Only applies to directory paths.

Default:
[]
Insight object

The Insight is the central visualization object in Visivo Interactivity 2.0.

Insights replace Traces, providing a cleaner separation between server-side data preparation and client-side interactivity. Unlike traces, insights generate flat JSON structures that can be manipulated in the browser for responsive dashboards.

Why Insights?

  • Simpler Mental Model – No more mixing cohort logic or trace naming rules
  • Interactive by Default – Client-side filtering, splitting, and sorting
  • Reusable – Insights can appear in multiple charts & tables
  • Fast – Pre-computed data cached server-side, interactions run locally

Core Components

  • model: The SQL model or reference that defines the server-side dataset
  • props: Visualization config (chart type, axes, encodings)
  • interactions: Client-side transformations (filter, split, sort)

Example

insights:
  - name: revenue-by-month
    description: "Monthly revenue trends"

    props:
      type: scatter
      mode: lines+markers
      x: ?{ date_trunc('month', created_at) }
      y: ?{ sum(amount) }

    interactions:
      - filter: ?{ month >= ${ref(date-range).start} }
      - split: ?{ region }
      - sort: ?{ month ASC }

In the example above:

  • Server-side: Revenue is aggregated by month.
  • Client-side: A date-range filter and region split are applied instantly in the browser.

Interactions

Interactions define how users can manipulate data locally:

  • Filter: Subset rows by conditions (WHERE logic)
  • Split: Break a single insight into multiple series (replaces cohort_on)
  • Sort: Order data dynamically

Example:

interactions:
  - filter: ?{ sales_amount > 1000 AND region = ${ref(sales-region).value} }
  - split: ?{ product_category }
  - sort: ?{ date DESC, amount ASC }

Migration from Traces

  • cohort_onsplit interaction
name string required

The unique name of the insight across the entire project.

path string | null

A unique path to this object

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
description string | null

Optional description of what this insight represents.

Default: null
interactions InsightInteraction[] | null

Leverage Inputs to create client-side interactions that will be applied to the insight data.

Default: null
layout object

A schema to validate plotly layout

88 nested properties
activeselection object
2 nested properties
fillcolor query-string | color

Sets the color filling the active selection' interior.

opacity query-string | number

Sets the opacity of the active selection.

activeshape object
2 nested properties
fillcolor query-string | color

Sets the color filling the active shape' interior.

opacity query-string | number

Sets the opacity of the active shape.

annotations object[]
minItems=1
autosize query-string | boolean

Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

autotypenumbers query-string | enum

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. This is the default value; however it could be overridden for individual axes.

calendar query-string | enum

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

clickmode query-string | string | string

Determines the mode of single click interactions. event is the default value and emits the plotly_click event. In addition this mode emits the plotly_selected event in drag modes lasso and select, but with no event data attached (kept for compatibility reasons). The select flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. select with hovermode: x can be confusing, consider explicitly setting hovermode: closest when using this feature. Selection events are sent accordingly as long as event flag is set as well. When the event flag is missing, plotly_click and plotly_selected events are not fired.

coloraxis object
9 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, cmax must be set as well.

colorbar object
colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

colorscale object
3 nested properties
diverging query-string | colorscale

Sets the default diverging colorscale. Note that autocolorscale must be true for this attribute to work.

sequential query-string | colorscale

Sets the default sequential colorscale for positive values. Note that autocolorscale must be true for this attribute to work.

sequentialminus query-string | colorscale

Sets the default sequential colorscale for negative values. Note that autocolorscale must be true for this attribute to work.

colorway query-string | color[]

Sets the default trace colors.

computed

Placeholder for exporting automargin-impacting values namely margin.t, margin.b, margin.l and margin.r in full-json mode.

datarevision

If provided, a changed value tells Plotly.react that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, Plotly.react assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

dragmode query-string | enum

Determines the mode of drag interactions. select and lasso apply only to scatter traces with markers or text. orbit and turntable apply only to 3D scenes.

editrevision

Controls persistence of user-driven changes in editable: true configuration, other than trace names and axis titles. Defaults to layout.uirevision.

font object
9 nested properties
family 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.

Default: ""Open Sans", verdana, arial, sans-serif"
pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

geo object
32 nested properties
bgcolor query-string | color

Set the background color of the map

center object
coastlinecolor query-string | color

Sets the coastline color.

coastlinewidth query-string | number

Sets the coastline stroke width (in px).

countrycolor query-string | color

Sets line color of the country boundaries.

countrywidth query-string | number

Sets line width (in px) of the country boundaries.

domain object
fitbounds query-string | enum

Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting fitbounds leads to center.lon and center.lat getting auto-filled. On maps with a non-clipped projection, setting fitbounds leads to center.lon, center.lat, and projection.rotation.lon getting auto-filled. On maps with a clipped projection, setting fitbounds leads to center.lon, center.lat, projection.rotation.lon, projection.rotation.lat, lonaxis.range and lataxis.range getting auto-filled. If locations, only the trace's visible locations are considered in the fitbounds computations. If geojson, the entire trace input geojson (if provided) is considered in the fitbounds computations, Defaults to false.

framecolor query-string | color

Sets the color the frame.

framewidth query-string | number

Sets the stroke width (in px) of the frame.

lakecolor query-string | color

Sets the color of the lakes.

landcolor query-string | color

Sets the land mass color.

lataxis object
lonaxis object
oceancolor query-string | color

Sets the ocean color

projection object
resolution query-string | enum

Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

rivercolor query-string | color

Sets color of the rivers.

riverwidth query-string | number

Sets the stroke width (in px) of the rivers.

scope query-string | enum

Set the scope of the map.

showcoastlines query-string | boolean

Sets whether or not the coastlines are drawn.

showcountries query-string | boolean

Sets whether or not country boundaries are drawn.

showframe query-string | boolean

Sets whether or not a frame is drawn around the map.

showlakes query-string | boolean

Sets whether or not lakes are drawn.

showland query-string | boolean

Sets whether or not land masses are filled in color.

showocean query-string | boolean

Sets whether or not oceans are filled in color.

showrivers query-string | boolean

Sets whether or not rivers are drawn.

showsubunits query-string | boolean

Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.

subunitcolor query-string | color

Sets the color of the subunits boundaries.

subunitwidth query-string | number

Sets the stroke width (in px) of the subunits boundaries.

uirevision

Controls persistence of user-driven changes in the view (projection and center). Defaults to layout.uirevision.

visible query-string | boolean

Sets the default visibility of the base layers.

grid object
12 nested properties
columns query-string | integer

The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

domain object
pattern query-string | enum

If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: coupled gives one x axis per column and one y axis per row. independent uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder.

roworder query-string | enum

Is the first row the top or the bottom? Note that columns are always enumerated from left to right.

rows query-string | integer

The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

subplots query-string | query-string | string | enum[]

Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like xy or x3y2, or ** to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute.

xaxes query-string | query-string | string | enum[]

Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like x, x2, etc., or ** to not put an x axis in that column. Entries other than ** must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs.

xgap query-string | number

Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.

xside query-string | enum

Sets where the x axis labels and titles go. bottom means the very bottom of the grid. bottom plot is the lowest plot that each x axis is used in. top and top plot are similar.

yaxes query-string | query-string | string | enum[]

Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like y, y2, etc., or ** to not put a y axis in that row. Entries other than ** must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs.

ygap query-string | number

Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.

yside query-string | enum

Sets where the y axis labels and titles go. left means the very left edge of the grid. left plot is the leftmost plot that each y axis is used in. right and right plot are similar.

height query-string | number

Sets the plot's height (in px).

hidesources query-string | boolean

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).

hoverdistance query-string | integer

Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.

hoverlabel object
6 nested properties
align query-string | enum

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

bgcolor query-string | color

Sets the background color of all hover labels on graph

bordercolor query-string | color

Sets the border color of all hover labels on graph.

font object
grouptitlefont object
namelength query-string | integer

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

hovermode query-string | enum

Determines the mode of hover interactions. If closest, a single hoverlabel will appear for the closest point within the hoverdistance. If x (or y), multiple hoverlabels will appear for multiple points at the closest x- (or y-) coordinate within the hoverdistance, with the caveat that no more than one hoverlabel will appear per trace. If x unified (or y unified), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the hoverdistance with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled.

hoversubplots query-string | enum

Determines expansion of hover effects to other subplots If single just the axis pair of the primary point is included without overlaying subplots. If overlaying all subplots using the main axis and occupying the same space are included. If axis, also include stacked subplots using the same axis when hovermode is set to x, x unified, y or y unified.

images object[]
minItems=1
legend object
27 nested properties
bgcolor query-string | color

Sets the legend background color. Defaults to layout.paper_bgcolor.

bordercolor query-string | color

Sets the color of the border enclosing the legend.

borderwidth query-string | number

Sets the width (in px) of the border enclosing the legend.

entrywidth query-string | number

Sets the width (in px or fraction) of the legend. Use 0 to size the entry based on the text width, when entrywidthmode is set to pixels.

entrywidthmode query-string | enum

Determines what entrywidth means.

font object
groupclick query-string | enum

Determines the behavior on legend group item click. toggleitem toggles the visibility of the individual item clicked on the graph. togglegroup toggles the visibility of all items in the same legendgroup as the item clicked on the graph.

grouptitlefont object
indentation query-string | number

Sets the indentation (in px) of the legend entries.

itemclick query-string | enum

Determines the behavior on legend item click. toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disables legend item click interactions.

itemdoubleclick query-string | enum

Determines the behavior on legend item double-click. toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disables legend item double-click interactions.

itemsizing query-string | enum

Determines if the legend items symbols scale with their corresponding trace attributes or remain constant independent of the symbol size on the graph.

itemwidth query-string | number

Sets the width (in px) of the legend item symbols (the part other than the title.text).

maxheight query-string | number

Sets the max height (in px) of the legend, or max height ratio (reference height * ratio) if less than one. Default value is: 0.5 for horizontal legends; 1 for vertical legends. The minimum allowed height is 30px. For a ratio of 0.5, the legend will take up to 50% of the reference height before displaying a scrollbar. The reference height is the full layout height except for vertically oriented legends with a yref of "paper", where the reference height is the plot height.

orientation query-string | enum

Sets the orientation of the legend.

title object
tracegroupgap query-string | number

Sets the amount of vertical space (in px) between legend groups.

traceorder query-string | string | string

Determines the order at which the legend items are displayed. If normal, the items are displayed top-to-bottom in the same order as the input data. If reversed, the items are displayed in the opposite order as normal. If grouped, the items are displayed in groups (when a trace legendgroup is provided). if grouped+reversed, the items are displayed in the opposite order as grouped.

uirevision

Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to layout.uirevision.

valign query-string | enum

Sets the vertical alignment of the symbols with respect to their associated text.

visible query-string | boolean

Determines whether or not this legend is visible.

x query-string | number

Sets the x position with respect to xref (in normalized coordinates) of the legend. When xref is paper, defaults to 1.02 for vertical legends and defaults to 0 for horizontal legends. When xref is container, defaults to 1 for vertical legends and defaults to 0 for horizontal legends. Must be between 0 and 1 if xref is container. and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets the legend's horizontal position anchor. This anchor binds the x position to the left, center or right of the legend. Value auto anchors legends to the right for x values greater than or equal to 2/3, anchors legends to the left for x values less than or equal to 1/3 and anchors legends with respect to their center otherwise.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref (in normalized coordinates) of the legend. When yref is paper, defaults to 1 for vertical legends, defaults to -0.1 for horizontal legends on graphs w/o range sliders and defaults to 1.1 for horizontal legends on graph with one or multiple range sliders. When yref is container, defaults to 1. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets the legend's vertical position anchor This anchor binds the y position to the top, middle or bottom of the legend. Value auto anchors legends at their bottom for y values less than or equal to 1/3, anchors legends to at their top for y values greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

map object
9 nested properties
bearing query-string | number

Sets the bearing angle of the map in degrees counter-clockwise from North (map.bearing).

bounds object
center object
domain object
layers object[]
minItems=1
pitch query-string | number

Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (map.pitch).

style

Defines the map layers that are rendered by default below the trace layers defined in data, which are themselves by default rendered below the layers defined in layout.map.layers. These layers can be defined either explicitly as a Map Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes or by using a custom style URL Map Style objects are of the form described in the MapLibre GL JS documentation available at https://maplibre.org/maplibre-style-spec/ The built-in plotly.js styles objects are: basic, carto-darkmatter, carto-darkmatter-nolabels, carto-positron, carto-positron-nolabels, carto-voyager, carto-voyager-nolabels, dark, light, open-street-map, outdoors, satellite, satellite-streets, streets, white-bg.

Default: "basic"
uirevision

Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch. Defaults to layout.uirevision.

zoom query-string | number

Sets the zoom level of the map (map.zoom).

mapbox object
10 nested properties
accesstoken string

Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under mapboxAccessToken. Note that accessToken are only required when style (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.

pattern=.*\S.*$
bearing query-string | number

Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).

bounds object
center object
domain object
layers object[]
minItems=1
pitch query-string | number

Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).

style

Defines the map layers that are rendered by default below the trace layers defined in data, which are themselves by default rendered below the layers defined in layout.mapbox.layers. These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the accesstoken attribute or in the mapboxAccessToken config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox--

Default: "basic"
uirevision

Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch. Defaults to layout.uirevision.

zoom query-string | number

Sets the zoom level of the map (mapbox.zoom).

margin object
6 nested properties
autoexpand query-string | boolean

Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults.

b query-string | number

Sets the bottom margin (in px).

l query-string | number

Sets the left margin (in px).

pad query-string | number

Sets the amount of padding (in px) between the plotting area and the axis lines

r query-string | number

Sets the right margin (in px).

t query-string | number

Sets the top margin (in px).

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

minreducedheight query-string | number

Minimum height of the plot with margin.automargin applied (in px)

minreducedwidth query-string | number

Minimum width of the plot with margin.automargin applied (in px)

modebar object
9 nested properties
activecolor query-string | color

Sets the color of the active or hovered on icons in the modebar.

add string | string[]

Determines which predefined modebar buttons to add. Please note that these buttons will only be shown if they are compatible with all trace types used in a graph. Similar to config.modeBarButtonsToAdd option. This may include v1hovermode, hoverclosest, hovercompare, togglehover, togglespikelines, drawline, drawopenpath, drawclosedpath, drawcircle, drawrect, eraseshape.

addsrc string

Sets the source reference on Chart Studio Cloud for add.

bgcolor query-string | color

Sets the background color of the modebar.

Sets the color of the icons in the modebar.

orientation query-string | enum

Sets the orientation of the modebar.

remove string | string[]

Determines which predefined modebar buttons to remove. Similar to config.modeBarButtonsToRemove option. This may include autoScale2d, autoscale, editInChartStudio, editinchartstudio, hoverCompareCartesian, hovercompare, lasso, lasso2d, orbitRotation, orbitrotation, pan, pan2d, pan3d, reset, resetCameraDefault3d, resetCameraLastSave3d, resetGeo, resetSankeyGroup, resetScale2d, resetViewMap, resetViewMapbox, resetViews, resetcameradefault, resetcameralastsave, resetsankeygroup, resetscale, resetview, resetviews, select, select2d, sendDataToCloud, senddatatocloud, tableRotation, tablerotation, toImage, toggleHover, toggleSpikelines, togglehover, togglespikelines, toimage, zoom, zoom2d, zoom3d, zoomIn2d, zoomInGeo, zoomInMap, zoomInMapbox, zoomOut2d, zoomOutGeo, zoomOutMap, zoomOutMapbox, zoomin, zoomout.

removesrc string

Sets the source reference on Chart Studio Cloud for remove.

uirevision

Controls persistence of user-driven changes related to the modebar, including hovermode, dragmode, and showspikes at both the root level and inside subplots. Defaults to layout.uirevision.

newselection object
2 nested properties
line object
mode query-string | enum

Describes how a new selection is created. If immediate, a new selection is created after first mouse up. If gradual, a new selection is not created after first mouse. By adding to and subtracting from the initial selection, this option allows declaring extra outlines of the selection.

newshape object
15 nested properties
drawdirection query-string | enum

When dragmode is set to drawrect, drawline or drawcircle this limits the drag to be horizontal, vertical or diagonal. Using diagonal there is no limit e.g. in drawing lines in any direction. ortho limits the draw to be either horizontal or vertical. horizontal allows horizontal extend. vertical allows vertical extend.

fillcolor query-string | color

Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.

fillrule query-string | enum

Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule

label object
layer query-string | enum

Specifies whether new shapes are drawn below gridlines (below), between gridlines and traces (between) or above traces (above).

legend query-string | string

Sets the reference to a legend to show new shape in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for new shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
legendrank query-string | number

Sets the legend rank for new shape. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for new shape.

line object
name string

Sets new shape name. The name appears as the legend item.

opacity query-string | number

Sets the opacity of new shapes.

showlegend query-string | boolean

Determines whether or not new shape is shown in the legend.

visible query-string | enum

Determines whether or not new shape is visible. If legendonly, the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

paper_bgcolor query-string | color

Sets the background color of the paper where the graph is drawn.

plot_bgcolor query-string | color

Sets the background color of the plotting area in-between x and y axes.

polar object
8 nested properties
angularaxis object
bgcolor query-string | color

Set the background color of the subplot

domain object
gridshape query-string | enum

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 query-string | number

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

radialaxis object
sector query-string | query-string | number[]

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

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

scene object
12 nested properties
annotations object[]
minItems=1
aspectmode query-string | enum

If cube, this scene's axes are drawn as a cube, regardless of the axes' ranges. If data, this scene's axes are drawn in proportion with the axes' ranges. If manual, this scene's axes are drawn in proportion with the input of aspectratio (the default behavior if aspectratio is provided). If auto, this scene's axes are drawn using the results of data except when one axis is more than four times the size of the two others, where in that case the results of cube are used.

aspectratio object
bgcolor query-string | color
camera object
domain object
dragmode query-string | enum

Determines the mode of drag interactions for this scene.

hovermode query-string | enum

Determines the mode of hover interactions for this scene.

uirevision

Controls persistence of user-driven changes in camera attributes. Defaults to layout.uirevision.

xaxis object
yaxis object
zaxis object
selectdirection query-string | enum

When dragmode is set to select, this limits the selection of the drag to horizontal, vertical or diagonal. h only allows horizontal selection, v only vertical, d only diagonal and any sets no limit.

selectionrevision

Controls persistence of user-driven changes in selected points from all traces.

selections object[]
minItems=1
separators string

Sets the decimal and thousand separators. For example, *. * puts a '.' before decimals and a space between thousands. In English locales, dflt is ., but other locales may alter this default.

shapes object[]
minItems=1
showlegend query-string | boolean

Determines whether or not a legend is drawn. Default is true if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with showlegend: true.

sliders object[]
minItems=1
smith object
4 nested properties
bgcolor query-string | color

Set the background color of the subplot

domain object
imaginaryaxis object
realaxis object
spikedistance query-string | integer

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

template

Default attributes to be applied to the plot. Templates can be created from existing plots using Plotly.makeTemplate, or created manually. They should be objects with format: {layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...} layoutTemplate and traceTemplate are objects matching the attribute structure of layout and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false.

ternary object
7 nested properties
aaxis object
baxis object
bgcolor query-string | color

Set the background color of the subplot

caxis object
domain object
sum query-string | number

The number each triplet should sum to, and the maximum range of each axis

uirevision

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

title object
11 nested properties
automargin query-string | 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 object
pad object
subtitle object
text string

Sets the plot's title.

x query-string | number

Sets the x position with respect to xref in normalized coordinates from 0 (left) to 1 (right).

xanchor query-string | enum

Sets the title's horizontal alignment with respect to its x position. left means that the title starts at x, right means that the title ends at x and center means that the title's center is at x. auto divides xref by three and calculates the xanchor value automatically based on the value of x.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref in normalized coordinates from 0 (bottom) to 1 (top). auto places the baseline of the title onto the vertical center of the top margin.

yanchor query-string | enum

Sets the title's vertical alignment with respect to its y position. top means that the title's cap line is at y, bottom means that the title's baseline is at y and middle means that the title's midline is at y. auto divides yref by three and calculates the yanchor value automatically based on the value of y.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

transition object
3 nested properties
duration query-string | number

The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.

easing query-string | enum

The easing function used for the transition

ordering query-string | enum

Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change.

uirevision

Used to allow user interactions with the plot to persist after Plotly.react calls that are unaware of these interactions. If uirevision is omitted, or if it is given and it changed from the previous Plotly.react call, the exact new figure is used. If uirevision is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. layout.uirevision attribute serves as the default for uirevision attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set xaxis.uirevision=*time* and yaxis.uirevision=*cost*. Then if only the y data is changed, you can update yaxis.uirevision=*quantity* and the y axis range will reset but the x axis range will retain any user-driven zoom.

uniformtext object
2 nested properties
minsize query-string | number

Sets the minimum text size between traces of the same type.

mode query-string | enum

Determines how the font size for various text elements are uniformed between each trace type. If the computed text sizes were smaller than the minimum size defined by uniformtext.minsize using hide option hides the text; and using show option shows the text without further downscaling. Please note that if the size defined by minsize is greater than the font size defined by trace, then the minsize is used.

updatemenus object[]
minItems=1
width query-string | number

Sets the plot's width (in px).

xaxis object
91 nested properties
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
autotickangles query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

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

dividerwidth query-string | number

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

domain query-string | query-string | number[]

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

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

minor object
mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

rangeselector object
rangeslider object
scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

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

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

yaxis object
91 nested properties
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
autoshift query-string | 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 query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

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

dividerwidth query-string | number

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

domain query-string | query-string | number[]

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

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

minor object
mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

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

shift query-string | number

Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If autoshift is set to true, then this defaults to a padding of -3 if side is set to left. and defaults to +3 if side is set to right. Defaults to 0 if autoshift is set to false. Only has an effect if anchor is set to free.

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

barcornerradius

Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).

bargap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

bargroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

barmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With stack, the bars are stacked on top of one another With relative, the bars are stacked on top of one another, with negative values below the axis, positive values above With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

barnorm query-string | enum

Sets the normalization for bar traces on the graph. With fraction, the value of each bar is divided by the sum of all values at that location coordinate. percent is the same but multiplied by 100 to show percentages.

boxgap query-string | number

Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have width set.

boxgroupgap query-string | number

Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have width set.

boxmode query-string | enum

Determines how boxes at the same location coordinate are displayed on the graph. If group, the boxes are plotted next to one another centered around the shared location. If overlay, the boxes are plotted over one another, you might need to set opacity to see them multiple boxes. Has no effect on traces that have width set.

funnelgap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

funnelgroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

funnelmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With stack, the bars are stacked on top of one another With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

extendfunnelareacolors query-string | boolean

If true, the funnelarea slice colors (whether given by funnelareacolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

funnelareacolorway query-string | color[]

Sets the default funnelarea slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendfunnelareacolors.

hiddenlabels query-string | number | string[]

hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts

hiddenlabelssrc string

Sets the source reference on Chart Studio Cloud for hiddenlabels.

extendiciclecolors query-string | boolean

If true, the icicle slice colors (whether given by iciclecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

iciclecolorway query-string | color[]

Sets the default icicle slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendiciclecolors.

extendpiecolors query-string | boolean

If true, the pie slice colors (whether given by piecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

piecolorway query-string | color[]

Sets the default pie slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendpiecolors.

scattergap query-string | number

Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to bargap.

scattermode query-string | enum

Determines how scatter points at the same location coordinate are displayed on the graph. With group, the scatter points are plotted next to one another centered around the shared location. With overlay, the scatter points are plotted over one another, you might need to reduce opacity to see multiple scatter points.

extendsunburstcolors query-string | boolean

If true, the sunburst slice colors (whether given by sunburstcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

sunburstcolorway query-string | color[]

Sets the default sunburst slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendsunburstcolors.

extendtreemapcolors query-string | boolean

If true, the treemap slice colors (whether given by treemapcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

treemapcolorway query-string | color[]

Sets the default treemap slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendtreemapcolors.

violingap query-string | number

Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have width set.

violingroupgap query-string | number

Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have width set.

violinmode query-string | enum

Determines how violins at the same location coordinate are displayed on the graph. If group, the violins are plotted next to one another centered around the shared location. If overlay, the violins are plotted over one another, you might need to set opacity to see them multiple violins. Has no effect on traces that have width set.

waterfallgap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

waterfallgroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

waterfallmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

InsightInteraction object

Represents a client-side interaction that can be applied to insight data.

filter string | null

Filter expression to apply to the data on the client side

Default: null
split string | null

Column or expression to split data into multiple traces

Default: null
sort string | null

Column or expression to sort data by

Default: null
InsightProps object
type string required
Values: "bar" "barpolar" "box" "candlestick" "carpet" "choropleth" "choroplethmap" "choroplethmapbox" "cone" "contour" "contourcarpet" "densitymap" "densitymapbox" "funnel" "funnelarea" "heatmap" "histogram" "histogram2d" "histogram2dcontour" "icicle" "image" "indicator" "isosurface" "mesh3d" "ohlc" "parcats" "parcoords" "pie" "sankey" "scatter" "scatter3d" "scattercarpet" "scattergeo" "scattergl" "scattermap" "scattermapbox" "scatterpolar" "scatterpolargl" "scattersmith" "scatterternary" "splom" "streamtube" "sunburst" "surface" "treemap" "violin" "volume" "waterfall"
Item object

The Item houses a single chart, table, selector, markdown, or input object.

It also informs the width that the chart, table or markdown should occupy within a row. Widths are evaluated for each item in a row relative to all of the other items in the row.

In the example below, the markdown would take up 1/4th of the row and would be positioned on the left edge. The table would also take up 1/4th of the page and would sit to the right of the markdown. The chart would take up 1/2 of the page and would touch the right edge of the row.

items:
  - width: 1
    markdown: ref(welcome-markdown)
  - width: 1
    table: ref(table-name)
  - width: 2
    chart: ref(chart-name)
  - width: 1
    selector: ref(selector-name)
  - width: 1
    input: ref(input-name)

Markdown

Reference a markdown object to add formatted text to your dashboard:

markdowns:
  - name: welcome-markdown
    content: |
      # Welcome to Visivo
      This is **formatted** text.
    align: center
    justify: start

dashboards:
  - name: my-dashboard
    rows:
      - items:
          - markdown: ref(welcome-markdown)

Markdown content supports CommonMark and GitHub Flavored Markdown. You can also render raw HTML within your markdown.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
width integer

The width of the Item determines is evaluated relative to the other items in a row.

Default: 1
markdown string | string | Markdown | string | null

A Markdown object defined inline, a ref() to a markdown, or a markdown string (deprecated).

Default: null
align string | null

DEPRECATED: Use the align property on the Markdown model instead. Alignment of markdown content. Only valid when markdown is set. Options are 'left', 'center', or 'right'.

Default: null
justify string | null

DEPRECATED: Use the justify property on the Markdown model instead. Justification of markdown content within its container. Options are 'start', 'end', 'center', 'between', 'around', or 'evenly'.

Default: null
chart string | string | Chart | null

A chart object defined inline or a ref() to a chart.

Default: null
table string | string | Table | null

A Table object defined inline or a ref() to a table

Default: null
selector string | string | Selector | null

A Selector object defined inline or a ref() to a selector

Default: null
input string | string | SingleSelectInput | MultiSelectInput | null

An Input object defined inline or a ref() to a input

Default: null
Layout object

A schema to validate plotly layout

activeselection object
2 nested properties
fillcolor query-string | color

Sets the color filling the active selection' interior.

opacity query-string | number

Sets the opacity of the active selection.

activeshape object
2 nested properties
fillcolor query-string | color

Sets the color filling the active shape' interior.

opacity query-string | number

Sets the opacity of the active shape.

annotations object[]
minItems=1
autosize query-string | boolean

Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

autotypenumbers query-string | enum

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. This is the default value; however it could be overridden for individual axes.

calendar query-string | enum

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

clickmode query-string | string | string

Determines the mode of single click interactions. event is the default value and emits the plotly_click event. In addition this mode emits the plotly_selected event in drag modes lasso and select, but with no event data attached (kept for compatibility reasons). The select flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. select with hovermode: x can be confusing, consider explicitly setting hovermode: closest when using this feature. Selection events are sent accordingly as long as event flag is set as well. When the event flag is missing, plotly_click and plotly_selected events are not fired.

coloraxis object
9 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, cmax must be set as well.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

colorscale object
3 nested properties
diverging query-string | colorscale

Sets the default diverging colorscale. Note that autocolorscale must be true for this attribute to work.

sequential query-string | colorscale

Sets the default sequential colorscale for positive values. Note that autocolorscale must be true for this attribute to work.

sequentialminus query-string | colorscale

Sets the default sequential colorscale for negative values. Note that autocolorscale must be true for this attribute to work.

colorway query-string | color[]

Sets the default trace colors.

computed

Placeholder for exporting automargin-impacting values namely margin.t, margin.b, margin.l and margin.r in full-json mode.

datarevision

If provided, a changed value tells Plotly.react that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, Plotly.react assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

dragmode query-string | enum

Determines the mode of drag interactions. select and lasso apply only to scatter traces with markers or text. orbit and turntable apply only to 3D scenes.

editrevision

Controls persistence of user-driven changes in editable: true configuration, other than trace names and axis titles. Defaults to layout.uirevision.

font object
9 nested properties
family 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.

Default: ""Open Sans", verdana, arial, sans-serif"
pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

geo object
32 nested properties
bgcolor query-string | color

Set the background color of the map

center object
2 nested properties
lat query-string | number

Sets the latitude of the map's center. For all projection types, the map's latitude center lies at the middle of the latitude range by default.

lon query-string | number

Sets the longitude of the map's center. By default, the map's longitude center lies at the middle of the longitude range for scoped projection and above projection.rotation.lon otherwise.

coastlinecolor query-string | color

Sets the coastline color.

coastlinewidth query-string | number

Sets the coastline stroke width (in px).

countrycolor query-string | color

Sets line color of the country boundaries.

countrywidth query-string | number

Sets line width (in px) of the country boundaries.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

x query-string | query-string | number[]

Sets the horizontal domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

y query-string | query-string | number[]

Sets the vertical domain of this geo subplot (in plot fraction). Note that geo subplots are constrained by domain. In general, when projection.scale is set to 1. a map will fit either its x or y domain, but not both.

fitbounds query-string | enum

Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting fitbounds leads to center.lon and center.lat getting auto-filled. On maps with a non-clipped projection, setting fitbounds leads to center.lon, center.lat, and projection.rotation.lon getting auto-filled. On maps with a clipped projection, setting fitbounds leads to center.lon, center.lat, projection.rotation.lon, projection.rotation.lat, lonaxis.range and lataxis.range getting auto-filled. If locations, only the trace's visible locations are considered in the fitbounds computations. If geojson, the entire trace input geojson (if provided) is considered in the fitbounds computations, Defaults to false.

framecolor query-string | color

Sets the color the frame.

framewidth query-string | number

Sets the stroke width (in px) of the frame.

lakecolor query-string | color

Sets the color of the lakes.

landcolor query-string | color

Sets the land mass color.

lataxis object
7 nested properties
dtick query-string | number

Sets the graticule's longitude/latitude tick step.

gridcolor query-string | color

Sets the graticule's stroke color.

griddash string

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

Default: "solid"
gridwidth query-string | number

Sets the graticule's stroke width (in px).

range query-string | query-string | number[]

Sets the range of this axis (in degrees), sets the map's clipped coordinates.

showgrid query-string | boolean

Sets whether or not graticule are shown on the map.

tick0 query-string | number

Sets the graticule's starting tick longitude/latitude.

lonaxis object
7 nested properties
dtick query-string | number

Sets the graticule's longitude/latitude tick step.

gridcolor query-string | color

Sets the graticule's stroke color.

griddash string

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

Default: "solid"
gridwidth query-string | number

Sets the graticule's stroke width (in px).

range query-string | query-string | number[]

Sets the range of this axis (in degrees), sets the map's clipped coordinates.

showgrid query-string | boolean

Sets whether or not graticule are shown on the map.

tick0 query-string | number

Sets the graticule's starting tick longitude/latitude.

oceancolor query-string | color

Sets the ocean color

projection object
6 nested properties
distance query-string | number

For satellite projection type only. Sets the distance from the center of the sphere to the point of view as a proportion of the sphere’s radius.

parallels query-string | query-string | number[]

For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere.

rotation object
scale query-string | number

Zooms in or out on the map view. A scale of 1 corresponds to the largest zoom level that fits the map's lon and lat ranges.

tilt query-string | number

For satellite projection type only. Sets the tilt angle of perspective projection.

type query-string | enum

Sets the projection type.

resolution query-string | enum

Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

rivercolor query-string | color

Sets color of the rivers.

riverwidth query-string | number

Sets the stroke width (in px) of the rivers.

scope query-string | enum

Set the scope of the map.

showcoastlines query-string | boolean

Sets whether or not the coastlines are drawn.

showcountries query-string | boolean

Sets whether or not country boundaries are drawn.

showframe query-string | boolean

Sets whether or not a frame is drawn around the map.

showlakes query-string | boolean

Sets whether or not lakes are drawn.

showland query-string | boolean

Sets whether or not land masses are filled in color.

showocean query-string | boolean

Sets whether or not oceans are filled in color.

showrivers query-string | boolean

Sets whether or not rivers are drawn.

showsubunits query-string | boolean

Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.

subunitcolor query-string | color

Sets the color of the subunits boundaries.

subunitwidth query-string | number

Sets the stroke width (in px) of the subunits boundaries.

uirevision

Controls persistence of user-driven changes in the view (projection and center). Defaults to layout.uirevision.

visible query-string | boolean

Sets the default visibility of the base layers.

grid object
12 nested properties
columns query-string | integer

The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

domain object
2 nested properties
x query-string | query-string | number[]

Sets the horizontal domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.

y query-string | query-string | number[]

Sets the vertical domain of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.

pattern query-string | enum

If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: coupled gives one x axis per column and one y axis per row. independent uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder.

roworder query-string | enum

Is the first row the top or the bottom? Note that columns are always enumerated from left to right.

rows query-string | integer

The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

subplots query-string | query-string | string | enum[]

Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like xy or x3y2, or ** to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute.

xaxes query-string | query-string | string | enum[]

Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like x, x2, etc., or ** to not put an x axis in that column. Entries other than ** must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs.

xgap query-string | number

Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.

xside query-string | enum

Sets where the x axis labels and titles go. bottom means the very bottom of the grid. bottom plot is the lowest plot that each x axis is used in. top and top plot are similar.

yaxes query-string | query-string | string | enum[]

Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like y, y2, etc., or ** to not put a y axis in that row. Entries other than ** must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs.

ygap query-string | number

Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.

yside query-string | enum

Sets where the y axis labels and titles go. left means the very left edge of the grid. left plot is the leftmost plot that each y axis is used in. right and right plot are similar.

height query-string | number

Sets the plot's height (in px).

hidesources query-string | boolean

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).

hoverdistance query-string | integer

Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.

hoverlabel object
6 nested properties
align query-string | enum

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

bgcolor query-string | color

Sets the background color of all hover labels on graph

bordercolor query-string | color

Sets the border color of all hover labels on graph.

font object
9 nested properties
family 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.

Default: "Arial, sans-serif"
pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

grouptitlefont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

namelength query-string | integer

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

hovermode query-string | enum

Determines the mode of hover interactions. If closest, a single hoverlabel will appear for the closest point within the hoverdistance. If x (or y), multiple hoverlabels will appear for multiple points at the closest x- (or y-) coordinate within the hoverdistance, with the caveat that no more than one hoverlabel will appear per trace. If x unified (or y unified), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the hoverdistance with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled.

hoversubplots query-string | enum

Determines expansion of hover effects to other subplots If single just the axis pair of the primary point is included without overlaying subplots. If overlaying all subplots using the main axis and occupying the same space are included. If axis, also include stacked subplots using the same axis when hovermode is set to x, x unified, y or y unified.

images object[]
minItems=1
legend object
27 nested properties
bgcolor query-string | color

Sets the legend background color. Defaults to layout.paper_bgcolor.

bordercolor query-string | color

Sets the color of the border enclosing the legend.

borderwidth query-string | number

Sets the width (in px) of the border enclosing the legend.

entrywidth query-string | number

Sets the width (in px or fraction) of the legend. Use 0 to size the entry based on the text width, when entrywidthmode is set to pixels.

entrywidthmode query-string | enum

Determines what entrywidth means.

font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

groupclick query-string | enum

Determines the behavior on legend group item click. toggleitem toggles the visibility of the individual item clicked on the graph. togglegroup toggles the visibility of all items in the same legendgroup as the item clicked on the graph.

grouptitlefont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

indentation query-string | number

Sets the indentation (in px) of the legend entries.

itemclick query-string | enum

Determines the behavior on legend item click. toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disables legend item click interactions.

itemdoubleclick query-string | enum

Determines the behavior on legend item double-click. toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disables legend item double-click interactions.

itemsizing query-string | enum

Determines if the legend items symbols scale with their corresponding trace attributes or remain constant independent of the symbol size on the graph.

itemwidth query-string | number

Sets the width (in px) of the legend item symbols (the part other than the title.text).

maxheight query-string | number

Sets the max height (in px) of the legend, or max height ratio (reference height * ratio) if less than one. Default value is: 0.5 for horizontal legends; 1 for vertical legends. The minimum allowed height is 30px. For a ratio of 0.5, the legend will take up to 50% of the reference height before displaying a scrollbar. The reference height is the full layout height except for vertically oriented legends with a yref of "paper", where the reference height is the plot height.

orientation query-string | enum

Sets the orientation of the legend.

title object
3 nested properties
font object
side query-string | enum

Determines the location of legend's title with respect to the legend items. Defaulted to top with orientation is h. Defaulted to left with orientation is v. The top left options could be used to expand top center and top right are for horizontal alignment legend area in both x and y sides.

text string

Sets the title of the legend.

Default: ""
tracegroupgap query-string | number

Sets the amount of vertical space (in px) between legend groups.

traceorder query-string | string | string

Determines the order at which the legend items are displayed. If normal, the items are displayed top-to-bottom in the same order as the input data. If reversed, the items are displayed in the opposite order as normal. If grouped, the items are displayed in groups (when a trace legendgroup is provided). if grouped+reversed, the items are displayed in the opposite order as grouped.

uirevision

Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to layout.uirevision.

valign query-string | enum

Sets the vertical alignment of the symbols with respect to their associated text.

visible query-string | boolean

Determines whether or not this legend is visible.

x query-string | number

Sets the x position with respect to xref (in normalized coordinates) of the legend. When xref is paper, defaults to 1.02 for vertical legends and defaults to 0 for horizontal legends. When xref is container, defaults to 1 for vertical legends and defaults to 0 for horizontal legends. Must be between 0 and 1 if xref is container. and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets the legend's horizontal position anchor. This anchor binds the x position to the left, center or right of the legend. Value auto anchors legends to the right for x values greater than or equal to 2/3, anchors legends to the left for x values less than or equal to 1/3 and anchors legends with respect to their center otherwise.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref (in normalized coordinates) of the legend. When yref is paper, defaults to 1 for vertical legends, defaults to -0.1 for horizontal legends on graphs w/o range sliders and defaults to 1.1 for horizontal legends on graph with one or multiple range sliders. When yref is container, defaults to 1. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets the legend's vertical position anchor This anchor binds the y position to the top, middle or bottom of the legend. Value auto anchors legends at their bottom for y values less than or equal to 1/3, anchors legends to at their top for y values greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

map object
9 nested properties
bearing query-string | number

Sets the bearing angle of the map in degrees counter-clockwise from North (map.bearing).

bounds object
4 nested properties
east query-string | number

Sets the maximum longitude of the map (in degrees East) if west, south and north are declared.

north query-string | number

Sets the maximum latitude of the map (in degrees North) if east, west and south are declared.

south query-string | number

Sets the minimum latitude of the map (in degrees North) if east, west and north are declared.

west query-string | number

Sets the minimum longitude of the map (in degrees East) if east, south and north are declared.

center object
2 nested properties
lat query-string | number

Sets the latitude of the center of the map (in degrees North).

lon query-string | number

Sets the longitude of the center of the map (in degrees East).

domain object
4 nested properties
column query-string | integer

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

row query-string | integer

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

x query-string | query-string | number[]

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

y query-string | query-string | number[]

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

layers object[]
minItems=1
pitch query-string | number

Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (map.pitch).

style

Defines the map layers that are rendered by default below the trace layers defined in data, which are themselves by default rendered below the layers defined in layout.map.layers. These layers can be defined either explicitly as a Map Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes or by using a custom style URL Map Style objects are of the form described in the MapLibre GL JS documentation available at https://maplibre.org/maplibre-style-spec/ The built-in plotly.js styles objects are: basic, carto-darkmatter, carto-darkmatter-nolabels, carto-positron, carto-positron-nolabels, carto-voyager, carto-voyager-nolabels, dark, light, open-street-map, outdoors, satellite, satellite-streets, streets, white-bg.

Default: "basic"
uirevision

Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch. Defaults to layout.uirevision.

zoom query-string | number

Sets the zoom level of the map (map.zoom).

mapbox object
10 nested properties
accesstoken string

Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under mapboxAccessToken. Note that accessToken are only required when style (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.

pattern=.*\S.*$
bearing query-string | number

Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).

bounds object
4 nested properties
east query-string | number

Sets the maximum longitude of the map (in degrees East) if west, south and north are declared.

north query-string | number

Sets the maximum latitude of the map (in degrees North) if east, west and south are declared.

south query-string | number

Sets the minimum latitude of the map (in degrees North) if east, west and north are declared.

west query-string | number

Sets the minimum longitude of the map (in degrees East) if east, south and north are declared.

center object
2 nested properties
lat query-string | number

Sets the latitude of the center of the map (in degrees North).

lon query-string | number

Sets the longitude of the center of the map (in degrees East).

domain object
4 nested properties
column query-string | integer

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

row query-string | integer

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

x query-string | query-string | number[]

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

y query-string | query-string | number[]

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

layers object[]
minItems=1
pitch query-string | number

Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).

style

Defines the map layers that are rendered by default below the trace layers defined in data, which are themselves by default rendered below the layers defined in layout.mapbox.layers. These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the accesstoken attribute or in the mapboxAccessToken config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox--

Default: "basic"
uirevision

Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch. Defaults to layout.uirevision.

zoom query-string | number

Sets the zoom level of the map (mapbox.zoom).

margin object
6 nested properties
autoexpand query-string | boolean

Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults.

b query-string | number

Sets the bottom margin (in px).

l query-string | number

Sets the left margin (in px).

pad query-string | number

Sets the amount of padding (in px) between the plotting area and the axis lines

r query-string | number

Sets the right margin (in px).

t query-string | number

Sets the top margin (in px).

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

minreducedheight query-string | number

Minimum height of the plot with margin.automargin applied (in px)

minreducedwidth query-string | number

Minimum width of the plot with margin.automargin applied (in px)

modebar object
9 nested properties
activecolor query-string | color

Sets the color of the active or hovered on icons in the modebar.

add string | string[]

Determines which predefined modebar buttons to add. Please note that these buttons will only be shown if they are compatible with all trace types used in a graph. Similar to config.modeBarButtonsToAdd option. This may include v1hovermode, hoverclosest, hovercompare, togglehover, togglespikelines, drawline, drawopenpath, drawclosedpath, drawcircle, drawrect, eraseshape.

addsrc string

Sets the source reference on Chart Studio Cloud for add.

bgcolor query-string | color

Sets the background color of the modebar.

Sets the color of the icons in the modebar.

orientation query-string | enum

Sets the orientation of the modebar.

remove string | string[]

Determines which predefined modebar buttons to remove. Similar to config.modeBarButtonsToRemove option. This may include autoScale2d, autoscale, editInChartStudio, editinchartstudio, hoverCompareCartesian, hovercompare, lasso, lasso2d, orbitRotation, orbitrotation, pan, pan2d, pan3d, reset, resetCameraDefault3d, resetCameraLastSave3d, resetGeo, resetSankeyGroup, resetScale2d, resetViewMap, resetViewMapbox, resetViews, resetcameradefault, resetcameralastsave, resetsankeygroup, resetscale, resetview, resetviews, select, select2d, sendDataToCloud, senddatatocloud, tableRotation, tablerotation, toImage, toggleHover, toggleSpikelines, togglehover, togglespikelines, toimage, zoom, zoom2d, zoom3d, zoomIn2d, zoomInGeo, zoomInMap, zoomInMapbox, zoomOut2d, zoomOutGeo, zoomOutMap, zoomOutMapbox, zoomin, zoomout.

removesrc string

Sets the source reference on Chart Studio Cloud for remove.

uirevision

Controls persistence of user-driven changes related to the modebar, including hovermode, dragmode, and showspikes at both the root level and inside subplots. Defaults to layout.uirevision.

newselection object
2 nested properties
line object
3 nested properties

Sets the line color. By default uses either dark grey or white to increase contrast with background color.

dash string

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

Default: "dot"
width query-string | number

Sets the line width (in px).

mode query-string | enum

Describes how a new selection is created. If immediate, a new selection is created after first mouse up. If gradual, a new selection is not created after first mouse. By adding to and subtracting from the initial selection, this option allows declaring extra outlines of the selection.

newshape object
15 nested properties
drawdirection query-string | enum

When dragmode is set to drawrect, drawline or drawcircle this limits the drag to be horizontal, vertical or diagonal. Using diagonal there is no limit e.g. in drawing lines in any direction. ortho limits the draw to be either horizontal or vertical. horizontal allows horizontal extend. vertical allows vertical extend.

fillcolor query-string | color

Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.

fillrule query-string | enum

Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule

label object
8 nested properties
font object
padding query-string | number

Sets padding (in px) between edge of label and edge of new shape.

text string

Sets the text to display with the new shape. It is also used for legend item if name is not provided.

Default: ""
textangle query-string | number

Sets the angle at which the label text is drawn with respect to the horizontal. For lines, angle auto is the same angle as the line. For all other shapes, angle auto is horizontal.

textposition query-string | enum

Sets the position of the label text relative to the new shape. Supported values for rectangles, circles and paths are top left, top center, top right, middle left, middle center, middle right, bottom left, bottom center, and bottom right. Supported values for lines are start, middle, and end. Default: middle center for rectangles, circles, and paths; middle for lines.

texttemplate string

Template string used for rendering the new shape's label. Note that this will override text. Variables are inserted using %{variable}, for example "x0: %{x0}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{x0:$.2f}". See https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{x0|%m %b %Y}". See https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. A single multiplication or division operation may be applied to numeric variables, and combined with d3 number formatting, for example "Length in cm: %{x02.54}", "%{slope60:.1f} meters per second." For log axes, variable values are given in log units. For date axes, x/y coordinate variables and center variables use datetimes, while all other variable values use values in ms. Finally, the template string has access to variables x0, x1, y0, y1, slope, dx, dy, width, height, length, xcenter and ycenter.

Default: ""
xanchor query-string | enum

Sets the label's horizontal position anchor This anchor binds the specified textposition to the left, center or right of the label text. For example, if textposition is set to top right and xanchor to right then the right-most portion of the label text lines up with the right-most edge of the new shape.

yanchor query-string | enum

Sets the label's vertical position anchor This anchor binds the specified textposition to the top, middle or bottom of the label text. For example, if textposition is set to top right and yanchor to top then the top-most portion of the label text lines up with the top-most edge of the new shape.

layer query-string | enum

Specifies whether new shapes are drawn below gridlines (below), between gridlines and traces (between) or above traces (above).

legend query-string | string

Sets the reference to a legend to show new shape in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for new shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for new shape. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for new shape.

line object
3 nested properties

Sets the line color. By default uses either dark grey or white to increase contrast with background color.

dash string

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

Default: "solid"
width query-string | number

Sets the line width (in px).

name string

Sets new shape name. The name appears as the legend item.

opacity query-string | number

Sets the opacity of new shapes.

showlegend query-string | boolean

Determines whether or not new shape is shown in the legend.

visible query-string | enum

Determines whether or not new shape is visible. If legendonly, the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

paper_bgcolor query-string | color

Sets the background color of the paper where the graph is drawn.

plot_bgcolor query-string | color

Sets the background color of the plotting area in-between x and y axes.

polar object
8 nested properties
angularaxis object
48 nested properties
autotypenumbers query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

Sets the direction corresponding to positive angles.

dtick

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

minexponent query-string | number

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

nticks query-string | integer

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 query-string | number

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

rotation query-string | number

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 query-string | boolean

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

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thetaunit query-string | enum

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

type query-string | enum

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

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

visible query-string | boolean

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 query-string | color

Set the background color of the subplot

domain object
4 nested properties
column query-string | integer

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

row query-string | integer

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

x query-string | query-string | number[]

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

y query-string | query-string | number[]

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

gridshape query-string | enum

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 query-string | number

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

radialaxis object
55 nested properties
angle query-string | number

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 query-string | enum

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 object
autotickangles query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

maxallowed

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

nticks query-string | integer

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 query-string | 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. Leaving either or both elements null impacts the default autorange.

rangemode query-string | enum

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 query-string | boolean

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

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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

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

visible query-string | boolean

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 query-string | query-string | number[]

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

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

scene object
12 nested properties
annotations object[]
minItems=1
aspectmode query-string | enum

If cube, this scene's axes are drawn as a cube, regardless of the axes' ranges. If data, this scene's axes are drawn in proportion with the axes' ranges. If manual, this scene's axes are drawn in proportion with the input of aspectratio (the default behavior if aspectratio is provided). If auto, this scene's axes are drawn using the results of data except when one axis is more than four times the size of the two others, where in that case the results of cube are used.

aspectratio object
4 nested properties
impliedEdits
x query-string | number
y query-string | number
z query-string | number
bgcolor query-string | color
camera object
4 nested properties
center object
eye object
projection object
up object
domain object
4 nested properties
column query-string | integer

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

row query-string | integer

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

x query-string | query-string | number[]

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

y query-string | query-string | number[]

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

dragmode query-string | enum

Determines the mode of drag interactions for this scene.

hovermode query-string | enum

Determines the mode of hover interactions for this scene.

uirevision

Controls persistence of user-driven changes in camera attributes. Defaults to layout.uirevision.

xaxis object
59 nested properties
autorange query-string | enum

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 object
autotypenumbers query-string | enum

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.

backgroundcolor query-string | color

Sets the background color of this axis' wall.

calendar query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
linecolor query-string | color

Sets the axis line color.

linewidth query-string | number

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

maxallowed

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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 query-string | 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. Leaving either or both elements null impacts the default autorange.

rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

separatethousands query-string | boolean

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

showaxeslabels query-string | boolean

Sets whether or not this axis is labeled

showbackground query-string | boolean

Sets whether or not this axis' wall has a background color.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

spikecolor query-string | color

Sets the color of the spikes.

spikesides query-string | boolean

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

spikethickness query-string | number

Sets the thickness (in px) of the spikes.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

yaxis object
59 nested properties
autorange query-string | enum

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 object
autotypenumbers query-string | enum

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.

backgroundcolor query-string | color

Sets the background color of this axis' wall.

calendar query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
linecolor query-string | color

Sets the axis line color.

linewidth query-string | number

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

maxallowed

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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 query-string | 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. Leaving either or both elements null impacts the default autorange.

rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

separatethousands query-string | boolean

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

showaxeslabels query-string | boolean

Sets whether or not this axis is labeled

showbackground query-string | boolean

Sets whether or not this axis' wall has a background color.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

spikecolor query-string | color

Sets the color of the spikes.

spikesides query-string | boolean

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

spikethickness query-string | number

Sets the thickness (in px) of the spikes.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

zaxis object
59 nested properties
autorange query-string | enum

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 object
autotypenumbers query-string | enum

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.

backgroundcolor query-string | color

Sets the background color of this axis' wall.

calendar query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
linecolor query-string | color

Sets the axis line color.

linewidth query-string | number

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

maxallowed

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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 query-string | 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. Leaving either or both elements null impacts the default autorange.

rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

separatethousands query-string | boolean

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

showaxeslabels query-string | boolean

Sets whether or not this axis is labeled

showbackground query-string | boolean

Sets whether or not this axis' wall has a background color.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

spikecolor query-string | color

Sets the color of the spikes.

spikesides query-string | boolean

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

spikethickness query-string | number

Sets the thickness (in px) of the spikes.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

selectdirection query-string | enum

When dragmode is set to select, this limits the selection of the drag to horizontal, vertical or diagonal. h only allows horizontal selection, v only vertical, d only diagonal and any sets no limit.

selectionrevision

Controls persistence of user-driven changes in selected points from all traces.

selections object[]
minItems=1
separators string

Sets the decimal and thousand separators. For example, *. * puts a '.' before decimals and a space between thousands. In English locales, dflt is ., but other locales may alter this default.

shapes object[]
minItems=1
showlegend query-string | boolean

Determines whether or not a legend is drawn. Default is true if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with showlegend: true.

sliders object[]
minItems=1
smith object
4 nested properties
bgcolor query-string | color

Set the background color of the subplot

domain object
4 nested properties
column query-string | integer

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

row query-string | integer

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

x query-string | query-string | number[]

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

y query-string | query-string | number[]

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

imaginaryaxis object
25 nested properties

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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

showgrid query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
ticklen query-string | number

Sets the tick length (in px).

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

visible query-string | boolean

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 object
27 nested properties

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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

showgrid query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

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

tickangle query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
ticklen query-string | number

Sets the tick length (in px).

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

visible query-string | boolean

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

spikedistance query-string | integer

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

template

Default attributes to be applied to the plot. Templates can be created from existing plots using Plotly.makeTemplate, or created manually. They should be objects with format: {layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...} layoutTemplate and traceTemplate are objects matching the attribute structure of layout and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false.

ternary object
7 nested properties
aaxis object
40 nested properties

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

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

min query-string | number

The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.

minexponent query-string | number

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

nticks query-string | integer

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.

separatethousands query-string | boolean

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

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
uirevision

Controls persistence of user-driven changes in axis min, and title if in editable: true configuration. Defaults to ternary<N>.uirevision.

baxis object
40 nested properties

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

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

min query-string | number

The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.

minexponent query-string | number

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

nticks query-string | integer

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.

separatethousands query-string | boolean

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

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
uirevision

Controls persistence of user-driven changes in axis min, and title if in editable: true configuration. Defaults to ternary<N>.uirevision.

bgcolor query-string | color

Set the background color of the subplot

caxis object
40 nested properties

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

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, 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 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 query-string | enum

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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
labelalias

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

min query-string | number

The minimum value visible on this axis. The maximum is determined by the sum minus the minimum values of the other two axes. The full view corresponds to all the minima set to zero.

minexponent query-string | number

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

nticks query-string | integer

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.

separatethousands query-string | boolean

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

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
uirevision

Controls persistence of user-driven changes in axis min, and title if in editable: true configuration. Defaults to ternary<N>.uirevision.

domain object
4 nested properties
column query-string | integer

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

row query-string | integer

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

x query-string | query-string | number[]

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

y query-string | query-string | number[]

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

sum query-string | number

The number each triplet should sum to, and the maximum range of each axis

uirevision

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

title object
11 nested properties
automargin query-string | 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 object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

pad object
4 nested properties
b query-string | number

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

l query-string | number

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

r query-string | number

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

t query-string | number

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

subtitle object
2 nested properties
font object
text string

Sets the plot's subtitle.

text string

Sets the plot's title.

x query-string | number

Sets the x position with respect to xref in normalized coordinates from 0 (left) to 1 (right).

xanchor query-string | enum

Sets the title's horizontal alignment with respect to its x position. left means that the title starts at x, right means that the title ends at x and center means that the title's center is at x. auto divides xref by three and calculates the xanchor value automatically based on the value of x.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref in normalized coordinates from 0 (bottom) to 1 (top). auto places the baseline of the title onto the vertical center of the top margin.

yanchor query-string | enum

Sets the title's vertical alignment with respect to its y position. top means that the title's cap line is at y, bottom means that the title's baseline is at y and middle means that the title's midline is at y. auto divides yref by three and calculates the yanchor value automatically based on the value of y.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

transition object
3 nested properties
duration query-string | number

The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.

easing query-string | enum

The easing function used for the transition

ordering query-string | enum

Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change.

uirevision

Used to allow user interactions with the plot to persist after Plotly.react calls that are unaware of these interactions. If uirevision is omitted, or if it is given and it changed from the previous Plotly.react call, the exact new figure is used. If uirevision is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. layout.uirevision attribute serves as the default for uirevision attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set xaxis.uirevision=*time* and yaxis.uirevision=*cost*. Then if only the y data is changed, you can update yaxis.uirevision=*quantity* and the y axis range will reset but the x axis range will retain any user-driven zoom.

uniformtext object
2 nested properties
minsize query-string | number

Sets the minimum text size between traces of the same type.

mode query-string | enum

Determines how the font size for various text elements are uniformed between each trace type. If the computed text sizes were smaller than the minimum size defined by uniformtext.minsize using hide option hides the text; and using show option shows the text without further downscaling. Please note that if the size defined by minsize is greater than the font size defined by trace, then the minsize is used.

updatemenus object[]
minItems=1
width query-string | number

Sets the plot's width (in px).

xaxis object
91 nested properties
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
6 nested properties
clipmax

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

clipmin

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

include array

Ensure this value is included in autorange.

includesrc string

Sets the source reference on Chart Studio Cloud for include.

maxallowed

Use this value exactly as autorange maximum.

minallowed

Use this value exactly as autorange minimum.

autotickangles query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

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

dividerwidth query-string | number

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

domain query-string | query-string | number[]

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

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

minor object
14 nested properties
dtick

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, 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 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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

nticks query-string | integer

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 query-string | boolean

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

tick0

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 (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 query-string | color

Sets the tick color.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

rangeselector object
11 nested properties
activecolor query-string | color

Sets the background color of the active range selector button.

bgcolor query-string | color

Sets the background color of the range selector buttons.

bordercolor query-string | color

Sets the color of the border enclosing the range selector.

borderwidth query-string | number

Sets the width (in px) of the border enclosing the range selector.

buttons object[]
minItems=1
font object
visible query-string | boolean

Determines whether or not this range selector is visible. Note that range selectors are only available for x axes of type set to or auto-typed to date.

x query-string | number

Sets the x position (in normalized coordinates) of the range selector.

xanchor query-string | enum

Sets the range selector's horizontal position anchor. This anchor binds the x position to the left, center or right of the range selector.

y query-string | number

Sets the y position (in normalized coordinates) of the range selector.

yanchor query-string | enum

Sets the range selector's vertical position anchor This anchor binds the y position to the top, middle or bottom of the range selector.

rangeslider object
8 nested properties
autorange query-string | boolean

Determines whether or not the range slider range is computed in relation to the input data. If range is provided, then autorange is set to false.

bgcolor query-string | color

Sets the background color of the range slider.

bordercolor query-string | color

Sets the border color of the range slider.

borderwidth query-string | integer

Sets the border width of the range slider.

range query-string | array

Sets the range of the range slider. If not set, defaults to the full xaxis range. If the axis type is log, then you must take the log of your desired range. 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.

thickness query-string | number

The height of the range slider as a fraction of the total plot area height.

visible query-string | boolean

Determines whether or not the range slider will be visible. If visible, perpendicular axes will be set to fixedrange

yaxis object
scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

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

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
standoff query-string | number

Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title font.size and the axis linewidth. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting standoff and turning on automargin, plotly.js will push the margins to fit the axis title at given standoff distance.

text string

Sets the title of this axis.

type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

yaxis object
91 nested properties
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
6 nested properties
clipmax

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

clipmin

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

include array

Ensure this value is included in autorange.

includesrc string

Sets the source reference on Chart Studio Cloud for include.

maxallowed

Use this value exactly as autorange maximum.

minallowed

Use this value exactly as autorange minimum.

autoshift query-string | 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 query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

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

dividerwidth query-string | number

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

domain query-string | query-string | number[]

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

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

minor object
14 nested properties
dtick

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, 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 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 query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

nticks query-string | integer

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 query-string | boolean

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

tick0

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 (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 query-string | color

Sets the tick color.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

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

shift query-string | number

Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If autoshift is set to true, then this defaults to a padding of -3 if side is set to left. and defaults to +3 if side is set to right. Defaults to 0 if autoshift is set to false. Only has an effect if anchor is set to free.

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
standoff query-string | number

Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title font.size and the axis linewidth. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting standoff and turning on automargin, plotly.js will push the margins to fit the axis title at given standoff distance.

text string

Sets the title of this axis.

type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

barcornerradius

Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).

bargap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

bargroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

barmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With stack, the bars are stacked on top of one another With relative, the bars are stacked on top of one another, with negative values below the axis, positive values above With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

barnorm query-string | enum

Sets the normalization for bar traces on the graph. With fraction, the value of each bar is divided by the sum of all values at that location coordinate. percent is the same but multiplied by 100 to show percentages.

boxgap query-string | number

Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have width set.

boxgroupgap query-string | number

Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have width set.

boxmode query-string | enum

Determines how boxes at the same location coordinate are displayed on the graph. If group, the boxes are plotted next to one another centered around the shared location. If overlay, the boxes are plotted over one another, you might need to set opacity to see them multiple boxes. Has no effect on traces that have width set.

funnelgap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

funnelgroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

funnelmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With stack, the bars are stacked on top of one another With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

extendfunnelareacolors query-string | boolean

If true, the funnelarea slice colors (whether given by funnelareacolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

funnelareacolorway query-string | color[]

Sets the default funnelarea slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendfunnelareacolors.

hiddenlabels query-string | number | string[]

hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts

hiddenlabelssrc string

Sets the source reference on Chart Studio Cloud for hiddenlabels.

extendiciclecolors query-string | boolean

If true, the icicle slice colors (whether given by iciclecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

iciclecolorway query-string | color[]

Sets the default icicle slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendiciclecolors.

extendpiecolors query-string | boolean

If true, the pie slice colors (whether given by piecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

piecolorway query-string | color[]

Sets the default pie slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendpiecolors.

scattergap query-string | number

Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to bargap.

scattermode query-string | enum

Determines how scatter points at the same location coordinate are displayed on the graph. With group, the scatter points are plotted next to one another centered around the shared location. With overlay, the scatter points are plotted over one another, you might need to reduce opacity to see multiple scatter points.

extendsunburstcolors query-string | boolean

If true, the sunburst slice colors (whether given by sunburstcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

sunburstcolorway query-string | color[]

Sets the default sunburst slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendsunburstcolors.

extendtreemapcolors query-string | boolean

If true, the treemap slice colors (whether given by treemapcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

treemapcolorway query-string | color[]

Sets the default treemap slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendtreemapcolors.

violingap query-string | number

Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have width set.

violingroupgap query-string | number

Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have width set.

violinmode query-string | enum

Determines how violins at the same location coordinate are displayed on the graph. If group, the violins are plotted next to one another centered around the shared location. If overlay, the violins are plotted over one another, you might need to set opacity to see them multiple violins. Has no effect on traces that have width set.

waterfallgap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

waterfallgroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

waterfallmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

Level object

Represents a dashboard level with title and description

title string required

Display title for this level

description string required

Description of this level's purpose

LocalMergeModel object

Local Merge Models are models that allow you to merge data from multiple other models locally.

!!! note

Any joining is done in a local DuckDB database. While more efficient than SQLite,
it's still primarily designed for medium-sized datasets.

!!! example {% raw %}

=== "Internal join External"

    Here is an example of merging two models that are defined in your project. One that is external and one that is internal.
    ``` yaml
    models:
      - name: local_merge
        models:
            - ref(first_domain_model)
            - ref(external_data_model)
        sql: SELECT * FROM first_domain_model.model AS fdm JOIN external_data_model.model AS edm ON fdm.external_id = edm.id
    ```

{% endraw %}

sql string required

The sql used to generate your base data

models string | string | Model[] required

A model object defined inline or a ref() to a model.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
Markdown object

The Markdown model represents formatted text content that can be displayed in dashboards.

Markdown supports CommonMark and GitHub Flavored Markdown. You can also render raw HTML within your markdown.

Example

markdowns:
  - name: welcome-text
    content: |
      # Welcome to Visivo

      This is **formatted** text with support for:
      - Lists
      - **Bold** and *italic* text
      - [Links](https://visivo.io)
    align: center
    justify: start

Then reference it in a dashboard item:

items:
  - width: 1
    markdown: ref(welcome-text)

Alignment Options

=== "Horizontal Alignment (align)" Controls how text aligns horizontally within the container:

`align: left` (default)
```
[Header     ]
[Paragraph  ]
[List       ]
```

`align: center`
```
[  Header   ]
[ Paragraph ]
[   List    ]
```

`align: right`
```
[     Header]
[  Paragraph]
[      List]
```

=== "Vertical Distribution (justify)" Controls how content blocks are distributed vertically in fixed-height containers:

`justify: start` (default)
```
[Header     ]
[Paragraph  ]
[List       ]
[           ]
[           ]
```

`justify: center`
```
[           ]
[Header     ]
[Paragraph  ]
[List       ]
[           ]
```

`justify: between`
```
[Header     ]
[           ]
[Paragraph  ]
[           ]
[List       ]
```

`justify: around`
```
[           ]
[Header     ]
[           ]
[Paragraph  ]
[           ]
[List       ]
[           ]
```

`justify: evenly`
```
[           ]
[Header     ]
[Paragraph  ]
[List       ]
[           ]
```

`justify: end`
```
[           ]
[           ]
[Header     ]
[Paragraph  ]
[List       ]
```
content string required

The markdown text content to display. Supports CommonMark and GitHub Flavored Markdown.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
align string

Horizontal alignment of the markdown content. Options are 'left', 'center', or 'right'.

Default: "left"
Values: "left" "center" "right"
justify string

Vertical distribution of content within its container. Options are 'start', 'end', 'center', 'between', 'around', or 'evenly'.

Default: "start"
Values: "start" "end" "center" "between" "around" "evenly"
Metric object

A Metric represents a reusable aggregate calculation that can be referenced across charts.

Metrics centralize business logic for key measurements, ensuring consistency and making updates easier. They can be defined at the model level (model-scoped) or at the project level (global metrics).

!!! example === "Model-scoped Metric" yaml models: - name: orders sql: SELECT * FROM orders_table metrics: - name: total_revenue expression: "SUM(amount)" description: "Total revenue from all orders"

=== "Global Metric (with multiple models)"
    ```yaml
    metrics:
      - name: revenue_per_user
        expression: "${ref(orders).total_revenue} / ${ref(users).total_users}"
        description: "Average revenue per user"
    ```
expression string required

SQL aggregate expression for the metric. For model-scoped metrics, use direct SQL aggregates (e.g., 'SUM(amount)', 'COUNT(DISTINCT id)'). For global metrics, can reference other metrics or fields using ${ref(model).field} or ${ref(metric_name)} syntax. Must be a valid aggregate function and cannot contain raw columns outside of aggregates.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
description string | null

Human-readable description of what this metric represents.

Default: null
Model object
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
MultiSelectDefault object

Default value configuration for multi-select inputs.

For list-based inputs: use 'values' field For range-based inputs: use 'start' and 'end' fields

values string | integer | number | boolean[] | string | string | null

Default selected values for list-based inputs. Can be static list, query, 'all' (default), or 'none'.

Default: null
start string | integer | number | boolean | null

Default lower bound for range-based inputs.

Default: null
end string | integer | number | boolean | null

Default upper bound for range-based inputs.

Default: null
MultiSelectDisplay object

Display configuration for multi-select inputs.

type string

UI component type for rendering the input.

Default: "dropdown"
Values: "dropdown" "checkboxes" "chips" "tags" "range-slider" "date-range"
default MultiSelectDefault | null

Default value configuration. If not specified, 'all' is used for list-based.

Default: null
MultiSelectInput object

Multi-select input for choosing multiple values.

Options can be defined in two ways (mutually exclusive):

  1. List-based ('options' field): Discrete choices from a static list or query
  2. Range-based ('range' field): Continuous/stepped values with start, end, step

Selected values are accessed using these accessors in filters:

  • .values - Array of all selected values
  • .min - Minimum of selected values
  • .max - Maximum of selected values
  • .first - First selected value
  • .last - Last selected value

Example YAML (list-based): inputs: - name: regions type: multi-select options: ['East', 'West', 'North', 'South'] display: type: dropdown default: values: ['East', 'West']

insights:
  - name: sales_by_region
    interactions:
      - filter: ?{ region IN (${ref(regions).values}) }

Example YAML (range-based): inputs: - name: price_range type: multi-select range: start: 0 end: 1000 step: 50 display: type: range-slider default: start: 100 end: 500

insights:
  - name: products_in_range
    interactions:
      - filter: ?{ price BETWEEN ${ref(price_range).min} AND ${ref(price_range).max} }
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
type string

Input type identifier.

Default: "multi-select"
Constant: "multi-select"
label string | null

Label shown to the user

Default: null
options string[] | string | null

Available options for list-based multi-select. Can be a static list or a query string. Mutually exclusive with 'range'.

Default: null
range RangeConfig | null

Range configuration for range-based multi-select. Defines start, end, and step values. Mutually exclusive with 'options'.

Default: null
display MultiSelectDisplay | null

Display configuration including UI component type and default values. If not specified, defaults to dropdown with all options selected.

Default: null
MysqlSource object

MysqlSources hold the connection information to MySQL data sources.

!!! example

=== "Simple"

    ``` yaml
        sources:
          - name: mysql_source
            type: mysql
            database: database
            username: {% raw %}{{ env_var('MYSQL_USER') }}{% endraw %}
            password: {% raw %}{{ env_var('MYSQL_PASSWORD') }}{% endraw %}
            connection_pool_size: 2
    ```

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "mysql"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
after_connect string | null
Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 1
OnFailureEnum string
PostgresqlSource object

PostgresqlSources hold the connection information to PostgreSQL data sources.

!!! example

=== "Simple"

    ``` yaml
        sources:
          - name: postgresql_source
            type: postgresql
            database: database
            username: {% raw %}{{ env_var('PG_USER') }}{% endraw %}
            password: {% raw %}{{ env_var('PG_PASSWORD') }}{% endraw %}
            connection_pool_size: 2
    ```

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "postgresql"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
after_connect string | null
Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 1
PropType string
RangeConfig object

Configuration for range-based multi-select inputs.

Range inputs generate stepped values between start and end bounds. Values are computed at frontend runtime, not during compile/run.

start string | integer | number | boolean required

Lower bound. Can be static value, query, or date expression.

end string | integer | number | boolean required

Upper bound. Can be static value, query, or date expression.

step string | integer | number | boolean required

Step increment. Required. Can be static value, query, or time unit string.

RedshiftSource object

RedshiftSources hold the connection information to Amazon Redshift data sources.

!!! example

=== "Basic Username/Password"

    ``` yaml
        sources:
          - name: redshift_source
            type: redshift
            database: dev
            host: my-cluster.abcdefghij.us-east-1.redshift.amazonaws.com
            port: 5439
            username: {% raw %}{{ env_var('REDSHIFT_USER') }}{% endraw %}
            password: {% raw %}{{ env_var('REDSHIFT_PASSWORD') }}{% endraw %}
            db_schema: public
    ```

=== "IAM Authentication"

    ``` yaml
        sources:
          - name: redshift_source
            type: redshift
            database: dev
            host: my-cluster.abcdefghij.us-east-1.redshift.amazonaws.com
            port: 5439
            username: {% raw %}{{ env_var('REDSHIFT_USER') }}{% endraw %}
            cluster_identifier: my-cluster
            region: us-east-1
            iam: true
            db_schema: public
    ```

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "redshift"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
cluster_identifier string | null

The cluster identifier for IAM authentication.

Default: null
region string | null

The AWS region where your Redshift cluster is located.

Default: null
iam boolean | null

Use IAM authentication instead of username/password.

Default: false
ssl boolean | null

Use SSL connection to Redshift.

Default: true
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 1
Relation object

A Relation defines how two models can be joined together.

Relations enable cross-model analysis by declaring the join conditions between models. This allows metrics to combine data from multiple models and enables the system to automatically generate the necessary SQL JOINs. The models involved in the relation are inferred from the condition.

!!! example yaml relations: - name: orders_to_users join_type: inner condition: "${ref(orders).user_id} = ${ref(users).id}" is_default: true

condition string required

SQL condition for joining the models. Use ${ref(model).field} syntax to reference fields. Example: '${ref(orders).user_id} = ${ref(users).id}'. Cannot join on metrics (aggregated values).

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
join_type string

Type of SQL join to use when connecting the models.

Default: "inner"
Values: "inner" "left" "right" "full"
is_default boolean | null

Whether this is the default relation to use when joining these two models. Useful when multiple relations exist between the same pair of models.

Default: false
Row object

Rows are the horizontal component of the dashboard grid and house 1 to many Items.

!!! tip You can set the height of a row using the height attribute on a row

??? information "Row Height Options in Pixels"

    | Height | Pixels |
    |------------|-------|
    | compact | wrapped |
    | xsmall | 128 |
    | small | 256 |
    | medium | 396 |
    | large | 512 |
    | xlarge | 768 |
    | xxlarge | 1024 |
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
height string
Values: "compact" "xsmall" "small" "medium" "large" "xlarge" "xxlarge"
items Item[]

A list of items containing tables, charts or markdown. Items are placed in the row in the order that they are listed from left to right.

Default: null
RowsPerPageEnum integer
Selector object

Selectors enable you to toggle between multiple different traces in your chart.

!!! tip Selectors can also be used to add interactivity between charts different tables. You can read more about using selectors to add interactivity here.

You can configure selectors to be single select or multi-select. Single select is great if you only want to show a single trace at a time on the chart while the multi-select can be really useful for providing filtering capabilities.

Example

Here's how you might use selectors to create interactivity between two different charts.

charts:
    - name: Chart One
      selector:
          name: Common Selector
          type: single
          ...
    - name: Chart Two
      selector: ref(Common Selector)
      ...
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
type string
Values: "single" "multiple"
options string | string[]

Optional set of traces, items, or rows to create the choices list

Default:
[]
SelectorType string
SingleSelectDefault object

Default value configuration for single-select inputs.

value string | integer | number | boolean required

Default selected value. Can be static value or query.

SingleSelectDisplay object

Display configuration for single-select inputs.

type string

UI component type for rendering the input.

Default: "dropdown"
Values: "dropdown" "radio" "toggle" "tabs" "autocomplete" "slider"
default SingleSelectDefault | null

Default value configuration. If not specified, first option is used.

Default: null
SingleSelectInput object

Single-select input for choosing one value from a set of options.

Options can be defined as a static list or a query that returns values. The selected value is accessed using the .value accessor in filters.

Example YAML: inputs: - name: region type: single-select options: ['East', 'West', 'North', 'South'] display: type: dropdown default: value: 'East'

insights:
  - name: sales_by_region
    interactions:
      - filter: ?{ region = ${ref(region).value} }
options string[] | string required

Available options. Can be a static list or a query string. Query must reference exactly one SqlModel using ${ref(model_name)}.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
type string

Input type identifier.

Default: "single-select"
Constant: "single-select"
label string | null

Label shown to the user

Default: null
display SingleSelectDisplay | null

Display configuration including UI component type and default value. If not specified, defaults to dropdown with first option selected.

Default: null
SlackDestination object

You can configure slack alerts by setting up an incoming message slack webhook. Once you do that, the set up in Visivo is super simple:

alerts:
  - name: slack-destination #any name you choose
    type: slack
    webhook_url: {% raw %}{{ env_var("SLACK_WEBHOOK")}}{% endraw %}
type string required

The type of Destination Destination. Needs to be slack to configure a slack destination

Constant: "slack"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
webhook_url string

An incoming message slack webhook url. You can set one of those up by following these instructions.

Default: null
SnowflakeSource object

SnowflakeSources hold the connection information to Snowflake data sources.

!!! example

=== "Simple"

    ``` yaml
        sources:
          - name: snowflake_source
            type: snowflake
            database: DEV
            warehouse: DEV
            account: ab12345.us-west-1.aws
            db_schema: DEFAULT
            username: {% raw %}{{ env_var('SNOWFLAKE_USER') }}{% endraw %}
            password: {% raw %}{{ env_var('SNOWFLAKE_PASSWORD') }}{% endraw %}
    ```

=== "Key Authentication"

    ``` yaml
        sources:
          - name: snowflake_source
            type: snowflake
            database: DEV
            warehouse: DEV
            account: ab12345.us-west-1.aws
            db_schema: DEFAULT
            username: {% raw %}"{{ env_var('SNOWFLAKE_USER') }}"{% endraw %}
            private_key_path: /path/to/rsa_key.p8
            private_key_passphrase: {% raw %}"{{ env_var('DB_PRIVATE_KEY_PASSPHRASE') }}"{% endraw %}
    ```

Note: Recommended environment variable use is covered in the sources overview.

database string required

The database that the Visivo project will use in queries.

type string required
Constant: "snowflake"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
after_connect string | null
Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
account string | null

The snowflake account url. Here's how you find this: snowflake docs.

Default: null
warehouse string | null

The compute warehouse that you want queries from your Visivo project to leverage.

Default: null
role string | null

The access role that you want to use when running queries.

Default: null
timezone string | null

The timezone that you want to use by default when running queries.

Default: null
private_key_path string | null

Path to the private key file (.p8) for key pair authentication. If provided, password will be ignored.

Default: null
private_key_passphrase string | string | null

Passphrase for the private key file if it is encrypted.

Default: null
connection_pool_size integer | null

The pool size that is used for this connection.

Default: 8
SqlModel object
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
sql string

The sql used to generate your base data

Default: null
source string | string | SqliteSource | PostgresqlSource | MysqlSource | SnowflakeSource | BigQuerySource | RedshiftSource | DuckdbSource | CSVFileSource | ExcelFileSource | ClickhouseSource | null

A source object defined inline or a ref() to a chart. Override the defaults.source_name

Default: null
metrics Metric[]

A list of model-scoped metrics that aggregate data from this model.

Default:
[]
dimensions Dimension[]

A list of computed dimensions (row-level calculations) for this model.

Default:
[]
SqliteSource object

SqliteSources hold the connection information to SQLite data sources.

!!! example {% raw %}

=== "Simple"

    ``` yaml
    sources:
      - name: sqlite_source
        database: local/file/local.db
        type: sqlite
    ```

=== "Additional Attached"
    Attaching other SQLite databases allows you to join models between databases.

    ``` yaml
    sources:
      - name: sqlite_source
        database: local/file/local.db
        type: sqlite
        attach:
          - schema_name: static
            name: static_source
            database: local/static/file/local.db
            type: sqlite
    ```

    The above source can be then used in a model and the sql for that model might look similar to: `SELECT * FROM local AS l JOIN static.data AS sd ON l.static_id=sd.id`

{% endraw %}

!!! note

Recommended environment variable use is covered in the [sources overview.](/topics/sources/)
database string required

The database that the Visivo project will use in queries.

type string required
Constant: "sqlite"
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
after_connect string | null
Default: null
host string | null

The host url of the database.

Default: null
port integer | null

The port of the database.

Default: null
username string | null

Username for the database.

Default: null
password string | string | null

Password corresponding to the username.

Default: null
db_schema string | null

The schema that the Visivo project will use in queries.

Default: null
attach Attachment[] | null

List of other local SQLite database sources to attach in the connection that will be available in the base SQL query.

Default: null
Table object

Tables enable you to quickly represent trace data in a tabular format.

Since tables sit on top of trace data, the steps to create a table from scratch are as follows:

  1. Create a model.
  2. Create a trace with columns or props that references your model.
  3. Create a table that references the trace. Within the table.columns block you will need to explicitly state the trace columns and header names that you want to include.

Example

models:
  - name: table-model
    sql: |
        select
            project_name,
            project_created_at,
            cli_version,
            stage_name,
            account_name,
            stage_archived
        FROM visivo_project
traces:
  - name: pre-table-trace
    model: ref(table-model)
    columns:
        project_name: project_name
        project_created_at: project_created_at::varchar
        cli_version: cli_version
        stage_name: stage_name
        account_name: account_name
        stage_archived: stage_archived::varchar
    props:
        type: scatter
        x: column(project_created_at)
        y: column(project_name)
tables:
  - name: latest-projects-table
    traces:
      - ref(pre-table-trace)
    column_defs:
      - trace_name: pre-table-trace
        columns:
        - header: "Project Name"
          key: columns.project_name
        - header: "Project Created At"
          key: columns.project_created_at
        - header: "Project Json"
          key: columns.project_json
        - header: "CLI Version"
          key: columns.cli_version
        - header: "Stage Name"
          key: columns.stage_name
          aggregation: uniqueCount
        - header: "Account Name"
          key: columns.account_name
        - header: "Account Name"
          key: columns.stage_archived

Tables are built on the material react table framework.

path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
selector string | string | Selector | null

The selector for the choosing which trace data is shown.

Default: null
traces string | string | Trace[]

A ref() to a trace or trace defined in line. Data for the table will come from the trace.

Default:
[]
insights string | string | Insight[]

A ref() to a insight or insight defined in line. Data for the table will come from the insight.

Default:
[]
column_defs TableColumnDefinition[] | null

A list of column definitions. These definitions define the columns for a given trace included in this table.

Default: null
rows_per_page integer
Values: 3 5 15 25 50 100 500 1000
TableColumn object
path string | null

A unique path to this object

Default: null
header string | null

The display name of the column. Defaults to readable key name.

Default: null
key string

The key to the data that will pull back the value.

Default: null
aggregation AggregationEnum | null

The aggregate function that will apply to the column when a user groups the table by a different column. Defaults to none.

Default: null
markdown boolean | null

If true, the column content will be rendered as markdown. Defaults to false.

Default: false
TableColumnDefinition object

Table columns allow you to display a subset of the available trace data.

columns TableColumn[] required

A list of column definitions that contain header and key. header is the title of the column in the table. key is the path to the array property you want to include. For example 'props.x' or 'columns.x_data'.

path string | null

A unique path to this object

Default: null
trace_name string

The name of the trace that the column defs apply to.

Default: null
insight_name string

The name of the insight that the column defs apply to.

Default: null
Test object
path string | null

A unique path to this object

Default: null
name string | null

The unique name of the object across the entire project.

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
if_ string | null
Default: null
on_failure string
Values: "exit" "continue"
assertions string[]
Default: null
Trace object

The Trace is one of the most important objects within a Visivo Project. You can think of a trace as a single series on a chart (ie. one line, a sequence of bars, a big number ect.). {% raw %} !!! example Total Revenue by Week would be a trace. Once you define this metric in a single trace in your project, you can add it to as many charts as you want. This is especially powerful since charts are able to join disparate axis automatically. Meaning you can define a trace for Revenue Per Week and then define another trace for Revenue per Day and include both of those traces on the same chart with no extra configuration needed.

This approach has a few key advantages:

  • Modularity: Traces can appear on multiple charts & tables.
  • Single Source of Truth: Traces are a single source of truth.
  • Testable: You can write general & fast tests to ensure that trace data is correct.

Cohorts

To easily cut a trace into multiple cohorts you can use the cohort_on attribute. !!! example To represent Revenue Per Week by Account Executive. You can use the cohort_on attribute to split out data into different series within a single trace. yaml traces: - name: rev-per-week-by-account-executive cohort_on: "account_executive_name" model: ref(orders) columns: week: date_trunc('week', "order_date") orders: count(*) props: type: bar x: column(week) y: column(orders)

Traces are also where you define how you want to represent your data visually. Since Visivo leverages plotly for charting, you can set up a number of unique and useful trace types that are also highly customizable. See types below.

Example

traces:
  - name: crypto ohlc
    model:
      sql: 'SELECT * finance_data_atlas.FINANCE.CMCCD2019'
    source_name: remote-snowflake
    cohort_on: ?{ "Cryptocurrency Name" }
    props:
      type: ohlc
      x: ?{ date_trunc('week', "Date")::date::varchar }
      close: ?{ max_by("Value", "Date") }
      high: ?{ max("Value") }
      low: ?{ min("Value") }
      open: ?{ min_by("Value", "Date") }
      increasing:
        line:
          color: 'green'
      decreasing:
        line:
          color: 'red'
      xaxis: 'x'
      yaxis: 'y'
    filters:
    - ?{"Date" >= '2015-01-01'}
    - ?{ "Cryptocurrency Name" in ('Bitcoin (btc)', 'Ethereum (eth)', 'Dogecoin (doge)') }
    - ?{ "Measure Name" = 'Price, USD' }

{% endraw %}

name string required

The unique name of the object across the entire project.

model string | string | SqlModel | CsvScriptModel | LocalMergeModel required

The model or model ref that Visivo should use to build the trace.

path string | null

A unique path to this object

Default: null
file_path string | null

The path to the file that contains the object definition.

Default: null
cohort_on string | null

cohort_on enables splitting the trace out into different series or cohorts. The column or query referenced here will be used to cut the resulting trace.

Default: null
order_by string[] | null

Takes a column() or ?{} reference. Orders the dataset so that information is presented in the correct order when the trace is added to a chart. Order by query statements support using asc and desc.

Default: null
filters string[] | null

A list of column() or ?{} functions that evaluate to true or false. Can include aggregations in the sql statement.

Default: null
tests Test[] | null

A list of tests to run against the trace data. Enables making assertions about the nullability of data and relationships between data.

Default: null
columns TraceColumns | null

Place where you can define named sql select statements. Once they are defined here they can be referenced in the trace props or in tables built on the trace.

Default: null
relations string | string | Relation[] | null

List of relations to use when joining models for metrics. Can be relation names using ref() syntax (e.g., 'ref(orders_to_users)'), context references (e.g., '${orders_to_users}'), or inline Relation objects with 'left_model', 'right_model', 'condition', etc. These define the preferred join paths when metrics from different models are used together.

Default: null
layout object

A schema to validate plotly layout

88 nested properties
activeselection object
2 nested properties
fillcolor query-string | color

Sets the color filling the active selection' interior.

opacity query-string | number

Sets the opacity of the active selection.

activeshape object
2 nested properties
fillcolor query-string | color

Sets the color filling the active shape' interior.

opacity query-string | number

Sets the opacity of the active shape.

annotations object[]
minItems=1
autosize query-string | boolean

Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.

autotypenumbers query-string | enum

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. This is the default value; however it could be overridden for individual axes.

calendar query-string | enum

Sets the default calendar system to use for interpreting and displaying dates throughout the plot.

clickmode query-string | string | string

Determines the mode of single click interactions. event is the default value and emits the plotly_click event. In addition this mode emits the plotly_selected event in drag modes lasso and select, but with no event data attached (kept for compatibility reasons). The select flag enables selecting single data points via click. This mode also supports persistent selections, meaning that pressing Shift while clicking, adds to / subtracts from an existing selection. select with hovermode: x can be confusing, consider explicitly setting hovermode: closest when using this feature. Selection events are sent accordingly as long as event flag is set as well. When the event flag is missing, plotly_click and plotly_selected events are not fired.

coloraxis object
9 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here corresponding trace color array(s)) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as corresponding trace color array(s). Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as corresponding trace color array(s) and if set, cmax must be set as well.

colorbar object
colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

colorscale object
3 nested properties
diverging query-string | colorscale

Sets the default diverging colorscale. Note that autocolorscale must be true for this attribute to work.

sequential query-string | colorscale

Sets the default sequential colorscale for positive values. Note that autocolorscale must be true for this attribute to work.

sequentialminus query-string | colorscale

Sets the default sequential colorscale for negative values. Note that autocolorscale must be true for this attribute to work.

colorway query-string | color[]

Sets the default trace colors.

computed

Placeholder for exporting automargin-impacting values namely margin.t, margin.b, margin.l and margin.r in full-json mode.

datarevision

If provided, a changed value tells Plotly.react that one or more data arrays has changed. This way you can modify arrays in-place rather than making a complete new copy for an incremental change. If NOT provided, Plotly.react assumes that data arrays are being treated as immutable, thus any data array with a different identity from its predecessor contains new data.

dragmode query-string | enum

Determines the mode of drag interactions. select and lasso apply only to scatter traces with markers or text. orbit and turntable apply only to 3D scenes.

editrevision

Controls persistence of user-driven changes in editable: true configuration, other than trace names and axis titles. Defaults to layout.uirevision.

font object
9 nested properties
family 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.

Default: ""Open Sans", verdana, arial, sans-serif"
pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

geo object
32 nested properties
bgcolor query-string | color

Set the background color of the map

center object
coastlinecolor query-string | color

Sets the coastline color.

coastlinewidth query-string | number

Sets the coastline stroke width (in px).

countrycolor query-string | color

Sets line color of the country boundaries.

countrywidth query-string | number

Sets line width (in px) of the country boundaries.

domain object
fitbounds query-string | enum

Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting fitbounds leads to center.lon and center.lat getting auto-filled. On maps with a non-clipped projection, setting fitbounds leads to center.lon, center.lat, and projection.rotation.lon getting auto-filled. On maps with a clipped projection, setting fitbounds leads to center.lon, center.lat, projection.rotation.lon, projection.rotation.lat, lonaxis.range and lataxis.range getting auto-filled. If locations, only the trace's visible locations are considered in the fitbounds computations. If geojson, the entire trace input geojson (if provided) is considered in the fitbounds computations, Defaults to false.

framecolor query-string | color

Sets the color the frame.

framewidth query-string | number

Sets the stroke width (in px) of the frame.

lakecolor query-string | color

Sets the color of the lakes.

landcolor query-string | color

Sets the land mass color.

lataxis object
lonaxis object
oceancolor query-string | color

Sets the ocean color

projection object
resolution query-string | enum

Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

rivercolor query-string | color

Sets color of the rivers.

riverwidth query-string | number

Sets the stroke width (in px) of the rivers.

scope query-string | enum

Set the scope of the map.

showcoastlines query-string | boolean

Sets whether or not the coastlines are drawn.

showcountries query-string | boolean

Sets whether or not country boundaries are drawn.

showframe query-string | boolean

Sets whether or not a frame is drawn around the map.

showlakes query-string | boolean

Sets whether or not lakes are drawn.

showland query-string | boolean

Sets whether or not land masses are filled in color.

showocean query-string | boolean

Sets whether or not oceans are filled in color.

showrivers query-string | boolean

Sets whether or not rivers are drawn.

showsubunits query-string | boolean

Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.

subunitcolor query-string | color

Sets the color of the subunits boundaries.

subunitwidth query-string | number

Sets the stroke width (in px) of the subunits boundaries.

uirevision

Controls persistence of user-driven changes in the view (projection and center). Defaults to layout.uirevision.

visible query-string | boolean

Sets the default visibility of the base layers.

grid object
12 nested properties
columns query-string | integer

The number of columns in the grid. If you provide a 2D subplots array, the length of its longest row is used as the default. If you give an xaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

domain object
pattern query-string | enum

If no subplots, xaxes, or yaxes are given but we do have rows and columns, we can generate defaults using consecutive axis IDs, in two ways: coupled gives one x axis per column and one y axis per row. independent uses a new xy pair for each cell, left-to-right across each row then iterating rows according to roworder.

roworder query-string | enum

Is the first row the top or the bottom? Note that columns are always enumerated from left to right.

rows query-string | integer

The number of rows in the grid. If you provide a 2D subplots array or a yaxes array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.

subplots query-string | query-string | string | enum[]

Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like xy or x3y2, or ** to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support domain can place themselves in this grid separately using the gridcell attribute.

xaxes query-string | query-string | string | enum[]

Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an x axis id like x, x2, etc., or ** to not put an x axis in that column. Entries other than ** must be unique. Ignored if subplots is present. If missing but yaxes is present, will generate consecutive IDs.

xgap query-string | number

Horizontal space between grid cells, expressed as a fraction of the total width available to one cell. Defaults to 0.1 for coupled-axes grids and 0.2 for independent grids.

xside query-string | enum

Sets where the x axis labels and titles go. bottom means the very bottom of the grid. bottom plot is the lowest plot that each x axis is used in. top and top plot are similar.

yaxes query-string | query-string | string | enum[]

Used with yaxes when the x and y axes are shared across columns and rows. Each entry should be an y axis id like y, y2, etc., or ** to not put a y axis in that row. Entries other than ** must be unique. Ignored if subplots is present. If missing but xaxes is present, will generate consecutive IDs.

ygap query-string | number

Vertical space between grid cells, expressed as a fraction of the total height available to one cell. Defaults to 0.1 for coupled-axes grids and 0.3 for independent grids.

yside query-string | enum

Sets where the y axis labels and titles go. left means the very left edge of the grid. left plot is the leftmost plot that each y axis is used in. right and right plot are similar.

height query-string | number

Sets the plot's height (in px).

hidesources query-string | boolean

Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).

hoverdistance query-string | integer

Sets the default distance (in pixels) to look for data to add hover labels (-1 means no cutoff, 0 means no looking for data). This is only a real distance for hovering on point-like objects, like scatter points. For area-like objects (bars, scatter fills, etc) hovering is on inside the area and off outside, but these objects will not supersede hover on point-like objects in case of conflict.

hoverlabel object
6 nested properties
align query-string | enum

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

bgcolor query-string | color

Sets the background color of all hover labels on graph

bordercolor query-string | color

Sets the border color of all hover labels on graph.

font object
grouptitlefont object
namelength query-string | integer

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

hovermode query-string | enum

Determines the mode of hover interactions. If closest, a single hoverlabel will appear for the closest point within the hoverdistance. If x (or y), multiple hoverlabels will appear for multiple points at the closest x- (or y-) coordinate within the hoverdistance, with the caveat that no more than one hoverlabel will appear per trace. If x unified (or y unified), a single hoverlabel will appear multiple points at the closest x- (or y-) coordinate within the hoverdistance with the caveat that no more than one hoverlabel will appear per trace. In this mode, spikelines are enabled by default perpendicular to the specified axis. If false, hover interactions are disabled.

hoversubplots query-string | enum

Determines expansion of hover effects to other subplots If single just the axis pair of the primary point is included without overlaying subplots. If overlaying all subplots using the main axis and occupying the same space are included. If axis, also include stacked subplots using the same axis when hovermode is set to x, x unified, y or y unified.

images object[]
minItems=1
legend object
27 nested properties
bgcolor query-string | color

Sets the legend background color. Defaults to layout.paper_bgcolor.

bordercolor query-string | color

Sets the color of the border enclosing the legend.

borderwidth query-string | number

Sets the width (in px) of the border enclosing the legend.

entrywidth query-string | number

Sets the width (in px or fraction) of the legend. Use 0 to size the entry based on the text width, when entrywidthmode is set to pixels.

entrywidthmode query-string | enum

Determines what entrywidth means.

font object
groupclick query-string | enum

Determines the behavior on legend group item click. toggleitem toggles the visibility of the individual item clicked on the graph. togglegroup toggles the visibility of all items in the same legendgroup as the item clicked on the graph.

grouptitlefont object
indentation query-string | number

Sets the indentation (in px) of the legend entries.

itemclick query-string | enum

Determines the behavior on legend item click. toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disables legend item click interactions.

itemdoubleclick query-string | enum

Determines the behavior on legend item double-click. toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disables legend item double-click interactions.

itemsizing query-string | enum

Determines if the legend items symbols scale with their corresponding trace attributes or remain constant independent of the symbol size on the graph.

itemwidth query-string | number

Sets the width (in px) of the legend item symbols (the part other than the title.text).

maxheight query-string | number

Sets the max height (in px) of the legend, or max height ratio (reference height * ratio) if less than one. Default value is: 0.5 for horizontal legends; 1 for vertical legends. The minimum allowed height is 30px. For a ratio of 0.5, the legend will take up to 50% of the reference height before displaying a scrollbar. The reference height is the full layout height except for vertically oriented legends with a yref of "paper", where the reference height is the plot height.

orientation query-string | enum

Sets the orientation of the legend.

title object
tracegroupgap query-string | number

Sets the amount of vertical space (in px) between legend groups.

traceorder query-string | string | string

Determines the order at which the legend items are displayed. If normal, the items are displayed top-to-bottom in the same order as the input data. If reversed, the items are displayed in the opposite order as normal. If grouped, the items are displayed in groups (when a trace legendgroup is provided). if grouped+reversed, the items are displayed in the opposite order as grouped.

uirevision

Controls persistence of legend-driven changes in trace and pie label visibility. Defaults to layout.uirevision.

valign query-string | enum

Sets the vertical alignment of the symbols with respect to their associated text.

visible query-string | boolean

Determines whether or not this legend is visible.

x query-string | number

Sets the x position with respect to xref (in normalized coordinates) of the legend. When xref is paper, defaults to 1.02 for vertical legends and defaults to 0 for horizontal legends. When xref is container, defaults to 1 for vertical legends and defaults to 0 for horizontal legends. Must be between 0 and 1 if xref is container. and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets the legend's horizontal position anchor. This anchor binds the x position to the left, center or right of the legend. Value auto anchors legends to the right for x values greater than or equal to 2/3, anchors legends to the left for x values less than or equal to 1/3 and anchors legends with respect to their center otherwise.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref (in normalized coordinates) of the legend. When yref is paper, defaults to 1 for vertical legends, defaults to -0.1 for horizontal legends on graphs w/o range sliders and defaults to 1.1 for horizontal legends on graph with one or multiple range sliders. When yref is container, defaults to 1. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets the legend's vertical position anchor This anchor binds the y position to the top, middle or bottom of the legend. Value auto anchors legends at their bottom for y values less than or equal to 1/3, anchors legends to at their top for y values greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

map object
9 nested properties
bearing query-string | number

Sets the bearing angle of the map in degrees counter-clockwise from North (map.bearing).

bounds object
center object
domain object
layers object[]
minItems=1
pitch query-string | number

Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (map.pitch).

style

Defines the map layers that are rendered by default below the trace layers defined in data, which are themselves by default rendered below the layers defined in layout.map.layers. These layers can be defined either explicitly as a Map Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes or by using a custom style URL Map Style objects are of the form described in the MapLibre GL JS documentation available at https://maplibre.org/maplibre-style-spec/ The built-in plotly.js styles objects are: basic, carto-darkmatter, carto-darkmatter-nolabels, carto-positron, carto-positron-nolabels, carto-voyager, carto-voyager-nolabels, dark, light, open-street-map, outdoors, satellite, satellite-streets, streets, white-bg.

Default: "basic"
uirevision

Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch. Defaults to layout.uirevision.

zoom query-string | number

Sets the zoom level of the map (map.zoom).

mapbox object
10 nested properties
accesstoken string

Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under mapboxAccessToken. Note that accessToken are only required when style (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.

pattern=.*\S.*$
bearing query-string | number

Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).

bounds object
center object
domain object
layers object[]
minItems=1
pitch query-string | number

Sets the pitch angle of the map (in degrees, where 0 means perpendicular to the surface of the map) (mapbox.pitch).

style

Defines the map layers that are rendered by default below the trace layers defined in data, which are themselves by default rendered below the layers defined in layout.mapbox.layers. These layers can be defined either explicitly as a Mapbox Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the accesstoken attribute or in the mapboxAccessToken config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox--

Default: "basic"
uirevision

Controls persistence of user-driven changes in the view: center, zoom, bearing, pitch. Defaults to layout.uirevision.

zoom query-string | number

Sets the zoom level of the map (mapbox.zoom).

margin object
6 nested properties
autoexpand query-string | boolean

Turns on/off margin expansion computations. Legends, colorbars, updatemenus, sliders, axis rangeselector and rangeslider are allowed to push the margins by defaults.

b query-string | number

Sets the bottom margin (in px).

l query-string | number

Sets the left margin (in px).

pad query-string | number

Sets the amount of padding (in px) between the plotting area and the axis lines

r query-string | number

Sets the right margin (in px).

t query-string | number

Sets the top margin (in px).

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

minreducedheight query-string | number

Minimum height of the plot with margin.automargin applied (in px)

minreducedwidth query-string | number

Minimum width of the plot with margin.automargin applied (in px)

modebar object
9 nested properties
activecolor query-string | color

Sets the color of the active or hovered on icons in the modebar.

add string | string[]

Determines which predefined modebar buttons to add. Please note that these buttons will only be shown if they are compatible with all trace types used in a graph. Similar to config.modeBarButtonsToAdd option. This may include v1hovermode, hoverclosest, hovercompare, togglehover, togglespikelines, drawline, drawopenpath, drawclosedpath, drawcircle, drawrect, eraseshape.

addsrc string

Sets the source reference on Chart Studio Cloud for add.

bgcolor query-string | color

Sets the background color of the modebar.

Sets the color of the icons in the modebar.

orientation query-string | enum

Sets the orientation of the modebar.

remove string | string[]

Determines which predefined modebar buttons to remove. Similar to config.modeBarButtonsToRemove option. This may include autoScale2d, autoscale, editInChartStudio, editinchartstudio, hoverCompareCartesian, hovercompare, lasso, lasso2d, orbitRotation, orbitrotation, pan, pan2d, pan3d, reset, resetCameraDefault3d, resetCameraLastSave3d, resetGeo, resetSankeyGroup, resetScale2d, resetViewMap, resetViewMapbox, resetViews, resetcameradefault, resetcameralastsave, resetsankeygroup, resetscale, resetview, resetviews, select, select2d, sendDataToCloud, senddatatocloud, tableRotation, tablerotation, toImage, toggleHover, toggleSpikelines, togglehover, togglespikelines, toimage, zoom, zoom2d, zoom3d, zoomIn2d, zoomInGeo, zoomInMap, zoomInMapbox, zoomOut2d, zoomOutGeo, zoomOutMap, zoomOutMapbox, zoomin, zoomout.

removesrc string

Sets the source reference on Chart Studio Cloud for remove.

uirevision

Controls persistence of user-driven changes related to the modebar, including hovermode, dragmode, and showspikes at both the root level and inside subplots. Defaults to layout.uirevision.

newselection object
2 nested properties
line object
mode query-string | enum

Describes how a new selection is created. If immediate, a new selection is created after first mouse up. If gradual, a new selection is not created after first mouse. By adding to and subtracting from the initial selection, this option allows declaring extra outlines of the selection.

newshape object
15 nested properties
drawdirection query-string | enum

When dragmode is set to drawrect, drawline or drawcircle this limits the drag to be horizontal, vertical or diagonal. Using diagonal there is no limit e.g. in drawing lines in any direction. ortho limits the draw to be either horizontal or vertical. horizontal allows horizontal extend. vertical allows vertical extend.

fillcolor query-string | color

Sets the color filling new shapes' interior. Please note that if using a fillcolor with alpha greater than half, drag inside the active shape starts moving the shape underneath, otherwise a new shape could be started over.

fillrule query-string | enum

Determines the path's interior. For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule

label object
layer query-string | enum

Specifies whether new shapes are drawn below gridlines (below), between gridlines and traces (between) or above traces (above).

legend query-string | string

Sets the reference to a legend to show new shape in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for new shape. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
legendrank query-string | number

Sets the legend rank for new shape. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for new shape.

line object
name string

Sets new shape name. The name appears as the legend item.

opacity query-string | number

Sets the opacity of new shapes.

showlegend query-string | boolean

Determines whether or not new shape is shown in the legend.

visible query-string | enum

Determines whether or not new shape is visible. If legendonly, the shape is not drawn, but can appear as a legend item (provided that the legend itself is visible).

paper_bgcolor query-string | color

Sets the background color of the paper where the graph is drawn.

plot_bgcolor query-string | color

Sets the background color of the plotting area in-between x and y axes.

polar object
8 nested properties
angularaxis object
bgcolor query-string | color

Set the background color of the subplot

domain object
gridshape query-string | enum

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 query-string | number

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

radialaxis object
sector query-string | query-string | number[]

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

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

scene object
12 nested properties
annotations object[]
minItems=1
aspectmode query-string | enum

If cube, this scene's axes are drawn as a cube, regardless of the axes' ranges. If data, this scene's axes are drawn in proportion with the axes' ranges. If manual, this scene's axes are drawn in proportion with the input of aspectratio (the default behavior if aspectratio is provided). If auto, this scene's axes are drawn using the results of data except when one axis is more than four times the size of the two others, where in that case the results of cube are used.

aspectratio object
bgcolor query-string | color
camera object
domain object
dragmode query-string | enum

Determines the mode of drag interactions for this scene.

hovermode query-string | enum

Determines the mode of hover interactions for this scene.

uirevision

Controls persistence of user-driven changes in camera attributes. Defaults to layout.uirevision.

xaxis object
yaxis object
zaxis object
selectdirection query-string | enum

When dragmode is set to select, this limits the selection of the drag to horizontal, vertical or diagonal. h only allows horizontal selection, v only vertical, d only diagonal and any sets no limit.

selectionrevision

Controls persistence of user-driven changes in selected points from all traces.

selections object[]
minItems=1
separators string

Sets the decimal and thousand separators. For example, *. * puts a '.' before decimals and a space between thousands. In English locales, dflt is ., but other locales may alter this default.

shapes object[]
minItems=1
showlegend query-string | boolean

Determines whether or not a legend is drawn. Default is true if there is a trace to show and any of these: a) Two or more traces would by default be shown in the legend. b) One pie trace is shown in the legend. c) One trace is explicitly given with showlegend: true.

sliders object[]
minItems=1
smith object
4 nested properties
bgcolor query-string | color

Set the background color of the subplot

domain object
imaginaryaxis object
realaxis object
spikedistance query-string | integer

Sets the default distance (in pixels) to look for data to draw spikelines to (-1 means no cutoff, 0 means no looking for data). As with hoverdistance, distance does not apply to area-like objects. In addition, some objects can be hovered on but will not generate spikelines, such as scatter fills.

template

Default attributes to be applied to the plot. Templates can be created from existing plots using Plotly.makeTemplate, or created manually. They should be objects with format: {layout: layoutTemplate, data: {[type]: [traceTemplate, ...]}, ...} layoutTemplate and traceTemplate are objects matching the attribute structure of layout and a data trace. Trace templates are applied cyclically to traces of each type. Container arrays (eg annotations) have special handling: An object ending in defaults (eg annotationdefaults) is applied to each array item. But if an item has a templateitemname key we look in the template array for an item with matching name and apply that instead. If no matching name is found we mark the item invisible. Any named template item not referenced is appended to the end of the array, so you can use this for a watermark annotation or a logo image, for example. To omit one of these items on the plot, make an item with matching templateitemname and visible: false.

ternary object
7 nested properties
aaxis object
baxis object
bgcolor query-string | color

Set the background color of the subplot

caxis object
domain object
sum query-string | number

The number each triplet should sum to, and the maximum range of each axis

uirevision

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

title object
11 nested properties
automargin query-string | 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 object
pad object
subtitle object
text string

Sets the plot's title.

x query-string | number

Sets the x position with respect to xref in normalized coordinates from 0 (left) to 1 (right).

xanchor query-string | enum

Sets the title's horizontal alignment with respect to its x position. left means that the title starts at x, right means that the title ends at x and center means that the title's center is at x. auto divides xref by three and calculates the xanchor value automatically based on the value of x.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref in normalized coordinates from 0 (bottom) to 1 (top). auto places the baseline of the title onto the vertical center of the top margin.

yanchor query-string | enum

Sets the title's vertical alignment with respect to its y position. top means that the title's cap line is at y, bottom means that the title's baseline is at y and middle means that the title's midline is at y. auto divides yref by three and calculates the yanchor value automatically based on the value of y.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

transition object
3 nested properties
duration query-string | number

The duration of the transition, in milliseconds. If equal to zero, updates are synchronous.

easing query-string | enum

The easing function used for the transition

ordering query-string | enum

Determines whether the figure's layout or traces smoothly transitions during updates that make both traces and layout change.

uirevision

Used to allow user interactions with the plot to persist after Plotly.react calls that are unaware of these interactions. If uirevision is omitted, or if it is given and it changed from the previous Plotly.react call, the exact new figure is used. If uirevision is truthy and did NOT change, any attribute that has been affected by user interactions and did not receive a different value in the new figure will keep the interaction value. layout.uirevision attribute serves as the default for uirevision attributes in various sub-containers. For finer control you can set these sub-attributes directly. For example, if your app separately controls the data on the x and y axes you might set xaxis.uirevision=*time* and yaxis.uirevision=*cost*. Then if only the y data is changed, you can update yaxis.uirevision=*quantity* and the y axis range will reset but the x axis range will retain any user-driven zoom.

uniformtext object
2 nested properties
minsize query-string | number

Sets the minimum text size between traces of the same type.

mode query-string | enum

Determines how the font size for various text elements are uniformed between each trace type. If the computed text sizes were smaller than the minimum size defined by uniformtext.minsize using hide option hides the text; and using show option shows the text without further downscaling. Please note that if the size defined by minsize is greater than the font size defined by trace, then the minsize is used.

updatemenus object[]
minItems=1
width query-string | number

Sets the plot's width (in px).

xaxis object
91 nested properties
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
autotickangles query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

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

dividerwidth query-string | number

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

domain query-string | query-string | number[]

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

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

minor object
mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

rangeselector object
rangeslider object
scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

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

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

yaxis object
91 nested properties
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
autoshift query-string | 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 query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

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

dividerwidth query-string | number

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

domain query-string | query-string | number[]

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

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

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

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

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

minor object
mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

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

shift query-string | number

Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If autoshift is set to true, then this defaults to a padding of -3 if side is set to left. and defaults to +3 if side is set to right. Defaults to 0 if autoshift is set to false. Only has an effect if anchor is set to free.

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

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

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

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

barcornerradius

Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).

bargap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

bargroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

barmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With stack, the bars are stacked on top of one another With relative, the bars are stacked on top of one another, with negative values below the axis, positive values above With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

barnorm query-string | enum

Sets the normalization for bar traces on the graph. With fraction, the value of each bar is divided by the sum of all values at that location coordinate. percent is the same but multiplied by 100 to show percentages.

boxgap query-string | number

Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have width set.

boxgroupgap query-string | number

Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have width set.

boxmode query-string | enum

Determines how boxes at the same location coordinate are displayed on the graph. If group, the boxes are plotted next to one another centered around the shared location. If overlay, the boxes are plotted over one another, you might need to set opacity to see them multiple boxes. Has no effect on traces that have width set.

funnelgap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

funnelgroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

funnelmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With stack, the bars are stacked on top of one another With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

extendfunnelareacolors query-string | boolean

If true, the funnelarea slice colors (whether given by funnelareacolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

funnelareacolorway query-string | color[]

Sets the default funnelarea slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendfunnelareacolors.

hiddenlabels query-string | number | string[]

hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts

hiddenlabelssrc string

Sets the source reference on Chart Studio Cloud for hiddenlabels.

extendiciclecolors query-string | boolean

If true, the icicle slice colors (whether given by iciclecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

iciclecolorway query-string | color[]

Sets the default icicle slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendiciclecolors.

extendpiecolors query-string | boolean

If true, the pie slice colors (whether given by piecolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

piecolorway query-string | color[]

Sets the default pie slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendpiecolors.

scattergap query-string | number

Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to bargap.

scattermode query-string | enum

Determines how scatter points at the same location coordinate are displayed on the graph. With group, the scatter points are plotted next to one another centered around the shared location. With overlay, the scatter points are plotted over one another, you might need to reduce opacity to see multiple scatter points.

extendsunburstcolors query-string | boolean

If true, the sunburst slice colors (whether given by sunburstcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

sunburstcolorway query-string | color[]

Sets the default sunburst slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendsunburstcolors.

extendtreemapcolors query-string | boolean

If true, the treemap slice colors (whether given by treemapcolorway or inherited from colorway) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set false to disable. Colors provided in the trace, using marker.colors, are never extended.

treemapcolorway query-string | color[]

Sets the default treemap slice colors. Defaults to the main colorway used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see extendtreemapcolors.

violingap query-string | number

Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have width set.

violingroupgap query-string | number

Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have width set.

violinmode query-string | enum

Determines how violins at the same location coordinate are displayed on the graph. If group, the violins are plotted next to one another centered around the shared location. If overlay, the violins are plotted over one another, you might need to set opacity to see them multiple violins. Has no effect on traces that have width set.

waterfallgap query-string | number

Sets the gap (in plot fraction) between bars of adjacent location coordinates.

waterfallgroupgap query-string | number

Sets the gap (in plot fraction) between bars of the same location coordinate.

waterfallmode query-string | enum

Determines how bars at the same location coordinate are displayed on the graph. With group, the bars are plotted next to one another centered around the shared location. With overlay, the bars are plotted over one another, you might need to reduce opacity to see multiple bars.

TraceColumns object

Trace Columns enable you to reuse query elements as columns throughout multiple different areas within the trace. !!! tip

Using Trace Columns can help reduce copy and paste code!

Trace Columns perform the same basic service that the ?{} function does- allowing you to define sql select statements.

!!! example {% raw %}

=== "With Inline `?{}` Function"

    ``` yaml
    - name: Simple Line
      model: ref(test-table)
      props:
        type: bar
        x: ?{ x }
        y: ?{ y }
        marker:
          color: ?{ case when x >= 5 then '#713B57' else 'grey' end }
          line:
            color: ?{ case when x >= 5 then '#713B57' else 'grey' end }
        pattern:
          shape: ?{ case when x = 5 then '/' when x = 6 THEN 'x' else '' end }
        line:
          width: ?{ case when x in (5,6) then 2.5 else null end }
    ```

=== "With Trace Columns"

    ``` yaml
    - name: Simple Line
      model: ref(test-table)
      columns:
        x_data: ?{ x }
        y_data: ?{ y }
        color: ?{ case when x >= 5 then '#713B57' else 'grey' end }
        shape: ?{ case when x = 5 then '/' when x = 6 THEN 'x' else '' end }
        width: ?{ case when x in (5,6) then 2.5 else null end }
      props:
        type: bar
        x: ${ columns.x_data }
        y: ${ columns.y_data }
        marker:
          color: ${ columns.color }
          line:
            color: ${ columns.color }
        pattern:
          shape: ${ columns.shape }
        line:
          width: ${ columns.width }
    ```

{% endraw %}

Slicing & Indexing Column Arrays

Trace Columns support slicing and indexing, enabling you to pull out sub-arrays or specific values from a given column array.

Indexing

Some trace configurations require numbers or strings as inputs. For example indicator traces require a single number to represent as the big value in the card. Since the ?{} and column() functions always return arrays, indexing allows you to grab a single value from the array to use in configurations that require a single value.

You can index columns by using the following syntax:

column(column_name)[index]

The index is a zero-based index that represents the position in the array you want to pull out. Negative indexes are also supported, allowing you to count from the end of the array. The last value in the array is represented by -1, the second to last by -2, and so on.

!!! example

A great example of a situation where you would want to use Column indexing are indicator traces.
``` yaml
- name: Indicator Trace
  model: ref(csv)
  columns:
    x_data: ?{ x }
    y_data: ?{ y }
  props:
    type: "indicator"
    mode: "number+delta"
    value: ?{ columns.y_data[0] }
    number:
      prefix: "$"
    delta:
      position: "top"
      reference: ?{ columns.y_data[1] }
```
In the trace above `column(y_data)[0]` is pulling the first item in the array as the value and comparing its delta to the second item in the column y_data array.

Slicing

Slicing allows you to pull out a sub-array from a given column array. This is useful when you only want to use a portion of the array in a given configuration, but don't want to filter the whole trace.

You can slice columns by using the following syntax:

column(column_name)[start:stop]

The start and stop values are zero-based indexes that represent the start and end of the slice you want to pull out. Negative indexes are also supported, allowing you to count from the end of the array. The last value in the array is represented by -1, the second to last by -2, and so on.

If you omit the stop value, the slice will continue to the end of the array. If you omit the start value, the slice will start at the beginning of the array.

!!! example

Surface plots can be a really useful place to utilize slicing.
``` yaml
- name: Surface Trace
  model: ${ ref(csv) }
  columns:
    x_data: ?{ x }
    y_data: ?{ y }
  props:
    type: surface
    z:
      - ${ columns.x_data }
      - ${ columns.x_data[0:5] }
      - ${ columns.x_data[5:10] }
      - ${ columns.y_data }
      - ${ columns.y_data[0:5] }
      - ${ columns.y_data[5:10] }
```
The trace above is creating a surface plot with lines on the plane of different lengths that represent different portions
of the x_data and y_data arrays.
TraceProps object
type string required
Values: "bar" "barpolar" "box" "candlestick" "carpet" "choropleth" "choroplethmap" "choroplethmapbox" "cone" "contour" "contourcarpet" "densitymap" "densitymapbox" "funnel" "funnelarea" "heatmap" "histogram" "histogram2d" "histogram2dcontour" "icicle" "image" "indicator" "isosurface" "mesh3d" "ohlc" "parcats" "parcoords" "pie" "sankey" "scatter" "scatter3d" "scattercarpet" "scattergeo" "scattergl" "scattermap" "scattermapbox" "scatterpolar" "scatterpolargl" "scattersmith" "scatterternary" "splom" "streamtube" "sunburst" "surface" "treemap" "violin" "volume" "waterfall"
Bar object

A schema to validate plotly trace properties

type const: "bar" required
Constant: "bar"
alignmentgroup string

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

Default: ""
base array

Sets where the bar base is drawn (in position axis units). In stack or relative barmode, traces that set base will be excluded and drawn in overlay mode instead.

basesrc string

Sets the source reference on Chart Studio Cloud for base.

cliponaxis query-string | boolean

Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

constraintext query-string | enum

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Sets the x coordinate step. See x0 for more info.

dy query-string | number

Sets the y coordinate step. See y0 for more info.

error_x object
15 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

copy_ystyle query-string | boolean
symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y object
14 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextanchor query-string | enum

Determines if texts are kept at center or start/end points in textposition inside mode.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
17 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

cornerradius

Sets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to layout.barcornerradius. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the opacity of the bars.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

offset query-string | number | query-string | number[]

Shifts the position where the bar is drawn (in position axis units). In group barmode, traces that set offset will be excluded and drawn in overlay mode instead.

offsetgroup string

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

Default: ""
offsetsrc string

Sets the source reference on Chart Studio Cloud for offset.

opacity query-string | number

Sets the opacity of the trace.

orientation query-string | enum

Sets the orientation of the bars. With v (h), the value of the each bar spans along the vertical (horizontal).

outsidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

selected object
2 nested properties
marker object
2 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textangle query-string | number

Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With auto the texts may automatically be rotated to fit with the maximum size in bars.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Specifies the location of the text. inside positions text inside, next to the bar end (rotated and scaled if needed). outside positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. auto tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If none, no text appears.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables value and label.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
2 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width query-string | number | query-string | number[]

Sets the bar width (in position axis units).

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

x query-string | number | string[]

Sets the x coordinates.

x0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates.

y0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Barpolar object

A schema to validate plotly trace properties

type const: "barpolar" required
Constant: "barpolar"
base array

Sets where the bar base is drawn (in radial axis units). In stack barmode, traces that set base will be excluded and drawn in overlay mode instead.

basesrc string

Sets the source reference on Chart Studio Cloud for base.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dr query-string | number

Sets the r coordinate step.

dtheta query-string | number

Sets the theta coordinate step. By default, the dtheta step equals the subplot's period divided by the length of the r coordinates.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
16 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the opacity of the bars.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

offset query-string | number | query-string | number[]

Shifts the angular position where the bar is drawn (in thetatunit units).

offsetsrc string

Sets the source reference on Chart Studio Cloud for offset.

opacity query-string | number

Sets the opacity of the trace.

r query-string | number | string[]

Sets the radial coordinates

r0

Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

Default: 0
rsrc string

Sets the source reference on Chart Studio Cloud for r.

selected object
2 nested properties
marker object
2 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a polar subplot. If polar (the default value), the data refer to layout.polar. If polar2, the data refer to layout.polar2, and so on.

text string | string[]

Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

theta query-string | number | string[]

Sets the angular coordinates

theta0

Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

Default: 0
thetasrc string

Sets the source reference on Chart Studio Cloud for theta.

thetaunit query-string | enum

Sets the unit of input theta values. Has an effect only when on linear angular axes.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
2 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width query-string | number | query-string | number[]

Sets the bar angular width (in thetaunit units).

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

Box object

A schema to validate plotly trace properties

type const: "box" required
Constant: "box"
alignmentgroup string

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

Default: ""
boxmean query-string | enum

If true, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If sd the standard deviation is also drawn. Defaults to true when mean is set. Defaults to sd when sd is set Otherwise defaults to false.

boxpoints query-string | enum

If outliers, only the sample points lying outside the whiskers are shown If suspectedoutliers, the outlier points are shown and points either less than 4Q1-3Q3 or greater than 4Q3-3Q1 are highlighted (see outliercolor) If all, all sample points are shown If false, only the box(es) are shown with no sample points Defaults to suspectedoutliers when marker.outliercolor or marker.line.outliercolor is set. Defaults to all under the q1/median/q3 signature. Otherwise defaults to outliers.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Sets the x coordinate step for multi-box traces set using q1/median/q3.

dy query-string | number

Sets the y coordinate step for multi-box traces set using q1/median/q3.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoveron query-string | string

Do the hover effects highlight individual boxes or sample points or both?

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

jitter query-string | number

Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the box(es).

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
2 nested properties

Sets the color of line bounding the box(es).

width query-string | number

Sets the width (in px) of line bounding the box(es).

lowerfence query-string | number | string[]

Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If lowerfence is not provided but a sample (in y or x) is set, we compute the lower as the last sample point below 1.5 times the IQR.

lowerfencesrc string

Sets the source reference on Chart Studio Cloud for lowerfence.

marker object
7 nested properties
angle query-string | number

Sets the marker angle in respect to angleref.

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

line object
4 nested properties

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

outliercolor query-string | color

Sets the border line color of the outlier sample points. Defaults to marker.color

outlierwidth query-string | number

Sets the border line width (in px) of the outlier sample points.

width query-string | number

Sets the width (in px) of the lines bounding the marker points.

opacity query-string | number

Sets the marker opacity.

outliercolor query-string | color

Sets the color of the outlier sample points.

size query-string | number

Sets the marker size (in px).

symbol query-string | enum

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

mean query-string | number | string[]

Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If mean is not provided but a sample (in y or x) is set, we compute the mean for each box using the sample values.

meansrc string

Sets the source reference on Chart Studio Cloud for mean.

median query-string | number | string[]

Sets the median values. There should be as many items as the number of boxes desired.

mediansrc string

Sets the source reference on Chart Studio Cloud for median.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical

notched query-string | boolean

Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to false unless notchwidth or notchspan is set.

notchspan query-string | number | string[]

Sets the notch span from the boxes' median values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If notchspan is not provided but a sample (in y or x) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size.

notchspansrc string

Sets the source reference on Chart Studio Cloud for notchspan.

notchwidth query-string | number

Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).

offsetgroup string

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

Default: ""
opacity query-string | number

Sets the opacity of the trace.

orientation query-string | enum

Sets the orientation of the box(es). If v (h), the distribution is visualized along the vertical (horizontal).

pointpos query-string | number

Sets the position of the sample points in relation to the box(es). If 0, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes

q1 query-string | number | string[]

Sets the Quartile 1 values. There should be as many items as the number of boxes desired.

q1src string

Sets the source reference on Chart Studio Cloud for q1.

q3 query-string | number | string[]

Sets the Quartile 3 values. There should be as many items as the number of boxes desired.

q3src string

Sets the source reference on Chart Studio Cloud for q3.

quartilemethod query-string | enum

Sets the method used to compute the sample's Q1 and Q3 quartiles. The linear method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The exclusive method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The inclusive method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

sd query-string | number | string[]

Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If sd is not provided but a sample (in y or x) is set, we compute the standard deviation for each box using the sample values.

sdmultiple query-string | number

Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev

sdsrc string

Sets the source reference on Chart Studio Cloud for sd.

selected object
1 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showwhiskers query-string | boolean

Determines whether or not whiskers are visible. Defaults to true for sizemode quartiles, false for sd.

sizemode query-string | enum

Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

upperfence query-string | number | string[]

Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If upperfence is not provided but a sample (in y or x) is set, we compute the upper as the last sample point above 1.5 times the IQR.

upperfencesrc string

Sets the source reference on Chart Studio Cloud for upperfence.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

whiskerwidth query-string | number

Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

width query-string | number

Sets the width of the box in data coordinate If 0 (default value) the width is automatically selected based on the positions of other box traces in the same subplot.

x query-string | number | string[]

Sets the x sample data or coordinates. See overview for more info.

x0

Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y sample data or coordinates. See overview for more info.

y0

Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Candlestick object

A schema to validate plotly trace properties

type const: "candlestick" required
Constant: "candlestick"
close query-string | number | string[]

Sets the close values.

closesrc string

Sets the source reference on Chart Studio Cloud for close.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

decreasing object
2 nested properties
fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

line object
2 nested properties

Sets the color of line bounding the box(es).

width query-string | number

Sets the width (in px) of line bounding the box(es).

high query-string | number | string[]

Sets the high values.

highsrc string

Sets the source reference on Chart Studio Cloud for high.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
10 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

split query-string | boolean

Show hover information (open, close, high, low) in separate labels.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

increasing object
2 nested properties
fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

line object
2 nested properties

Sets the color of line bounding the box(es).

width query-string | number

Sets the width (in px) of line bounding the box(es).

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
1 nested properties
width query-string | number

Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via increasing.line.width and decreasing.line.width.

low query-string | number | string[]

Sets the low values.

lowsrc string

Sets the source reference on Chart Studio Cloud for low.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

open query-string | number | string[]

Sets the open values.

opensrc string

Sets the source reference on Chart Studio Cloud for open.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

whiskerwidth query-string | number

Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

x query-string | number | string[]

Sets the x coordinates. If absent, linear coordinate will be generated.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Carpet object

A schema to validate plotly trace properties

type const: "carpet" required
Constant: "carpet"
a query-string | number | string[]

An array containing values of the first parameter value

a0 query-string | number

Alternate to a. Builds a linear space of a coordinates. Use with da where a0 is the starting coordinate and da the step.

aaxis object
57 nested properties
arraydtick query-string | integer

The stride between grid lines along the axis

arraytick0 query-string | integer

The starting index of grid lines along the axis

autorange query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

cheatertype query-string | enum

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 query-string | number

The stride between grid lines along the axis

endline query-string | boolean

Determines whether or not a line is drawn at along the final value of this axis. If true, the end line is drawn on top of the grid lines.

endlinecolor query-string | color

Sets the line color of the end line.

endlinewidth query-string | number

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

exponentformat query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the axis line color.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

labelalias

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.

Default: false
labelpadding query-string | integer

Extra padding between label and the axis

labelprefix string

Sets a axis label prefix.

labelsuffix string

Sets a axis label suffix.

Default: ""
linecolor query-string | color

Sets the axis line color.

linewidth query-string | number

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

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number

minorgridcolor query-string | color

Sets the color of the grid lines.

minorgridcount query-string | integer

Sets the number of minor grid ticks per major grid tick

minorgriddash string

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

Default: "solid"
minorgridwidth query-string | number

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

nticks query-string | integer

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 query-string | 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 query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data.

separatethousands query-string | boolean

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

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | enum

Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

smoothing query-string | number
startline query-string | boolean

Determines whether or not a line is drawn at along the starting value of this axis. If true, the start line is drawn on top of the grid lines.

startlinecolor query-string | color

Sets the line color of the start line.

startlinewidth query-string | number

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

tick0 query-string | number

The starting index of grid lines along the axis

tickangle query-string | number

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

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
tickmode query-string | enum
tickprefix string

Sets a tick label prefix.

Default: ""
ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

title object
3 nested properties
font object
offset query-string | number

An additional amount by which to offset the title from the tick labels, given in pixels.

text string

Sets the title of this axis.

Default: ""
type query-string | enum

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.

asrc string

Sets the source reference on Chart Studio Cloud for a.

b query-string | number | string[]

A two dimensional array of y coordinates at each carpet point.

b0 query-string | number

Alternate to b. Builds a linear space of a coordinates. Use with db where b0 is the starting coordinate and db the step.

baxis object
57 nested properties
arraydtick query-string | integer

The stride between grid lines along the axis

arraytick0 query-string | integer

The starting index of grid lines along the axis

autorange query-string | enum

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 query-string | enum

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 query-string | number | string[]

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

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

cheatertype query-string | enum

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 query-string | number

The stride between grid lines along the axis

endline query-string | boolean

Determines whether or not a line is drawn at along the final value of this axis. If true, the end line is drawn on top of the grid lines.

endlinecolor query-string | color

Sets the line color of the end line.

endlinewidth query-string | number

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

exponentformat query-string | enum

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.

fixedrange query-string | boolean

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

gridcolor query-string | color

Sets the axis line color.

griddash string

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

Default: "solid"
gridwidth query-string | number

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

labelalias

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.

Default: false
labelpadding query-string | integer

Extra padding between label and the axis

labelprefix string

Sets a axis label prefix.

labelsuffix string

Sets a axis label suffix.

Default: ""
linecolor query-string | color

Sets the axis line color.

linewidth query-string | number

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

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number

minorgridcolor query-string | color

Sets the color of the grid lines.

minorgridcount query-string | integer

Sets the number of minor grid ticks per major grid tick

minorgriddash string

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

Default: "solid"
minorgridwidth query-string | number

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

nticks query-string | integer

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 query-string | 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 query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data.

separatethousands query-string | boolean

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

showexponent query-string | enum

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 query-string | boolean

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

showline query-string | boolean

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

showticklabels query-string | enum

Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

smoothing query-string | number
startline query-string | boolean

Determines whether or not a line is drawn at along the starting value of this axis. If true, the start line is drawn on top of the grid lines.

startlinecolor query-string | color

Sets the line color of the start line.

startlinewidth query-string | number

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

tick0 query-string | number

The starting index of grid lines along the axis

tickangle query-string | number

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

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
tickmode query-string | enum
tickprefix string

Sets a tick label prefix.

Default: ""
ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

title object
3 nested properties
font object
offset query-string | number

An additional amount by which to offset the title from the tick labels, given in pixels.

text string

Sets the title of this axis.

Default: ""
type query-string | enum

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.

bsrc string

Sets the source reference on Chart Studio Cloud for b.

carpet string

An identifier for this carpet, so that scattercarpet and contourcarpet traces can specify a carpet plot on which they lie

cheaterslope query-string | number

The shift applied to each successive row of data in creating a cheater plot. Only used if x is been omitted.

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.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

da query-string | number

Sets the a coordinate step. See a0 for more info.

db query-string | number

Sets the b coordinate step. See b0 for more info.

font object
9 nested properties
family 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.

Default: ""Open Sans", verdana, arial, sans-serif"
pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

A two dimensional array of y coordinates at each carpet point.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Choropleth object

A schema to validate plotly trace properties

type const: "choropleth" required
Constant: "choropleth"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

featureidkey string

Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example properties.name.

Default: "id"
geo query-string | string

Sets a reference between this trace's geospatial coordinates and a geographic map. If geo (the default value), the geospatial coordinates refer to layout.geo. If geo2, the geospatial coordinates refer to layout.geo2, and so on.

geojson

Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type FeatureCollection or Feature with geometries of type Polygon or MultiPolygon.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

locationmode query-string | enum

Determines the set of locations used to match entries in locations to regions on the map. Values ISO-3, USA-states, country names correspond to features on the base map and value geojson-id corresponds to features from a custom GeoJSON linked to the geojson attribute.

locations query-string | number | string[]

Sets the coordinates via location IDs or names. See locationmode for more info.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

marker object
3 nested properties
line object
4 nested properties
color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the opacity of the locations.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

selected object
1 nested properties
marker object
1 nested properties
opacity query-string | number

Sets the marker opacity of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets the text elements associated with each location.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
1 nested properties
opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z query-string | number | string[]

Sets the color values.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Choroplethmap object

A schema to validate plotly trace properties

type const: "choroplethmap" required
Constant: "choroplethmap"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

below string

Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmap traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

featureidkey string

Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Support nested property, for example properties.name.

Default: "id"
geojson

Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type FeatureCollection or Feature with geometries of type Polygon or MultiPolygon.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

locations query-string | number | string[]

Sets which features found in geojson to plot using their feature id field.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

marker object
3 nested properties
line object
4 nested properties
color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the opacity of the locations.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

selected object
1 nested properties
marker object
1 nested properties
opacity query-string | number

Sets the marker opacity of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a map subplot. If map (the default value), the data refer to layout.map. If map2, the data refer to layout.map2, and so on.

text string | string[]

Sets the text elements associated with each location.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
1 nested properties
opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z query-string | number | string[]

Sets the color values.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Choroplethmapbox object

A schema to validate plotly trace properties

type const: "choroplethmapbox" required
Constant: "choroplethmapbox"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

below string

Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

featureidkey string

Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Support nested property, for example properties.name.

Default: "id"
geojson

Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type FeatureCollection or Feature with geometries of type Polygon or MultiPolygon.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable properties Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

locations query-string | number | string[]

Sets which features found in geojson to plot using their feature id field.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

marker object
3 nested properties
line object
4 nested properties
color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the opacity of the locations.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

selected object
1 nested properties
marker object
1 nested properties
opacity query-string | number

Sets the marker opacity of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace's data coordinates and a mapbox subplot. If mapbox (the default value), the data refer to layout.mapbox. If mapbox2, the data refer to layout.mapbox2, and so on.

text string | string[]

Sets the text elements associated with each location.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
1 nested properties
opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z query-string | number | string[]

Sets the color values.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Cone object

A schema to validate plotly trace properties

type const: "cone" required
Constant: "cone"
anchor query-string | enum

Sets the cones' anchor with respect to their x/y/z positions. Note that cm denote the cone's center of mass which corresponds to 1/4 from the tail to tip.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable norm Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lighting object
7 nested properties
ambient query-string | number

Ambient light increases overall color visibility but can wash out the image.

diffuse query-string | number

Represents the extent that incident rays are reflected in a range of angles.

facenormalsepsilon query-string | number

Epsilon for face normals calculation avoids math issues arising from degenerate geometry.

fresnel query-string | number

Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.

roughness query-string | number

Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.

specular query-string | number

Represents the level that incident rays are reflected in a single direction, causing shine.

vertexnormalsepsilon query-string | number

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition object
3 nested properties
x query-string | number

Numeric vector, representing the X coordinate for each vertex.

y query-string | number

Numeric vector, representing the Y coordinate for each vertex.

z query-string | number

Numeric vector, representing the Z coordinate for each vertex.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

scene query-string | string

Sets a reference between this trace's 3D coordinate system and a 3D scene. If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

sizemode query-string | enum

Determines whether sizeref is set as a scaled (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as absolute value (in the same units as the vector field). To display sizes in actual vector length use raw.

sizeref query-string | number

Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and sizeref. This factor (computed internally) corresponds to the minimum "time" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With sizemode set to raw, its default value is 1. With sizemode set to scaled, sizeref is unitless, its default value is 0.5. With sizemode set to absolute, sizeref has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets the text elements associated with the cones. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

u query-string | number | string[]

Sets the x components of the vector field.

uhoverformat string

Sets the hover text formatting rulefor u 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.By default the values are formatted using generic number format.

Default: ""
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

usrc string

Sets the source reference on Chart Studio Cloud for u.

v query-string | number | string[]

Sets the y components of the vector field.

vhoverformat string

Sets the hover text formatting rulefor v 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.By default the values are formatted using generic number format.

Default: ""
visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

vsrc string

Sets the source reference on Chart Studio Cloud for v.

w query-string | number | string[]

Sets the z components of the vector field.

whoverformat string

Sets the hover text formatting rulefor w 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.By default the values are formatted using generic number format.

Default: ""
wsrc string

Sets the source reference on Chart Studio Cloud for w.

x query-string | number | string[]

Sets the x coordinates of the vector field and of the displayed cones.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates of the vector field and of the displayed cones.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the z coordinates of the vector field and of the displayed cones.

zhoverformat string

Sets the hover text formatting rulefor z 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.46By default the values are formatted using zaxis.hoverformat.

Default: ""
zsrc string

Sets the source reference on Chart Studio Cloud for z.

Contour object

A schema to validate plotly trace properties

type const: "contour" required
Constant: "contour"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

autocontour query-string | boolean

Determines whether or not the contour level attributes are picked by an algorithm. If true, the number of contour levels can be set in ncontours. If false, set the contour level attributes in contours.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array otherwise it is defaulted to false.

contours object
12 nested properties
coloring query-string | enum

Determines the coloring method showing the contour values. If fill, coloring is done evenly between each contour level If heatmap, a heatmap gradient coloring is applied between each contour level. If lines, coloring is done on the contour lines. If none, no coloring is applied on this trace.

end query-string | number

Sets the end contour level value. Must be more than contours.start

impliedEdits
labelfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

labelformat string

Sets the contour 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.

Default: ""
operation query-string | enum

Sets the constraint operation. = keeps regions equal to value < and <= keep regions less than value > and >= keep regions greater than value [], (), [), and (] keep regions inside value[0] to value[1] ][, )(, ](, )[ keep regions outside value[0] to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.

showlabels query-string | boolean

Determines whether to label the contour lines with their values.

showlines query-string | boolean

Determines whether or not the contour lines are drawn. Has an effect only if contours.coloring is set to fill.

size query-string | number

Sets the step between each contour level. Must be positive.

start query-string | number

Sets the starting contour level value. Must be less than contours.end

type query-string | enum

If levels, the data is represented as a contour plot with multiple levels displayed. If constraint, the data is represented as constraints with the invalid region shaded as specified by the operation and value parameters.

value

Sets the value or values of the constraint boundary. When operation is set to one of the comparison values (=,<,>=,>,<=) value is expected to be a number. When operation is set to one of the interval values ([],(),[),(],],)(,[) value is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.

Default: 0
customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Sets the x coordinate step. See x0 for more info.

dy query-string | number

Sets the y coordinate step. See y0 for more info.

fillcolor query-string | color

Sets the fill color if contours.type is constraint. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoverongaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the z data have hover labels associated with them.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext query-string | number | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
4 nested properties

Sets the color of the contour level. Has no effect if contours.coloring is set to lines.

dash string

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

Default: "solid"
smoothing query-string | number

Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.

width query-string | number

Sets the contour line width in (in px) Defaults to 0.5 when contours.type is levels. Defaults to 2 when contour.type is constraint.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

ncontours query-string | integer

Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is true or if contours.size is missing.

opacity query-string | number

Sets the opacity of the trace.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets the text elements associated with each z value.

textfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string

For this trace it only has an effect if coloring is set to heatmap. Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

Default: ""
transpose query-string | boolean

Transposes the z data.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the x coordinates.

x0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

xtype query-string | enum

If array, the heatmap's x coordinates are given by x (the default behavior when x is provided). If scaled, the heatmap's x coordinates are given by x0 and dx (the default behavior when x is not provided).

y query-string | number | string[]

Sets the y coordinates.

y0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

ytype query-string | enum

If array, the heatmap's y coordinates are given by y (the default behavior when y is provided) If scaled, the heatmap's y coordinates are given by y0 and dy (the default behavior when y is not provided)

z query-string | number | string[]

Sets the z data.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zhoverformat string

Sets the hover text formatting rulefor z 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.By default the values are formatted using generic number format.

Default: ""
zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Contourcarpet object

A schema to validate plotly trace properties

type const: "contourcarpet" required
Constant: "contourcarpet"
a query-string | number | string[]

Sets the x coordinates.

a0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
asrc string

Sets the source reference on Chart Studio Cloud for a.

atype query-string | enum

If array, the heatmap's x coordinates are given by x (the default behavior when x is provided). If scaled, the heatmap's x coordinates are given by x0 and dx (the default behavior when x is not provided).

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

autocontour query-string | boolean

Determines whether or not the contour level attributes are picked by an algorithm. If true, the number of contour levels can be set in ncontours. If false, set the contour level attributes in contours.

b query-string | number | string[]

Sets the y coordinates.

b0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
bsrc string

Sets the source reference on Chart Studio Cloud for b.

btype query-string | enum

If array, the heatmap's y coordinates are given by y (the default behavior when y is provided) If scaled, the heatmap's y coordinates are given by y0 and dy (the default behavior when y is not provided)

carpet string

The carpet of the carpet axes on which this contour trace lies

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

contours object
12 nested properties
coloring query-string | enum

Determines the coloring method showing the contour values. If fill, coloring is done evenly between each contour level If lines, coloring is done on the contour lines. If none, no coloring is applied on this trace.

end query-string | number

Sets the end contour level value. Must be more than contours.start

impliedEdits
labelfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

labelformat string

Sets the contour 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.

Default: ""
operation query-string | enum

Sets the constraint operation. = keeps regions equal to value < and <= keep regions less than value > and >= keep regions greater than value [], (), [), and (] keep regions inside value[0] to value[1] ][, )(, ](, )[ keep regions outside value[0] to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.

showlabels query-string | boolean

Determines whether to label the contour lines with their values.

showlines query-string | boolean

Determines whether or not the contour lines are drawn. Has an effect only if contours.coloring is set to fill.

size query-string | number

Sets the step between each contour level. Must be positive.

start query-string | number

Sets the starting contour level value. Must be less than contours.end

type query-string | enum

If levels, the data is represented as a contour plot with multiple levels displayed. If constraint, the data is represented as constraints with the invalid region shaded as specified by the operation and value parameters.

value

Sets the value or values of the constraint boundary. When operation is set to one of the comparison values (=,<,>=,>,<=) value is expected to be a number. When operation is set to one of the interval values ([],(),[),(],],)(,[) value is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.

Default: 0
customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

da query-string | number

Sets the x coordinate step. See x0 for more info.

db query-string | number

Sets the y coordinate step. See y0 for more info.

fillcolor query-string | color

Sets the fill color if contours.type is constraint. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hovertext query-string | number | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
4 nested properties

Sets the color of the contour level. Has no effect if contours.coloring is set to lines.

dash string

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

Default: "solid"
smoothing query-string | number

Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.

width query-string | number

Sets the contour line width in (in px) Defaults to 0.5 when contours.type is levels. Defaults to 2 when contour.type is constraint.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

ncontours query-string | integer

Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is true or if contours.size is missing.

opacity query-string | number

Sets the opacity of the trace.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets the text elements associated with each z value.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

transpose query-string | boolean

Transposes the z data.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

z query-string | number | string[]

Sets the z data.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Densitymap object

A schema to validate plotly trace properties

type const: "densitymap" required
Constant: "densitymap"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

below string

Determines if the densitymap trace will be inserted before the layer with the specified ID. By default, densitymap traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

lat query-string | number | string[]

Sets the latitude coordinates (in degrees North).

latsrc string

Sets the source reference on Chart Studio Cloud for lat.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lon query-string | number | string[]

Sets the longitude coordinates (in degrees East).

lonsrc string

Sets the source reference on Chart Studio Cloud for lon.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

radius query-string | number | query-string | number[]

Sets the radius of influence of one lon / lat point in pixels. Increasing the value makes the densitymap trace smoother, but less detailed.

radiussrc string

Sets the source reference on Chart Studio Cloud for radius.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a map subplot. If map (the default value), the data refer to layout.map. If map2, the data refer to layout.map2, and so on.

text string | string[]

Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z query-string | number | string[]

Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Densitymapbox object

A schema to validate plotly trace properties

type const: "densitymapbox" required
Constant: "densitymapbox"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

below string

Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

lat query-string | number | string[]

Sets the latitude coordinates (in degrees North).

latsrc string

Sets the source reference on Chart Studio Cloud for lat.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lon query-string | number | string[]

Sets the longitude coordinates (in degrees East).

lonsrc string

Sets the source reference on Chart Studio Cloud for lon.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

radius query-string | number | query-string | number[]

Sets the radius of influence of one lon / lat point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

radiussrc string

Sets the source reference on Chart Studio Cloud for radius.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace's data coordinates and a mapbox subplot. If mapbox (the default value), the data refer to layout.mapbox. If mapbox2, the data refer to layout.mapbox2, and so on.

text string | string[]

Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

z query-string | number | string[]

Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Funnel object

A schema to validate plotly trace properties

type const: "funnel" required
Constant: "funnel"
alignmentgroup string

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

Default: ""
cliponaxis query-string | boolean

Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

connector object
3 nested properties
fillcolor query-string | color

Sets the fill color.

line object
3 nested properties

Sets the line color.

dash string

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

Default: "solid"
width query-string | number

Sets the line width (in px).

visible query-string | boolean

Determines if connector regions and lines are drawn.

constraintext query-string | enum

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Sets the x coordinate step. See x0 for more info.

dy query-string | number

Sets the y coordinate step. See y0 for more info.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious and percentTotal. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextanchor query-string | enum

Determines if texts are kept at center or start/end points in textposition inside mode.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
15 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the opacity of the bars.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

offset query-string | number

Shifts the position where the bar is drawn (in position axis units). In group barmode, traces that set offset will be excluded and drawn in overlay mode instead.

offsetgroup string

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

Default: ""
opacity query-string | number

Sets the opacity of the trace.

orientation query-string | enum

Sets the orientation of the funnels. With v (h), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only y array is presented or orientation is set to v. Also regarding graphs including only 'horizontal' funnels, autorange on the y-axis are set to reversed.

outsidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textangle query-string | number

Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With auto the texts may automatically be rotated to fit with the maximum size in bars.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textinfo query-string | string | string

Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).

textposition query-string | enum | query-string | enum[]

Specifies the location of the text. inside positions text inside, next to the bar end (rotated and scaled if needed). outside positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. auto tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If none, no text appears.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables percentInitial, percentPrevious, percentTotal, label and value.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width query-string | number

Sets the bar width (in position axis units).

x query-string | number | string[]

Sets the x coordinates.

x0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates.

y0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Funnelarea object

A schema to validate plotly trace properties

type const: "funnelarea" required
Constant: "funnelarea"
aspectratio query-string | number

Sets the ratio between height and width

baseratio query-string | number

Sets the ratio between bottom length and maximum top length.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dlabel query-string | number

Sets the label step. See label0 for more info.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this funnelarea trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this funnelarea trace .

x query-string | query-string | number[]

Sets the horizontal domain of this funnelarea trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this funnelarea trace (in plot fraction).

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

label0 query-string | number

Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

labels query-string | number | string[]

Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

labelssrc string

Sets the source reference on Chart Studio Cloud for labels.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
4 nested properties
colors query-string | number | string[]

Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.

colorssrc string

Sets the source reference on Chart Studio Cloud for colors.

line object
4 nested properties
color query-string | color | query-string | color[]

Sets the color of the line enclosing each sector. Defaults to the paper_bgcolor value.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the line enclosing each sector.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

scalegroup string

If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

Default: ""
showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets text elements associated with each sector. If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textinfo query-string | string | string

Determines which trace information appear on the graph.

textposition query-string | enum | query-string | enum[]

Specifies the location of the textinfo.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, text and percent.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

title object
3 nested properties
font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

position query-string | enum

Specifies the location of the title.

text string

Sets the title of the chart. If it is empty, no title is displayed.

Default: ""
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

values query-string | number | string[]

Sets the values of the sectors. If omitted, we count occurrences of each label.

valuessrc string

Sets the source reference on Chart Studio Cloud for values.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Heatmap object

A schema to validate plotly trace properties

type const: "heatmap" required
Constant: "heatmap"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array and zsmooth is not false; otherwise it is defaulted to false.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Sets the x coordinate step. See x0 for more info.

dy query-string | number

Sets the y coordinate step. See y0 for more info.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoverongaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the z data have hover labels associated with them.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext query-string | number | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets the text elements associated with each z value.

textfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

Default: ""
transpose query-string | boolean

Transposes the z data.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the x coordinates.

x0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xgap query-string | number

Sets the horizontal gap (in pixels) between bricks.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

xtype query-string | enum

If array, the heatmap's x coordinates are given by x (the default behavior when x is provided). If scaled, the heatmap's x coordinates are given by x0 and dx (the default behavior when x is not provided).

y query-string | number | string[]

Sets the y coordinates.

y0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

ygap query-string | number

Sets the vertical gap (in pixels) between bricks.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

ytype query-string | enum

If array, the heatmap's y coordinates are given by y (the default behavior when y is provided) If scaled, the heatmap's y coordinates are given by y0 and dy (the default behavior when y is not provided)

z query-string | number | string[]

Sets the z data.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zhoverformat string

Sets the hover text formatting rulefor z 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.By default the values are formatted using generic number format.

Default: ""
zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

zsmooth query-string | enum

Picks a smoothing algorithm use to smooth z data.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Histogram object

A schema to validate plotly trace properties

type const: "histogram" required
Constant: "histogram"
alignmentgroup string

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

Default: ""
autobinx query-string | boolean

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

autobiny query-string | boolean

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

bingroup string

Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same orientation under barmode stack, relative and group are forced into the same bingroup, Using bingroup, traces under barmode overlay and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same bingroup

Default: ""
cliponaxis query-string | boolean

Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

constraintext query-string | enum

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

cumulative object
3 nested properties
currentbin query-string | enum

Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. include is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. exclude makes the opposite half-bin bias, and half removes it.

direction query-string | enum

Only applies if cumulative is enabled. If increasing (default) we sum all prior bins, so the result increases from left to right. If decreasing we sum later bins so the result decreases from left to right.

enabled query-string | boolean

If true, display the cumulative distribution by summing the binned values. Use the direction and centralbin attributes to tune the accumulation method. Note: in this mode, the density histnorm settings behave the same as their equivalents without density: ** and density both rise to the number of data points, and probability and probability density both rise to the number of sample points.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

error_x object
15 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

copy_ystyle query-string | boolean
symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y object
14 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

histfunc query-string | enum

Specifies the binning function used for this histogram trace. If count, the histogram values are computed by counting the number of values lying inside each bin. If sum, avg, min, max, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

histnorm query-string | enum

Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If percent / probability, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If density, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable binNumber Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextanchor query-string | enum

Determines if texts are kept at center or start/end points in textposition inside mode.

insidetextfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
17 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

cornerradius

Sets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to layout.barcornerradius. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the opacity of the bars.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

nbinsx query-string | integer

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

nbinsy query-string | integer

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

offsetgroup string

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

Default: ""
opacity query-string | number

Sets the opacity of the trace.

orientation query-string | enum

Sets the orientation of the bars. With v (h), the value of the each bar spans along the vertical (horizontal).

outsidetextfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

selected object
2 nested properties
marker object
2 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.

textangle query-string | number

Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With auto the texts may automatically be rotated to fit with the maximum size in bars.

textfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

textposition query-string | enum

Specifies the location of the text. inside positions text inside, next to the bar end (rotated and scaled if needed). outside positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. auto tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If none, no text appears.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label and value.

Default: ""
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
2 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the sample data to be binned on the x axis.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xbins object
3 nested properties
end

Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

size

Sets the size of each x axis bin. Default behavior: If nbinsx is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsx is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or M for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit size is used and all others discarded. If no size is provided,the sample data from all traces is combined to determine size as described above.

start

Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit start is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the sample data to be binned on the y axis.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ybins object
3 nested properties
end

Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

size

Sets the size of each y axis bin. Default behavior: If nbinsy is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsy is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or M for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit size is used and all others discarded. If no size is provided,the sample data from all traces is combined to determine size as described above.

start

Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit start is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Histogram2d object

A schema to validate plotly trace properties

type const: "histogram2d" required
Constant: "histogram2d"
autobinx query-string | boolean

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

autobiny query-string | boolean

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

bingroup string

Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

Default: ""
coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

histfunc query-string | enum

Specifies the binning function used for this histogram trace. If count, the histogram values are computed by counting the number of values lying inside each bin. If sum, avg, min, max, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

histnorm query-string | enum

Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If percent / probability, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If density, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
2 nested properties
color query-string | number | string[]

Sets the aggregation data.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

nbinsx query-string | integer

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

nbinsy query-string | integer

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

opacity query-string | number

Sets the opacity of the trace.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
textfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

texttemplate string

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z

Default: ""
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the sample data to be binned on the x axis.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xbingroup string

Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

Default: ""
xbins object
3 nested properties
end

Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

size

Sets the size of each x axis bin. Default behavior: If nbinsx is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsx is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or M for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1).

start

Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xgap query-string | number

Sets the horizontal gap (in pixels) between bricks.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the sample data to be binned on the y axis.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ybingroup string

Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

Default: ""
ybins object
3 nested properties
end

Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

size

Sets the size of each y axis bin. Default behavior: If nbinsy is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsy is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or M for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1).

start

Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

ygap query-string | number

Sets the vertical gap (in pixels) between bricks.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the aggregation data.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zhoverformat string

Sets the hover text formatting rulefor z 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.By default the values are formatted using generic number format.

Default: ""
zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zsmooth query-string | enum

Picks a smoothing algorithm use to smooth z data.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Histogram2dcontour object

A schema to validate plotly trace properties

type const: "histogram2dcontour" required
Constant: "histogram2dcontour"
autobinx query-string | boolean

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

autobiny query-string | boolean

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

autocontour query-string | boolean

Determines whether or not the contour level attributes are picked by an algorithm. If true, the number of contour levels can be set in ncontours. If false, set the contour level attributes in contours.

bingroup string

Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

Default: ""
coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use zmin and zmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

contours object
12 nested properties
coloring query-string | enum

Determines the coloring method showing the contour values. If fill, coloring is done evenly between each contour level If heatmap, a heatmap gradient coloring is applied between each contour level. If lines, coloring is done on the contour lines. If none, no coloring is applied on this trace.

end query-string | number

Sets the end contour level value. Must be more than contours.start

impliedEdits
labelfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

labelformat string

Sets the contour 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.

Default: ""
operation query-string | enum

Sets the constraint operation. = keeps regions equal to value < and <= keep regions less than value > and >= keep regions greater than value [], (), [), and (] keep regions inside value[0] to value[1] ][, )(, ](, )[ keep regions outside value[0] to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.

showlabels query-string | boolean

Determines whether to label the contour lines with their values.

showlines query-string | boolean

Determines whether or not the contour lines are drawn. Has an effect only if contours.coloring is set to fill.

size query-string | number

Sets the step between each contour level. Must be positive.

start query-string | number

Sets the starting contour level value. Must be less than contours.end

type query-string | enum

If levels, the data is represented as a contour plot with multiple levels displayed. If constraint, the data is represented as constraints with the invalid region shaded as specified by the operation and value parameters.

value

Sets the value or values of the constraint boundary. When operation is set to one of the comparison values (=,<,>=,>,<=) value is expected to be a number. When operation is set to one of the interval values ([],(),[),(],],)(,[) value is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.

Default: 0
customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

histfunc query-string | enum

Specifies the binning function used for this histogram trace. If count, the histogram values are computed by counting the number of values lying inside each bin. If sum, avg, min, max, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

histnorm query-string | enum

Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If percent / probability, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If density, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variable z Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
4 nested properties

Sets the color of the contour level. Has no effect if contours.coloring is set to lines.

dash string

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

Default: "solid"
smoothing query-string | number

Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.

width query-string | number

Sets the contour line width in (in px)

marker object
2 nested properties
color query-string | number | string[]

Sets the aggregation data.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

nbinsx query-string | integer

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

nbinsy query-string | integer

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

ncontours query-string | integer

Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is true or if contours.size is missing.

opacity query-string | number

Sets the opacity of the trace.

reversescale query-string | boolean

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
textfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

texttemplate string

For this trace it only has an effect if coloring is set to heatmap. Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables x, y, z and text.

Default: ""
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the sample data to be binned on the x axis.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xbingroup string

Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

Default: ""
xbins object
3 nested properties
end

Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

size

Sets the size of each x axis bin. Default behavior: If nbinsx is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsx is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or M for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1).

start

Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the sample data to be binned on the y axis.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ybingroup string

Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

Default: ""
ybins object
3 nested properties
end

Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

size

Sets the size of each y axis bin. Default behavior: If nbinsy is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsy is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or M for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1).

start

Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the aggregation data.

zauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

zhoverformat string

Sets the hover text formatting rulefor z 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.By default the values are formatted using generic number format.

Default: ""
zmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

zmid query-string | number

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

zmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Icicle object

A schema to validate plotly trace properties

type const: "icicle" required
Constant: "icicle"
branchvalues query-string | enum

Determines how the items in values are summed. When set to total, items in values are taken to be value of all its descendants. When set to remainder, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

count query-string | string

Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this icicle trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this icicle trace .

x query-string | query-string | number[]

Sets the horizontal domain of this icicle trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this icicle trace (in plot fraction).

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

labels query-string | number | string[]

Sets the labels of each of the sectors.

labelssrc string

Sets the source reference on Chart Studio Cloud for labels.

leaf object
1 nested properties
opacity query-string | number

Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

level

Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an "id" if ids is filled in, otherwise plotly attempts to find a matching item in labels.

marker object
14 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if colors is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in marker.cmin and marker.cmax Has an effect only if colors is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colors query-string | number | string[]

Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorssrc string

Sets the source reference on Chart Studio Cloud for colors.

line object
4 nested properties
color query-string | color | query-string | color[]

Sets the color of the line enclosing each sector. Defaults to the paper_bgcolor value.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the line enclosing each sector.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.

maxdepth query-string | integer

Sets the number of rendered sectors from any given level. Set maxdepth to -1 to render all the levels in the hierarchy.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

outsidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

parents query-string | number | string[]

Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be "ids" themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

parentssrc string

Sets the source reference on Chart Studio Cloud for parents.

pathbar object
5 nested properties
edgeshape query-string | enum

Determines which shape is used for edges between barpath labels.

side query-string | enum

Determines on which side of the the treemap the pathbar should be presented.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

thickness query-string | number

Sets the thickness of pathbar (in px). If not specified the pathbar.textfont.size is used with 3 pixles extra padding on each side.

visible query-string | boolean

Determines if the path bar is drawn i.e. outside the trace domain and with one pixel gap.

root object
1 nested properties

sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.

sort query-string | boolean

Determines whether or not the sectors are reordered from largest to smallest.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets text elements associated with each sector. If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textinfo query-string | string | string

Determines which trace information appear on the graph.

textposition query-string | enum

Sets the positions of the text elements.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

tiling object
3 nested properties
flip query-string | string

Determines if the positions obtained from solver are flipped on each axis.

orientation query-string | enum

When set in conjunction with tiling.flip, determines on which side the root nodes are drawn in the chart. If tiling.orientation is v and tiling.flip is **, the root nodes appear at the top. If tiling.orientation is v and tiling.flip is y, the root nodes appear at the bottom. If tiling.orientation is h and tiling.flip is **, the root nodes appear at the left. If tiling.orientation is h and tiling.flip is x, the root nodes appear at the right.

pad query-string | number

Sets the inner padding (in px).

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

values query-string | number | string[]

Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

valuessrc string

Sets the source reference on Chart Studio Cloud for values.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Image object

A schema to validate plotly trace properties

type const: "image" required
Constant: "image"
colormodel query-string | enum

Color model used to map the numerical color components described in z into colors. If source is specified, this attribute will be set to rgba256 otherwise it defaults to rgb.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Set the pixel's horizontal size.

dy query-string | number

Set the pixel's vertical size

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables z, color and colormodel. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext query-string | number | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

source string

Specifies the data URI of the image to be visualized. The URI consists of "data:image/[][;base64],"

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets the text elements associated with each z value.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x0

Set the image's x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

y0

Set the image's y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

z query-string | number | string[]

A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.

zmax query-string | query-string | number[]

Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the rgb colormodel, it is [255, 255, 255]. For the rgba colormodel, it is [255, 255, 255, 1]. For the rgba256 colormodel, it is [255, 255, 255, 255]. For the hsl colormodel, it is [360, 100, 100]. For the hsla colormodel, it is [360, 100, 100, 1].

zmin query-string | query-string | number[]

Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the rgb colormodel, it is [0, 0, 0]. For the rgba colormodel, it is [0, 0, 0, 0]. For the rgba256 colormodel, it is [0, 0, 0, 0]. For the hsl colormodel, it is [0, 0, 0]. For the hsla colormodel, it is [0, 0, 0, 0].

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

zsmooth query-string | enum

Picks a smoothing algorithm used to smooth z data. This only applies for image traces that use the source attribute.

zsrc string

Sets the source reference on Chart Studio Cloud for z.

Indicator object

A schema to validate plotly trace properties

type const: "indicator" required
Constant: "indicator"
align query-string | enum

Sets the horizontal alignment of the text within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

delta object
9 nested properties
decreasing object
2 nested properties

Sets the color for increasing value.

symbol string

Sets the symbol to display for increasing value

Default: "▼"
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

increasing object
2 nested properties

Sets the color for increasing value.

symbol string

Sets the symbol to display for increasing value

Default: "▲"
position query-string | enum

Sets the position of delta with respect to the number.

prefix string

Sets a prefix appearing before the delta.

Default: ""
reference query-string | number

Sets the reference value to compute the delta. By default, it is set to the current value.

relative query-string | boolean

Show relative change

suffix string

Sets a suffix appearing next to the delta.

Default: ""
valueformat string

Sets the value 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.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this indicator trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this indicator trace .

x query-string | query-string | number[]

Sets the horizontal domain of this indicator trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this indicator trace (in plot fraction).

gauge object
8 nested properties
axis object
29 nested properties
dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
minexponent query-string | number

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

nticks query-string | integer

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 query-string | query-string | number[]

Sets the range of this axis.

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

visible query-string | boolean

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

bar object
3 nested properties

Sets the background color of the arc.

line object
thickness query-string | number

Sets the thickness of the bar as a fraction of the total thickness of the gauge.

bgcolor query-string | color

Sets the gauge background color.

bordercolor query-string | color

Sets the color of the border enclosing the gauge.

borderwidth query-string | number

Sets the width (in px) of the border enclosing the gauge.

shape query-string | enum

Set the shape of the gauge

steps object[]
minItems=1
threshold object
3 nested properties
line object
thickness query-string | number

Sets the thickness of the threshold line as a fraction of the thickness of the gauge.

value query-string | number

Sets a threshold value drawn as a line.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string

Determines how the value is displayed on the graph. number displays the value numerically in text. delta displays the difference to a reference value in text. Finally, gauge displays the value graphically on an axis.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

number object
4 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

prefix string

Sets a prefix appearing before the number.

Default: ""
suffix string

Sets a suffix appearing next to the number.

Default: ""
valueformat string

Sets the value 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.

Default: ""
stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
title object
3 nested properties
align query-string | enum

Sets the horizontal alignment of the title. It defaults to center except for bullet charts for which it defaults to right.

font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of this indicator.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

value query-string | number

Sets the number to be displayed.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Isosurface object

A schema to validate plotly trace properties

type const: "isosurface" required
Constant: "isosurface"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

caps object
3 nested properties
x object
2 nested properties
fill query-string | number

Sets the fill ratio of the caps. The default fill value of the caps is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

show query-string | boolean

Sets the fill ratio of the slices. The default fill value of the x slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

y object
2 nested properties
fill query-string | number

Sets the fill ratio of the caps. The default fill value of the caps is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

show query-string | boolean

Sets the fill ratio of the slices. The default fill value of the y slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

z object
2 nested properties
fill query-string | number

Sets the fill ratio of the caps. The default fill value of the caps is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

show query-string | boolean

Sets the fill ratio of the slices. The default fill value of the z slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as value. Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as value and if set, cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

contour object
3 nested properties

Sets the color of the contour lines.

show query-string | boolean

Sets whether or not dynamic contours are shown on hover

width query-string | number

Sets the width of the contour lines.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

flatshading query-string | boolean

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

isomax query-string | number

Sets the maximum boundary for iso-surface plot.

isomin query-string | number

Sets the minimum boundary for iso-surface plot.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lighting object
7 nested properties
ambient query-string | number

Ambient light increases overall color visibility but can wash out the image.

diffuse query-string | number

Represents the extent that incident rays are reflected in a range of angles.

facenormalsepsilon query-string | number

Epsilon for face normals calculation avoids math issues arising from degenerate geometry.

fresnel query-string | number

Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.

roughness query-string | number

Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.

specular query-string | number

Represents the level that incident rays are reflected in a single direction, causing shine.

vertexnormalsepsilon query-string | number

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition object
3 nested properties
x query-string | number

Numeric vector, representing the X coordinate for each vertex.

y query-string | number

Numeric vector, representing the Y coordinate for each vertex.

z query-string | number

Numeric vector, representing the Z coordinate for each vertex.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

scene query-string | string

Sets a reference between this trace's 3D coordinate system and a 3D scene. If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

slices object
3 nested properties
x object
4 nested properties
fill query-string | number

Sets the fill ratio of the slices. The default fill value of the slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

locations query-string | number | string[]

Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

show query-string | boolean

Determines whether or not slice planes about the x dimension are drawn.

y object
4 nested properties
fill query-string | number

Sets the fill ratio of the slices. The default fill value of the slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

locations query-string | number | string[]

Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

show query-string | boolean

Determines whether or not slice planes about the y dimension are drawn.

z object
4 nested properties
fill query-string | number

Sets the fill ratio of the slices. The default fill value of the slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

locations query-string | number | string[]

Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

show query-string | boolean

Determines whether or not slice planes about the z dimension are drawn.

spaceframe object
2 nested properties
fill query-string | number

Sets the fill ratio of the spaceframe elements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greater fill ratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1).

show query-string | boolean

Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
surface object
4 nested properties
count query-string | integer

Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.

fill query-string | number

Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

pattern query-string | string | string

Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is all meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital A, B, C, D and E may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.

show query-string | boolean

Hides/displays surfaces between minimum and maximum iso-values.

text string | string[]

Sets the text elements associated with the vertices. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

value query-string | number | string[]

Sets the 4th dimension (value) of the vertices.

valuehoverformat string

Sets the hover text formatting rulefor value 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.By default the values are formatted using generic number format.

Default: ""
valuesrc string

Sets the source reference on Chart Studio Cloud for value.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the X coordinates of the vertices on X axis.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the Y coordinates of the vertices on Y axis.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the Z coordinates of the vertices on Z axis.

zhoverformat string

Sets the hover text formatting rulefor z 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.46By default the values are formatted using zaxis.hoverformat.

Default: ""
zsrc string

Sets the source reference on Chart Studio Cloud for z.

Mesh3d object

A schema to validate plotly trace properties

type const: "mesh3d" required
Constant: "mesh3d"
alphahull query-string | number

Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the x, y and z arrays, if the i, j, k arrays are not supplied. For general use of mesh3d it is preferred that i, j, k are supplied. If -1, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to delaunayaxis. In case the delaunayaxis intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of delaunayaxis. If >0, the alpha-shape algorithm is used. In this case, the positive alphahull value signals the use of the alpha-shape algorithm, and its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the x, y and z point set into a convex hull.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here intensity) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as intensity and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as intensity. Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as intensity and if set, cmax must be set as well.

Sets the color of the whole mesh

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

contour object
3 nested properties

Sets the color of the contour lines.

show query-string | boolean

Sets whether or not dynamic contours are shown on hover

width query-string | number

Sets the width of the contour lines.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

delaunayaxis query-string | enum

Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if i, j, k are not provided and alphahull is set to indicate Delaunay triangulation.

facecolor query-string | number | string[]

Sets the color of each face Overrides color and vertexcolor.

facecolorsrc string

Sets the source reference on Chart Studio Cloud for facecolor.

flatshading query-string | boolean

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

i query-string | number | string[]

A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the first vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where i[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in i represents a point in space, which is the first vertex of a triangle.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

intensity query-string | number | string[]

Sets the intensity values for vertices or cells as defined by intensitymode. It can be used for plotting fields on meshes.

intensitymode query-string | enum

Determines the source of intensity values.

intensitysrc string

Sets the source reference on Chart Studio Cloud for intensity.

isrc string

Sets the source reference on Chart Studio Cloud for i.

j query-string | number | string[]

A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the second vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where j[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in j represents a point in space, which is the second vertex of a triangle.

jsrc string

Sets the source reference on Chart Studio Cloud for j.

k query-string | number | string[]

A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the third vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where k[m] = n points to the triplet {x[n], y[n], z[n]} in the vertex arrays. Therefore, each element in k represents a point in space, which is the third vertex of a triangle.

ksrc string

Sets the source reference on Chart Studio Cloud for k.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lighting object
7 nested properties
ambient query-string | number

Ambient light increases overall color visibility but can wash out the image.

diffuse query-string | number

Represents the extent that incident rays are reflected in a range of angles.

facenormalsepsilon query-string | number

Epsilon for face normals calculation avoids math issues arising from degenerate geometry.

fresnel query-string | number

Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.

roughness query-string | number

Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.

specular query-string | number

Represents the level that incident rays are reflected in a single direction, causing shine.

vertexnormalsepsilon query-string | number

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition object
3 nested properties
x query-string | number

Numeric vector, representing the X coordinate for each vertex.

y query-string | number

Numeric vector, representing the Y coordinate for each vertex.

z query-string | number

Numeric vector, representing the Z coordinate for each vertex.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

scene query-string | string

Sets a reference between this trace's 3D coordinate system and a 3D scene. If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets the text elements associated with the vertices. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

vertexcolor query-string | number | string[]

Sets the color of each vertex Overrides color. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.

vertexcolorsrc string

Sets the source reference on Chart Studio Cloud for vertexcolor.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the X coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the Y coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the Z coordinates of the vertices. The nth element of vectors x, y and z jointly represent the X, Y and Z coordinates of the nth vertex.

zcalendar query-string | enum

Sets the calendar system to use with z date data.

zhoverformat string

Sets the hover text formatting rulefor z 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.46By default the values are formatted using zaxis.hoverformat.

Default: ""
zsrc string

Sets the source reference on Chart Studio Cloud for z.

Ohlc object

A schema to validate plotly trace properties

type const: "ohlc" required
Constant: "ohlc"
close query-string | number | string[]

Sets the close values.

closesrc string

Sets the source reference on Chart Studio Cloud for close.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

decreasing object
1 nested properties
line object
3 nested properties

Sets the line color.

dash string

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

Default: "solid"
width query-string | number

Sets the line width (in px).

high query-string | number | string[]

Sets the high values.

highsrc string

Sets the source reference on Chart Studio Cloud for high.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
10 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

split query-string | boolean

Show hover information (open, close, high, low) in separate labels.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

increasing object
1 nested properties
line object
3 nested properties

Sets the line color.

dash string

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

Default: "solid"
width query-string | number

Sets the line width (in px).

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
2 nested properties
dash string

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). Note that this style setting can also be set per direction via increasing.line.dash and decreasing.line.dash.

Default: "solid"
width query-string | number

[object Object] Note that this style setting can also be set per direction via increasing.line.width and decreasing.line.width.

low query-string | number | string[]

Sets the low values.

lowsrc string

Sets the source reference on Chart Studio Cloud for low.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

open query-string | number | string[]

Sets the open values.

opensrc string

Sets the source reference on Chart Studio Cloud for open.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

tickwidth query-string | number

Sets the width of the open/close tick marks relative to the x minimal interval.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the x coordinates. If absent, linear coordinate will be generated.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Parcats object

A schema to validate plotly trace properties

type const: "parcats" required
Constant: "parcats"
arrangement query-string | enum

Sets the drag interaction mode for categories and dimensions. If perpendicular, the categories can only move along a line perpendicular to the paths. If freeform, the categories can freely move on the plane. If fixed, the categories and dimensions are stationary.

bundlecolors query-string | boolean

Sort paths so that like colors are bundled together within each category.

counts query-string | number | query-string | number[]

The number of observations represented by each state. Defaults to 1 so that each state represents one observation

countssrc string

Sets the source reference on Chart Studio Cloud for counts.

dimensions object[]
minItems=1
domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this parcats trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this parcats trace .

x query-string | query-string | number[]

Sets the horizontal domain of this parcats trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this parcats trace (in plot fraction).

hoverinfo query-string | string | string

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoveron query-string | enum

Sets the hover interaction mode for the parcats diagram. If category, hover interaction take place per category. If color, hover interactions take place per color per category. If dimension, hover interactions take place across all categories per dimension.

hovertemplate string

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. This value here applies when hovering over dimensions. Note that *categorycount, colorcount and bandcolorcount are only available when hoveron contains the color flagFinally, the template string has access to variables count, probability, category, categorycount, colorcount and bandcolorcount. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

Default: ""
labelfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
14 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by line.colorscale. Has an effect only if in line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in line.color) or the bounds set in line.cmin and line.cmax Has an effect only if in line.color is set to a numerical array. Defaults to false when line.cmin and line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling line.cmin and/or line.cmax to be equidistant to this point. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color. Has no effect when line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to line.cmin and line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use line.cmin and line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

hovertemplate string

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. This value here applies when hovering over lines.Finally, the template string has access to variables count and probability. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

Default: ""
reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in line.color is set to a numerical array. If true, line.cmin will correspond to the last color in the array and line.cmax will correspond to the first color.

shape query-string | enum

Sets the shape of the paths. If linear, paths are composed of straight lines. If hspline, paths are composed of horizontal curved splines

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in line.color is set to a numerical array.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

sortpaths query-string | enum

Sets the path sorting algorithm. If forward, sort paths based on dimension categories from left to right. If backward, sort paths based on dimensions categories from right to left.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "auto"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Parcoords object

A schema to validate plotly trace properties

type const: "parcoords" required
Constant: "parcoords"
customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dimensions object[]
minItems=1
domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this parcoords trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this parcoords trace .

x query-string | query-string | number[]

Sets the horizontal domain of this parcoords trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this parcoords trace (in plot fraction).

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

labelangle query-string | number

Sets the angle of the labels with respect to the horizontal. For example, a tickangle of -90 draws the labels vertically. Tilted labels with labelangle may be positioned better inside margins when labelposition is set to bottom.

labelfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

labelside query-string | enum

Specifies the location of the label. top positions labels above, next to the title bottom positions labels below the graph Tilted labels with labelangle may be positioned better inside margins when labelposition is set to bottom.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by line.colorscale. Has an effect only if in line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in line.color) or the bounds set in line.cmin and line.cmax Has an effect only if in line.color is set to a numerical array. Defaults to false when line.cmin and line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling line.cmin and/or line.cmax to be equidistant to this point. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color. Has no effect when line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to line.cmin and line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use line.cmin and line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in line.color is set to a numerical array. If true, line.cmin will correspond to the last color in the array and line.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in line.color is set to a numerical array.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

rangefont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "auto"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
line object
2 nested properties

Sets the base color of unselected lines. in connection with unselected.line.opacity.

opacity query-string | number

Sets the opacity of unselected lines. The default auto decreases the opacity smoothly as the number of lines increases. Use 1 to achieve exact unselected.line.color.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Pie object

A schema to validate plotly trace properties

type const: "pie" required
Constant: "pie"
automargin query-string | boolean

Determines whether outside text labels can push the margins.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

direction query-string | enum

Specifies the direction at which succeeding sectors follow one another.

dlabel query-string | number

Sets the label step. See label0 for more info.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this pie trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this pie trace .

x query-string | query-string | number[]

Sets the horizontal domain of this pie trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this pie trace (in plot fraction).

hole query-string | number

Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

insidetextorientation query-string | enum

Controls the orientation of the text inside chart sectors. When set to auto, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The horizontal option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The radial option orients text along the radius of the sector. The tangential option orients text perpendicular to the radius of the sector.

label0 query-string | number

Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

labels query-string | number | string[]

Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

labelssrc string

Sets the source reference on Chart Studio Cloud for labels.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
4 nested properties
colors query-string | number | string[]

Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.

colorssrc string

Sets the source reference on Chart Studio Cloud for colors.

line object
4 nested properties
color query-string | color | query-string | color[]

Sets the color of the line enclosing each sector.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the line enclosing each sector.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

outsidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

pull query-string | number | query-string | number[]

Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.

pullsrc string

Sets the source reference on Chart Studio Cloud for pull.

rotation query-string | number

Instead of the first slice starting at 12 o'clock, rotate to some other angle.

scalegroup string

If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

Default: ""
showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

sort query-string | boolean

Determines whether or not the sectors are reordered from largest to smallest.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets text elements associated with each sector. If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textinfo query-string | string | string

Determines which trace information appear on the graph.

textposition query-string | enum | query-string | enum[]

Specifies the location of the textinfo.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables label, color, value, percent and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

title object
3 nested properties
font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

position query-string | enum

Specifies the location of the title.

text string

Sets the title of the chart. If it is empty, no title is displayed.

Default: ""
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

values query-string | number | string[]

Sets the values of the sectors. If omitted, we count occurrences of each label.

valuessrc string

Sets the source reference on Chart Studio Cloud for values.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Sankey object

A schema to validate plotly trace properties

type const: "sankey" required
Constant: "sankey"
arrangement query-string | enum

If value is snap (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via nodepad. If value is perpendicular, the nodes can only move along a line perpendicular to the flow. If value is freeform, the nodes can freely move on the plane. If value is fixed, the nodes are stationary.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this sankey trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this sankey trace .

x query-string | query-string | number[]

Sets the horizontal domain of this sankey trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this sankey trace (in plot fraction).

hoverinfo query-string | string | string

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired. Note that this attribute is superseded by node.hoverinfo and node.hoverinfo for nodes and links respectively.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

link object
21 nested properties
arrowlen query-string | number

Sets the length (in px) of the links arrow, if 0 no arrow will be drawn.

color query-string | color | query-string | color[]

Sets the link color. It can be a single value, or an array for specifying color for each link. If link.color is omitted, then by default, a translucent grey link will be used.

colorscales object[]
minItems=1
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

customdata query-string | number | string[]

Assigns extra data to each link.

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

hovercolor query-string | color | query-string | color[]

Sets the link hover color. It can be a single value, or an array for specifying hover colors for each link. If link.hovercolor is omitted, then by default, links will become slightly more opaque when hovered over.

hovercolorsrc string

Sets the source reference on Chart Studio Cloud for hovercolor.

hoverinfo query-string | enum

Determines which trace information appear when hovering links. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Variables source and target are node objects.Finally, the template string has access to variables value and label. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

label query-string | number | string[]

The shown name of the link.

labelsrc string

Sets the source reference on Chart Studio Cloud for label.

line object
4 nested properties
color query-string | color | query-string | color[]

Sets the color of the line around each link.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the line around each link.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

source query-string | number | string[]

An integer number [0..nodes.length - 1] that represents the source node.

sourcesrc string

Sets the source reference on Chart Studio Cloud for source.

target query-string | number | string[]

An integer number [0..nodes.length - 1] that represents the target node.

targetsrc string

Sets the source reference on Chart Studio Cloud for target.

value query-string | number | string[]

A numeric value representing the flow volume value.

valuesrc string

Sets the source reference on Chart Studio Cloud for value.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

node object
19 nested properties
align query-string | enum

Sets the alignment method used to position the nodes along the horizontal axis.

color query-string | color | query-string | color[]

Sets the node color. It can be a single value, or an array for specifying color for each node. If node.color is omitted, then the default Plotly color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

customdata query-string | number | string[]

Assigns extra data to each node.

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

groups query-string | query-string | number[]

Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.

hoverinfo query-string | enum

Determines which trace information appear when hovering nodes. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Variables sourceLinks and targetLinks are arrays of link objects.Finally, the template string has access to variables value and label. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

label query-string | number | string[]

The shown name of the node.

labelsrc string

Sets the source reference on Chart Studio Cloud for label.

line object
4 nested properties
color query-string | color | query-string | color[]

Sets the color of the line around each node.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the line around each node.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

pad query-string | number

Sets the padding (in px) between the nodes.

thickness query-string | number

Sets the thickness (in px) of the nodes.

x query-string | number | string[]

The normalized horizontal position of the node.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

The normalized vertical position of the node.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

orientation query-string | enum

Sets the orientation of the Sankey diagram.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
textfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "auto"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

valueformat string

Sets the value 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.

Default: ".3s"
valuesuffix string

Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

Default: ""
visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Scatter object

A schema to validate plotly trace properties

type const: "scatter" required
Constant: "scatter"
alignmentgroup string

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

Default: ""
cliponaxis query-string | boolean

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Sets the x coordinate step. See x0 for more info.

dy query-string | number

Sets the y coordinate step. See y0 for more info.

error_x object
15 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

copy_ystyle query-string | boolean
symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y object
14 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

fill query-string | enum

Sets the area to fill with a solid color. Defaults to none unless this trace is stacked, then it gets tonexty (tonextx) if orientation is v (h) Use with fillcolor if not none. tozerox and tozeroy fill to x=0 and y=0 respectively. tonextx and tonexty fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like tozerox and tozeroy. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.

fillgradient object
4 nested properties
colorscale query-string | colorscale

Sets the fill gradient colors as a color scale. The color scale is interpreted as a gradient applied in the direction specified by orientation, from the lowest to the highest value of the scatter plot along that axis, or from the center to the most distant point from it, if orientation is radial.

start query-string | number

Sets the gradient start value. It is given as the absolute position on the axis determined by the orientation. E.g., if orientation is horizontal, the gradient will be horizontal and start from the x-position given by start. If omitted, the gradient starts at the lowest value of the trace along the respective axis. Ignored if orientation is radial.

stop query-string | number

Sets the gradient end value. It is given as the absolute position on the axis determined by the orientation. E.g., if orientation is horizontal, the gradient will be horizontal and end at the x-position given by end. If omitted, the gradient ends at the highest value of the trace along the respective axis. Ignored if orientation is radial.

type query-string | enum

Sets the type/orientation of the color gradient for the fill. Defaults to none.

fillpattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

groupnorm query-string | enum

Only relevant when stackgroup is used, and only the first groupnorm found in the stackgroup will be used - including if visible is legendonly but not if it is false. Sets the normalization for the sum of this stackgroup. With fraction, the value of each trace at each location is divided by the sum of all trace values at that location. percent is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple stackgroups on one subplot, each will be normalized within its own set.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoveron query-string | string

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is toself or tonext and there are no markers or text, then the default is fills, otherwise it is points.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
8 nested properties
backoff query-string | number | query-string | number[]

Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With auto the lines would trim before markers if marker.angleref is set to previous.

backoffsrc string

Sets the source reference on Chart Studio Cloud for backoff.

Sets the line color.

dash string

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

Default: "solid"
shape query-string | enum

Determines the line shape. With spline the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

simplify query-string | boolean

Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.

smoothing query-string | number

Has an effect only if shape is set to spline Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a linear shape).

width query-string | number

Sets the line width (in px).

marker object
29 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

angleref query-string | enum

Sets the reference for marker angle. With previous, angle 0 points along the line from the previous point to this one. With up, angle 0 points toward the top of the screen.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

gradient object
4 nested properties
color query-string | color | query-string | color[]

Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

type query-string | enum | query-string | enum[]

Sets the type of gradient used to fill the markers

typesrc string

Sets the source reference on Chart Studio Cloud for type.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

maxdisplayed query-string | number

Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

standoff query-string | number | query-string | number[]

Moves the marker away from the data point in the direction of angle (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

standoffsrc string

Sets the source reference on Chart Studio Cloud for standoff.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

offsetgroup string

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

Default: ""
opacity query-string | number

Sets the opacity of the trace.

orientation query-string | enum

Only relevant in the following cases: 1. when scattermode is set to group. 2. when stackgroup is used, and only the first orientation found in the stackgroup will be used - including if visible is legendonly but not if it is false. Sets the stacking direction. With v (h), the y (x) values of subsequent traces are added. Also affects the default value of fill.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stackgaps query-string | enum

Only relevant when stackgroup is used, and only the first stackgaps found in the stackgroup will be used - including if visible is legendonly but not if it is false. Determines how we handle locations at which other traces in this group have data but this one does not. With infer zero we insert a zero at these locations. With interpolate we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.

stackgroup string

Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if orientation is h). If blank or omitted this trace will not be stacked. Stacking also turns fill on by default, using tonexty (tonextx) if orientation is h (v) and sets the default mode to lines irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

Default: ""
stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the x coordinates.

x0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates.

y0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Scatter3d object

A schema to validate plotly trace properties

type const: "scatter3d" required
Constant: "scatter3d"
connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

error_x object
15 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

copy_zstyle query-string | boolean
symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y object
15 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

copy_zstyle query-string | boolean
symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_z object
14 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
14 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by line.colorscale. Has an effect only if in line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in line.color) or the bounds set in line.cmin and line.cmax Has an effect only if in line.color is set to a numerical array. Defaults to false when line.cmin and line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling line.cmin and/or line.cmax to be equidistant to this point. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color. Has no effect when line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to line.cmin and line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use line.cmin and line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

dash query-string | enum

Sets the dash style of the lines.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in line.color is set to a numerical array. If true, line.cmin will correspond to the last color in the array and line.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in line.color is set to a numerical array.

width query-string | number

Sets the line width (in px).

marker object
21 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

line object
11 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number

Sets the width (in px) of the lines bounding the marker points.

opacity query-string | number

Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set marker.color to an rgba color and use its alpha channel.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

projection object
3 nested properties
x object
3 nested properties
opacity query-string | number

Sets the projection color.

scale query-string | number

Sets the scale factor determining the size of the projection marker points.

show query-string | boolean

Sets whether or not projections are shown along the x axis.

y object
3 nested properties
opacity query-string | number

Sets the projection color.

scale query-string | number

Sets the scale factor determining the size of the projection marker points.

show query-string | boolean

Sets whether or not projections are shown along the y axis.

z object
3 nested properties
opacity query-string | number

Sets the projection color.

scale query-string | number

Sets the scale factor determining the size of the projection marker points.

show query-string | boolean

Sets whether or not projections are shown along the z axis.

scene query-string | string

Sets a reference between this trace's 3D coordinate system and a 3D scene. If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
surfaceaxis query-string | enum

If -1, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

surfacecolor query-string | color

Sets the surface fill color.

text string | string[]

Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
12 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the x coordinates.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the z coordinates.

zcalendar query-string | enum

Sets the calendar system to use with z date data.

zhoverformat string

Sets the hover text formatting rulefor z 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.46By default the values are formatted using zaxis.hoverformat.

Default: ""
zsrc string

Sets the source reference on Chart Studio Cloud for z.

Scattercarpet object

A schema to validate plotly trace properties

type const: "scattercarpet" required
Constant: "scattercarpet"
a query-string | number | string[]

Sets the a-axis coordinates.

asrc string

Sets the source reference on Chart Studio Cloud for a.

b query-string | number | string[]

Sets the b-axis coordinates.

bsrc string

Sets the source reference on Chart Studio Cloud for b.

carpet string

An identifier for this carpet, so that scattercarpet and contourcarpet traces can specify a carpet plot on which they lie

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

fill query-string | enum

Sets the area to fill with a solid color. Use with fillcolor if not none. scatterternary has a subset of the options available to scatter. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoveron query-string | string

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is toself or tonext and there are no markers or text, then the default is fills, otherwise it is points.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
7 nested properties
backoff query-string | number | query-string | number[]

Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With auto the lines would trim before markers if marker.angleref is set to previous.

backoffsrc string

Sets the source reference on Chart Studio Cloud for backoff.

Sets the line color.

dash string

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

Default: "solid"
shape query-string | enum

Determines the line shape. With spline the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

smoothing query-string | number

Has an effect only if shape is set to spline Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a linear shape).

width query-string | number

Sets the line width (in px).

marker object
29 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

angleref query-string | enum

Sets the reference for marker angle. With previous, angle 0 points along the line from the previous point to this one. With up, angle 0 points toward the top of the screen.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

gradient object
4 nested properties
color query-string | color | query-string | color[]

Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

type query-string | enum | query-string | enum[]

Sets the type of gradient used to fill the markers

typesrc string

Sets the source reference on Chart Studio Cloud for type.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

maxdisplayed query-string | number

Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

standoff query-string | number | query-string | number[]

Moves the marker away from the data point in the direction of angle (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

standoffsrc string

Sets the source reference on Chart Studio Cloud for standoff.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Scattergeo object

A schema to validate plotly trace properties

type const: "scattergeo" required
Constant: "scattergeo"
connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

featureidkey string

Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example properties.name.

Default: "id"
fill query-string | enum

Sets the area to fill with a solid color. Use with fillcolor if not none. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

geo query-string | string

Sets a reference between this trace's geospatial coordinates and a geographic map. If geo (the default value), the geospatial coordinates refer to layout.geo. If geo2, the geospatial coordinates refer to layout.geo2, and so on.

geojson

Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when locations is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type FeatureCollection or Feature with geometries of type Polygon or MultiPolygon.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (lon,lat) pair or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or locations coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

lat query-string | number | string[]

Sets the latitude coordinates (in degrees North).

latsrc string

Sets the source reference on Chart Studio Cloud for lat.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
3 nested properties

Sets the line color.

dash string

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

Default: "solid"
width query-string | number

Sets the line width (in px).

locationmode query-string | enum

Determines the set of locations used to match entries in locations to regions on the map. Values ISO-3, USA-states, country names correspond to features on the base map and value geojson-id corresponds to features from a custom GeoJSON linked to the geojson attribute.

locations query-string | number | string[]

Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See locationmode for more info.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

lon query-string | number | string[]

Sets the longitude coordinates (in degrees East).

lonsrc string

Sets the source reference on Chart Studio Cloud for lon.

marker object
28 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

angleref query-string | enum

Sets the reference for marker angle. With previous, angle 0 points along the line from the previous point to this one. With up, angle 0 points toward the top of the screen. With north, angle 0 points north based on the current map projection.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

gradient object
4 nested properties
color query-string | color | query-string | color[]

Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

type query-string | enum | query-string | enum[]

Sets the type of gradient used to fill the markers

typesrc string

Sets the source reference on Chart Studio Cloud for type.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

standoff query-string | number | query-string | number[]

Moves the marker away from the data point in the direction of angle (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

standoffsrc string

Sets the source reference on Chart Studio Cloud for standoff.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (lon,lat) pair or item in locations. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or locations coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon, location and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Scattergl object

A schema to validate plotly trace properties

type const: "scattergl" required
Constant: "scattergl"
connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dx query-string | number

Sets the x coordinate step. See x0 for more info.

dy query-string | number

Sets the y coordinate step. See y0 for more info.

error_x object
15 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

copy_ystyle query-string | boolean
symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

error_y object
14 nested properties
array query-string | number | string[]

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

arrayminus query-string | number | string[]

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

arrayminussrc string

Sets the source reference on Chart Studio Cloud for arrayminus.

arraysrc string

Sets the source reference on Chart Studio Cloud for array.

Sets the stroke color of the error bars.

symmetric query-string | boolean

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

thickness query-string | number

Sets the thickness (in px) of the error bars.

traceref query-string | integer
tracerefminus query-string | integer
type query-string | enum

Determines the rule used to generate the error bars. If *constant, the bar lengths are of a constant value. Set this constant in value. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set array`.

value query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars.

valueminus query-string | number

Sets the value of either the percentage (if type is set to percent) or the constant (if type is set to constant) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

visible query-string | boolean

Determines whether or not this set of error bars is visible.

width query-string | number

Sets the width (in px) of the cross-bar at both ends of the error bars.

fill query-string | enum

Sets the area to fill with a solid color. Defaults to none unless this trace is stacked, then it gets tonexty (tonextx) if orientation is v (h) Use with fillcolor if not none. tozerox and tozeroy fill to x=0 and y=0 respectively. tonextx and tonexty fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like tozerox and tozeroy. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
4 nested properties

Sets the line color.

dash query-string | enum

Sets the style of the lines.

shape query-string | enum

Determines the line shape. The values correspond to step-wise line shapes.

width query-string | number

Sets the line width (in px).

marker object
24 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
12 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | enum | query-string | enum[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the x coordinates.

x0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates.

y0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

Scattermap object

A schema to validate plotly trace properties

type const: "scattermap" required
Constant: "scattermap"
below string

Determines if this scattermap trace's layers are to be inserted before the layer with the specified ID. By default, scattermap layers are inserted above all the base layers. To place the scattermap layers above every other layer, set below to ''.

cluster object
10 nested properties
color query-string | color | query-string | color[]

Sets the color for each cluster step.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

enabled query-string | boolean

Determines whether clustering is enabled or disabled.

maxzoom query-string | number

Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

size query-string | number | query-string | number[]

Sets the size for each cluster step.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

step query-string | number | query-string | number[]

Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for size and / or color. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.

stepsrc string

Sets the source reference on Chart Studio Cloud for step.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

fill query-string | enum

Sets the area to fill with a solid color. Use with fillcolor if not none. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

lat query-string | number | string[]

Sets the latitude coordinates (in degrees North).

latsrc string

Sets the source reference on Chart Studio Cloud for lat.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
2 nested properties

Sets the line color.

width query-string | number

Sets the line width (in px).

lon query-string | number | string[]

Sets the longitude coordinates (in degrees East).

lonsrc string

Sets the source reference on Chart Studio Cloud for lon.

marker object
24 nested properties
allowoverlap query-string | boolean

Flag to draw all symbols, even if they overlap.

angle query-string | number | query-string | number[]

Sets the marker orientation from true North, in degrees clockwise. When using the auto default, no rotation would be applied in perspective views which is different from using a zero angle.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

symbol string | string[]

Sets the marker symbol. Full list: https://www.map.com/maki-icons/ Note that the array marker.color and marker.size are only available for circle symbols.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

selected object
1 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a map subplot. If map (the default value), the data refer to layout.map. If map2, the data refer to layout.map2, and so on.

text string | string[]

Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
5 nested properties
family 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.

Default: "Open Sans Regular, Arial Unicode MS Regular"
pattern=.*\S.*$
size query-string | number
style query-string | enum

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

weight query-string | integer

Sets the weight (or boldness) of the font.

textposition query-string | enum

Sets the positions of the text elements with respects to the (x,y) coordinates.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Scattermapbox object

A schema to validate plotly trace properties

type const: "scattermapbox" required
Constant: "scattermapbox"
below string

Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set below to ''.

cluster object
10 nested properties
color query-string | color | query-string | color[]

Sets the color for each cluster step.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

enabled query-string | boolean

Determines whether clustering is enabled or disabled.

maxzoom query-string | number

Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

size query-string | number | query-string | number[]

Sets the size for each cluster step.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

step query-string | number | query-string | number[]

Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for size and / or color. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.

stepsrc string

Sets the source reference on Chart Studio Cloud for step.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

fill query-string | enum

Sets the area to fill with a solid color. Use with fillcolor if not none. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

lat query-string | number | string[]

Sets the latitude coordinates (in degrees North).

latsrc string

Sets the source reference on Chart Studio Cloud for lat.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
2 nested properties

Sets the line color.

width query-string | number

Sets the line width (in px).

lon query-string | number | string[]

Sets the longitude coordinates (in degrees East).

lonsrc string

Sets the source reference on Chart Studio Cloud for lon.

marker object
24 nested properties
allowoverlap query-string | boolean

Flag to draw all symbols, even if they overlap.

angle query-string | number | query-string | number[]

Sets the marker orientation from true North, in degrees clockwise. When using the auto default, no rotation would be applied in perspective views which is different from using a zero angle.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

symbol string | string[]

Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array marker.color and marker.size are only available for circle symbols.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

selected object
1 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

mapbox subplots and traces are deprecated! Please consider switching to map subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace's data coordinates and a mapbox subplot. If mapbox (the default value), the data refer to layout.mapbox. If mapbox2, the data refer to layout.mapbox2, and so on.

text string | string[]

Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
5 nested properties
family 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.

Default: "Open Sans Regular, Arial Unicode MS Regular"
pattern=.*\S.*$
size query-string | number
style query-string | enum

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

weight query-string | integer

Sets the weight (or boldness) of the font.

textposition query-string | enum

Sets the positions of the text elements with respects to the (x,y) coordinates.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables lat, lon and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Scatterpolar object

A schema to validate plotly trace properties

type const: "scatterpolar" required
Constant: "scatterpolar"
cliponaxis query-string | boolean

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dr query-string | number

Sets the r coordinate step.

dtheta query-string | number

Sets the theta coordinate step. By default, the dtheta step equals the subplot's period divided by the length of the r coordinates.

fill query-string | enum

Sets the area to fill with a solid color. Use with fillcolor if not none. scatterpolar has a subset of the options available to scatter. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoveron query-string | string

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is toself or tonext and there are no markers or text, then the default is fills, otherwise it is points.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
7 nested properties
backoff query-string | number | query-string | number[]

Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With auto the lines would trim before markers if marker.angleref is set to previous.

backoffsrc string

Sets the source reference on Chart Studio Cloud for backoff.

Sets the line color.

dash string

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

Default: "solid"
shape query-string | enum

Determines the line shape. With spline the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

smoothing query-string | number

Has an effect only if shape is set to spline Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a linear shape).

width query-string | number

Sets the line width (in px).

marker object
29 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

angleref query-string | enum

Sets the reference for marker angle. With previous, angle 0 points along the line from the previous point to this one. With up, angle 0 points toward the top of the screen.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

gradient object
4 nested properties
color query-string | color | query-string | color[]

Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

type query-string | enum | query-string | enum[]

Sets the type of gradient used to fill the markers

typesrc string

Sets the source reference on Chart Studio Cloud for type.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

maxdisplayed query-string | number

Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

standoff query-string | number | query-string | number[]

Moves the marker away from the data point in the direction of angle (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

standoffsrc string

Sets the source reference on Chart Studio Cloud for standoff.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

r query-string | number | string[]

Sets the radial coordinates

r0

Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

Default: 0
rsrc string

Sets the source reference on Chart Studio Cloud for r.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a polar subplot. If polar (the default value), the data refer to layout.polar. If polar2, the data refer to layout.polar2, and so on.

text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

theta query-string | number | string[]

Sets the angular coordinates

theta0

Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

Default: 0
thetasrc string

Sets the source reference on Chart Studio Cloud for theta.

thetaunit query-string | enum

Sets the unit of input theta values. Has an effect only when on linear angular axes.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Scatterpolargl object

A schema to validate plotly trace properties

type const: "scatterpolargl" required
Constant: "scatterpolargl"
connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

dr query-string | number

Sets the r coordinate step.

dtheta query-string | number

Sets the theta coordinate step. By default, the dtheta step equals the subplot's period divided by the length of the r coordinates.

fill query-string | enum

Sets the area to fill with a solid color. Defaults to none unless this trace is stacked, then it gets tonexty (tonextx) if orientation is v (h) Use with fillcolor if not none. tozerox and tozeroy fill to x=0 and y=0 respectively. tonextx and tonexty fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like tozerox and tozeroy. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
3 nested properties

Sets the line color.

dash query-string | enum

Sets the style of the lines.

width query-string | number

Sets the line width (in px).

marker object
24 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

r query-string | number | string[]

Sets the radial coordinates

r0

Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

Default: 0
rsrc string

Sets the source reference on Chart Studio Cloud for r.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a polar subplot. If polar (the default value), the data refer to layout.polar. If polar2, the data refer to layout.polar2, and so on.

text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
12 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | enum | query-string | enum[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables r, theta and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

theta query-string | number | string[]

Sets the angular coordinates

theta0

Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

Default: 0
thetasrc string

Sets the source reference on Chart Studio Cloud for theta.

thetaunit query-string | enum

Sets the unit of input theta values. Has an effect only when on linear angular axes.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Scattersmith object

A schema to validate plotly trace properties

type const: "scattersmith" required
Constant: "scattersmith"
cliponaxis query-string | boolean

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

fill query-string | enum

Sets the area to fill with a solid color. Use with fillcolor if not none. scattersmith has a subset of the options available to scatter. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoveron query-string | string

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is toself or tonext and there are no markers or text, then the default is fills, otherwise it is points.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

imag query-string | number | string[]

Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

imagsrc string

Sets the source reference on Chart Studio Cloud for imag.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
7 nested properties
backoff query-string | number | query-string | number[]

Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With auto the lines would trim before markers if marker.angleref is set to previous.

backoffsrc string

Sets the source reference on Chart Studio Cloud for backoff.

Sets the line color.

dash string

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

Default: "solid"
shape query-string | enum

Determines the line shape. With spline the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

smoothing query-string | number

Has an effect only if shape is set to spline Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a linear shape).

width query-string | number

Sets the line width (in px).

marker object
29 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

angleref query-string | enum

Sets the reference for marker angle. With previous, angle 0 points along the line from the previous point to this one. With up, angle 0 points toward the top of the screen.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

gradient object
4 nested properties
color query-string | color | query-string | color[]

Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

type query-string | enum | query-string | enum[]

Sets the type of gradient used to fill the markers

typesrc string

Sets the source reference on Chart Studio Cloud for type.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

maxdisplayed query-string | number

Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

standoff query-string | number | query-string | number[]

Moves the marker away from the data point in the direction of angle (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

standoffsrc string

Sets the source reference on Chart Studio Cloud for standoff.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

real query-string | number | string[]

Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.

realsrc string

Sets the source reference on Chart Studio Cloud for real.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a smith subplot. If smith (the default value), the data refer to layout.smith. If smith2, the data refer to layout.smith2, and so on.

text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables real, imag and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Scatterternary object

A schema to validate plotly trace properties

type const: "scatterternary" required
Constant: "scatterternary"
a query-string | number | string[]

Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

asrc string

Sets the source reference on Chart Studio Cloud for a.

b query-string | number | string[]

Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

bsrc string

Sets the source reference on Chart Studio Cloud for b.

c query-string | number | string[]

Sets the quantity of component a in each data point. If a, b, and c are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match ternary<i>.sum.

cliponaxis query-string | boolean

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

csrc string

Sets the source reference on Chart Studio Cloud for c.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

fill query-string | enum

Sets the area to fill with a solid color. Use with fillcolor if not none. scatterternary has a subset of the options available to scatter. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. tonext fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like toself if there is no trace before it. tonext should not be used if one trace does not enclose the other.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoveron query-string | string

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is toself or tonext and there are no markers or text, then the default is fills, otherwise it is points.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

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

textcase query-string | enum

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

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
7 nested properties
backoff query-string | number | query-string | number[]

Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With auto the lines would trim before markers if marker.angleref is set to previous.

backoffsrc string

Sets the source reference on Chart Studio Cloud for backoff.

Sets the line color.

dash string

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

Default: "solid"
shape query-string | enum

Determines the line shape. With spline the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

smoothing query-string | number

Has an effect only if shape is set to spline Sets the amount of smoothing. 0 corresponds to no smoothing (equivalent to a linear shape).

width query-string | number

Sets the line width (in px).

marker object
29 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

angleref query-string | enum

Sets the reference for marker angle. With previous, angle 0 points along the line from the previous point to this one. With up, angle 0 points toward the top of the screen.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

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

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

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

separatethousands query-string | boolean

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

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

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

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

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

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

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

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

gradient object
4 nested properties
color query-string | color | query-string | color[]

Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

type query-string | enum | query-string | enum[]

Sets the type of gradient used to fill the markers

typesrc string

Sets the source reference on Chart Studio Cloud for type.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

maxdisplayed query-string | number

Sets a maximum number of points to be drawn on the graph. 0 corresponds to no limit.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

standoff query-string | number | query-string | number[]

Moves the marker away from the data point in the direction of angle (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

standoffsrc string

Sets the source reference on Chart Studio Cloud for standoff.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

mode query-string | string | string

Determines the drawing mode for this scatter trace. If the provided mode includes text then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is lines+markers. Otherwise, lines.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

selected object
2 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

textfont object
1 nested properties

Sets the text font color of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
subplot query-string | string

Sets a reference between this trace's data coordinates and a ternary subplot. If ternary (the default value), the data refer to layout.ternary. If ternary2, the data refer to layout.ternary2, and so on.

sum query-string | number

The number each triplet should sum to, if only two of a, b, and c are provided. This overrides ternary<i>.sum to normalize this specific trace, but does not affect the values displayed on the axes. 0 (or missing) means to use ternary.sum

text string | string[]

Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

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

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

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

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textposition query-string | enum | query-string | enum[]

Sets the positions of the text elements with respects to the (x,y) coordinates.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables a, b, c and text.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
2 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

textfont object
1 nested properties

Sets the text font color of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Splom object

A schema to validate plotly trace properties

type const: "splom" required
Constant: "splom"
customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

diagonal object
1 nested properties
visible query-string | boolean

Determines whether or not subplots on the diagonal are displayed.

dimensions object[]
minItems=1
hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

marker object
24 nested properties
angle query-string | number | query-string | number[]

Sets the marker angle in respect to angleref.

anglesrc string

Sets the source reference on Chart Studio Cloud for angle.

autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

Sets the width (in px) of the axis line.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

line object
12 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.

color query-string | color | query-string | color[]

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.line.cmin and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.

width query-string | number | query-string | number[]

Sets the width (in px) of the lines bounding the marker points.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

opacity query-string | number | query-string | number[]

Sets the marker opacity.

opacitysrc string

Sets the source reference on Chart Studio Cloud for opacity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.

size query-string | number | query-string | number[]

Sets the marker size (in px).

sizemin query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

sizemode query-string | enum

Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.

sizeref query-string | number

Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

symbol query-string | enum | query-string | enum[]

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

symbolsrc string

Sets the source reference on Chart Studio Cloud for symbol.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

selected object
1 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showlowerhalf query-string | boolean

Determines whether or not subplots on the lower half from the diagonal are displayed.

showupperhalf query-string | boolean

Determines whether or not subplots on the upper half from the diagonal are displayed.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

xaxes query-string | query-string | string[]

Sets the list of x axes corresponding to dimensions of this splom trace. By default, a splom will match the first N xaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
yaxes query-string | query-string | string[]

Sets the list of y axes corresponding to dimensions of this splom trace. By default, a splom will match the first N yaxes where N is the number of input dimensions. Note that, in case where diagonal.visible is false and showupperhalf or showlowerhalf is false, this splom trace will generate one less x-axis and one less y-axis.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
Streamtube object

A schema to validate plotly trace properties

type const: "streamtube" required
Constant: "streamtube"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

Sets the width (in px) of the axis line.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables tubex, tubey, tubez, tubeu, tubev, tubew, norm and divergence. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string

Same as text.

Default: ""
ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lighting object
7 nested properties
ambient query-string | number

Ambient light increases overall color visibility but can wash out the image.

diffuse query-string | number

Represents the extent that incident rays are reflected in a range of angles.

facenormalsepsilon query-string | number

Epsilon for face normals calculation avoids math issues arising from degenerate geometry.

fresnel query-string | number

Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.

roughness query-string | number

Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.

specular query-string | number

Represents the level that incident rays are reflected in a single direction, causing shine.

vertexnormalsepsilon query-string | number

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition object
3 nested properties
x query-string | number

Numeric vector, representing the X coordinate for each vertex.

y query-string | number

Numeric vector, representing the Y coordinate for each vertex.

z query-string | number

Numeric vector, representing the Z coordinate for each vertex.

maxdisplayed query-string | integer

The maximum number of displayed segments in a streamtube.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

scene query-string | string

Sets a reference between this trace's 3D coordinate system and a 3D scene. If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

sizeref query-string | number

The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.

starts object
6 nested properties
x query-string | number | string[]

Sets the x components of the starting position of the streamtubes

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y components of the starting position of the streamtubes

ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the z components of the starting position of the streamtubes

zsrc string

Sets the source reference on Chart Studio Cloud for z.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string

Sets a text element associated with this trace. If trace hoverinfo contains a text flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array text values.

Default: ""
u query-string | number | string[]

Sets the x components of the vector field.

uhoverformat string

Sets the hover text formatting rulefor u 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.By default the values are formatted using generic number format.

Default: ""
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

usrc string

Sets the source reference on Chart Studio Cloud for u.

v query-string | number | string[]

Sets the y components of the vector field.

vhoverformat string

Sets the hover text formatting rulefor v 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.By default the values are formatted using generic number format.

Default: ""
visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

vsrc string

Sets the source reference on Chart Studio Cloud for v.

w query-string | number | string[]

Sets the z components of the vector field.

whoverformat string

Sets the hover text formatting rulefor w 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.By default the values are formatted using generic number format.

Default: ""
wsrc string

Sets the source reference on Chart Studio Cloud for w.

x query-string | number | string[]

Sets the x coordinates of the vector field.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates of the vector field.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the z coordinates of the vector field.

zhoverformat string

Sets the hover text formatting rulefor z 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.46By default the values are formatted using zaxis.hoverformat.

Default: ""
zsrc string

Sets the source reference on Chart Studio Cloud for z.

Sunburst object

A schema to validate plotly trace properties

type const: "sunburst" required
Constant: "sunburst"
branchvalues query-string | enum

Determines how the items in values are summed. When set to total, items in values are taken to be value of all its descendants. When set to remainder, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

count query-string | string

Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this sunburst trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this sunburst trace .

x query-string | query-string | number[]

Sets the horizontal domain of this sunburst trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this sunburst trace (in plot fraction).

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

insidetextorientation query-string | enum

Controls the orientation of the text inside chart sectors. When set to auto, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The horizontal option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The radial option orients text along the radius of the sector. The tangential option orients text perpendicular to the radius of the sector.

labels query-string | number | string[]

Sets the labels of each of the sectors.

labelssrc string

Sets the source reference on Chart Studio Cloud for labels.

leaf object
1 nested properties
opacity query-string | number

Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

level

Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an "id" if ids is filled in, otherwise plotly attempts to find a matching item in labels.

marker object
14 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if colors is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in marker.cmin and marker.cmax Has an effect only if colors is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

Sets the width (in px) of the axis line.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colors query-string | number | string[]

Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorssrc string

Sets the source reference on Chart Studio Cloud for colors.

line object
4 nested properties
color query-string | color | query-string | color[]

Sets the color of the line enclosing each sector. Defaults to the paper_bgcolor value.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the line enclosing each sector.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.

maxdepth query-string | integer

Sets the number of rendered sectors from any given level. Set maxdepth to -1 to render all the levels in the hierarchy.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

outsidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

parents query-string | number | string[]

Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be "ids" themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

parentssrc string

Sets the source reference on Chart Studio Cloud for parents.

root object
1 nested properties

sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.

rotation query-string | number

Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o'clock.

sort query-string | boolean

Determines whether or not the sectors are reordered from largest to smallest.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets text elements associated with each sector. If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textinfo query-string | string | string

Determines which trace information appear on the graph.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

values query-string | number | string[]

Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

valuessrc string

Sets the source reference on Chart Studio Cloud for values.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Surface object

A schema to validate plotly trace properties

type const: "surface" required
Constant: "surface"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as z or surfacecolor. Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

Sets the width (in px) of the axis line.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

connectgaps query-string | boolean

Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in.

contours object
3 nested properties
x object
11 nested properties

Sets the color of the contour lines.

end query-string | number

Sets the end contour level value. Must be more than contours.start

highlight query-string | boolean

Determines whether or not contour lines about the x dimension are highlighted on hover.

highlightcolor query-string | color

Sets the color of the highlighted contour lines.

highlightwidth query-string | number

Sets the width of the highlighted contour lines.

project object
show query-string | boolean

Determines whether or not contour lines about the x dimension are drawn.

size query-string | number

Sets the step between each contour level. Must be positive.

start query-string | number

Sets the starting contour level value. Must be less than contours.end

usecolormap query-string | boolean

An alternate to color. Determines whether or not the contour lines are colored using the trace colorscale.

width query-string | number

Sets the width of the contour lines.

y object
11 nested properties

Sets the color of the contour lines.

end query-string | number

Sets the end contour level value. Must be more than contours.start

highlight query-string | boolean

Determines whether or not contour lines about the y dimension are highlighted on hover.

highlightcolor query-string | color

Sets the color of the highlighted contour lines.

highlightwidth query-string | number

Sets the width of the highlighted contour lines.

project object
show query-string | boolean

Determines whether or not contour lines about the y dimension are drawn.

size query-string | number

Sets the step between each contour level. Must be positive.

start query-string | number

Sets the starting contour level value. Must be less than contours.end

usecolormap query-string | boolean

An alternate to color. Determines whether or not the contour lines are colored using the trace colorscale.

width query-string | number

Sets the width of the contour lines.

z object
11 nested properties

Sets the color of the contour lines.

end query-string | number

Sets the end contour level value. Must be more than contours.start

highlight query-string | boolean

Determines whether or not contour lines about the z dimension are highlighted on hover.

highlightcolor query-string | color

Sets the color of the highlighted contour lines.

highlightwidth query-string | number

Sets the width of the highlighted contour lines.

project object
show query-string | boolean

Determines whether or not contour lines about the z dimension are drawn.

size query-string | number

Sets the step between each contour level. Must be positive.

start query-string | number

Sets the starting contour level value. Must be less than contours.end

usecolormap query-string | boolean

An alternate to color. Determines whether or not the contour lines are colored using the trace colorscale.

width query-string | number

Sets the width of the contour lines.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

hidesurface query-string | boolean

Determines whether or not a surface is drawn. For example, set hidesurface to false contours.x.show to true and contours.y.show to true to draw a wire frame plot.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lighting object
5 nested properties
ambient query-string | number

Ambient light increases overall color visibility but can wash out the image.

diffuse query-string | number

Represents the extent that incident rays are reflected in a range of angles.

fresnel query-string | number

Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.

roughness query-string | number

Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.

specular query-string | number

Represents the level that incident rays are reflected in a single direction, causing shine.

lightposition object
3 nested properties
x query-string | number

Numeric vector, representing the X coordinate for each vertex.

y query-string | number

Numeric vector, representing the Y coordinate for each vertex.

z query-string | number

Numeric vector, representing the Z coordinate for each vertex.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

opacityscale

Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

scene query-string | string

Sets a reference between this trace's 3D coordinate system and a 3D scene. If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
surfacecolor query-string | number | string[]

Sets the surface color values, used for setting a color scale independent of z.

surfacecolorsrc string

Sets the source reference on Chart Studio Cloud for surfacecolor.

text string | string[]

Sets the text elements associated with each z value. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the x coordinates.

xcalendar query-string | enum

Sets the calendar system to use with x date data.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates.

ycalendar query-string | enum

Sets the calendar system to use with y date data.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the z coordinates.

zcalendar query-string | enum

Sets the calendar system to use with z date data.

zhoverformat string

Sets the hover text formatting rulefor z 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.46By default the values are formatted using zaxis.hoverformat.

Default: ""
zsrc string

Sets the source reference on Chart Studio Cloud for z.

Treemap object

A schema to validate plotly trace properties

type const: "treemap" required
Constant: "treemap"
branchvalues query-string | enum

Determines how the items in values are summed. When set to total, items in values are taken to be value of all its descendants. When set to remainder, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.

count query-string | string

Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

domain object
4 nested properties
column query-string | integer

If there is a layout grid, use the domain for this column in the grid for this treemap trace .

row query-string | integer

If there is a layout grid, use the domain for this row in the grid for this treemap trace .

x query-string | query-string | number[]

Sets the horizontal domain of this treemap trace (in plot fraction).

y query-string | query-string | number[]

Sets the vertical domain of this treemap trace (in plot fraction).

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

labels query-string | number | string[]

Sets the labels of each of the sectors.

labelssrc string

Sets the source reference on Chart Studio Cloud for labels.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

level

Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an "id" if ids is filled in, otherwise plotly attempts to find a matching item in labels.

marker object
17 nested properties
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if colors is set to a numerical array. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in marker.cmin and marker.cmax Has an effect only if colors is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect when marker.cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

Sets the width (in px) of the axis line.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colors query-string | number | string[]

Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.

colorscale query-string | colorscale

Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use marker.cmin and marker.cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

colorssrc string

Sets the source reference on Chart Studio Cloud for colors.

cornerradius query-string | number

Sets the maximum rounding of corners (in px).

depthfade query-string | enum

Determines if the sector colors are faded towards the background from the leaves up to the headers. This option is unavailable when a colorscale is present, defaults to false when marker.colors is set, but otherwise defaults to true. When set to reversed, the fading direction is inverted, that is the top elements within hierarchy are drawn with fully saturated colors while the leaves are faded towards the background color.

line object
4 nested properties
color query-string | color | query-string | color[]

Sets the color of the line enclosing each sector. Defaults to the paper_bgcolor value.

colorsrc string

Sets the source reference on Chart Studio Cloud for color.

width query-string | number | query-string | number[]

Sets the width (in px) of the line enclosing each sector.

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

pad object
4 nested properties
b query-string | number

Sets the padding form the bottom (in px).

l query-string | number

Sets the padding form the left (in px).

r query-string | number

Sets the padding form the right (in px).

t query-string | number

Sets the padding form the top (in px).

pattern object
12 nested properties
bgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of background pattern fill. Defaults to a marker.color background when fillmode is overlay. Otherwise, defaults to a transparent background.

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

fgcolor query-string | color | query-string | color[]

When there is no colorscale sets the color of foreground pattern fill. Defaults to a marker.color background when fillmode is replace. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

fgcolorsrc string

Sets the source reference on Chart Studio Cloud for fgcolor.

fgopacity query-string | number

Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

fillmode query-string | enum

Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

shape query-string | enum | query-string | enum[]

Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

shapesrc string

Sets the source reference on Chart Studio Cloud for shape.

size query-string | number | query-string | number[]

Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

sizesrc string

Sets the source reference on Chart Studio Cloud for size.

solidity query-string | number | query-string | number[]

Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

soliditysrc string

Sets the source reference on Chart Studio Cloud for solidity.

reversescale query-string | boolean

Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.

maxdepth query-string | integer

Sets the number of rendered sectors from any given level. Set maxdepth to -1 to render all the levels in the hierarchy.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the trace.

outsidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

parents query-string | number | string[]

Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be "ids" themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.

parentssrc string

Sets the source reference on Chart Studio Cloud for parents.

pathbar object
5 nested properties
edgeshape query-string | enum

Determines which shape is used for edges between barpath labels.

side query-string | enum

Determines on which side of the the treemap the pathbar should be presented.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

thickness query-string | number

Sets the thickness of pathbar (in px). If not specified the pathbar.textfont.size is used with 3 pixles extra padding on each side.

visible query-string | boolean

Determines if the path bar is drawn i.e. outside the trace domain and with one pixel gap.

root object
1 nested properties

sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.

sort query-string | boolean

Determines whether or not the sectors are reordered from largest to smallest.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text query-string | number | string[]

Sets text elements associated with each sector. If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textinfo query-string | string | string

Determines which trace information appear on the graph.

textposition query-string | enum

Sets the positions of the text elements.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

tiling object
4 nested properties
flip query-string | string

Determines if the positions obtained from solver are flipped on each axis.

packing query-string | enum

Determines d3 treemap solver. For more info please refer to https://github.com/d3/d3-hierarchy#treemap-tiling

pad query-string | number

Sets the inner padding (in px).

squarifyratio query-string | number

When using squarify packing algorithm, according to https://github.com/d3/d3-hierarchy/blob/v3.1.1/README.md#squarify_ratio this option specifies the desired aspect ratio of the generated rectangles. The ratio must be specified as a number greater than or equal to one. Note that the orientation of the generated rectangles (tall or wide) is not implied by the ratio; for example, a ratio of two will attempt to produce a mixture of rectangles whose width:height ratio is either 2:1 or 1:2. When using squarify, unlike d3 which uses the Golden Ratio i.e. 1.618034, Plotly applies 1 to increase squares in treemap layouts.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

values query-string | number | string[]

Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

valuessrc string

Sets the source reference on Chart Studio Cloud for values.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Violin object

A schema to validate plotly trace properties

type const: "violin" required
Constant: "violin"
alignmentgroup string

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

Default: ""
bandwidth query-string | number

Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.

box object
4 nested properties
fillcolor query-string | color

Sets the inner box plot fill color.

line object
2 nested properties

Sets the inner box plot bounding line color.

width query-string | number

Sets the inner box plot bounding line width.

visible query-string | boolean

Determines if an miniature box plot is drawn inside the violins.

width query-string | number

Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

fillcolor query-string | color

Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hoveron query-string | string | string

Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

jitter query-string | number

Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

line object
2 nested properties

Sets the color of line bounding the violin(s).

width query-string | number

Sets the width (in px) of line bounding the violin(s).

marker object
7 nested properties
angle query-string | number

Sets the marker angle in respect to angleref.

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.

line object
4 nested properties

Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.

outliercolor query-string | color

Sets the border line color of the outlier sample points. Defaults to marker.color

outlierwidth query-string | number

Sets the border line width (in px) of the outlier sample points.

width query-string | number

Sets the width (in px) of the lines bounding the marker points.

opacity query-string | number

Sets the marker opacity.

outliercolor query-string | color

Sets the color of the outlier sample points.

size query-string | number

Sets the marker size (in px).

symbol query-string | enum

Sets the marker symbol type. Adding 100 is equivalent to appending -open to a symbol name. Adding 200 is equivalent to appending -dot to a symbol name. Adding 300 is equivalent to appending -open-dot or dot-open to a symbol name.

meanline object
3 nested properties

Sets the mean line color.

visible query-string | boolean

Determines if a line corresponding to the sample's mean is shown inside the violins. If box.visible is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.

width query-string | number

Sets the mean line width.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute scalegroup (please see its description for details).

offsetgroup string

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

Default: ""
opacity query-string | number

Sets the opacity of the trace.

orientation query-string | enum

Sets the orientation of the violin(s). If v (h), the distribution is visualized along the vertical (horizontal).

pointpos query-string | number

Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

points query-string | enum

If outliers, only the sample points lying outside the whiskers are shown If suspectedoutliers, the outlier points are shown and points either less than 4Q1-3Q3 or greater than 4Q3-3Q1 are highlighted (see outliercolor) If all, all sample points are shown If false, only the violins are shown with no sample points. Defaults to suspectedoutliers when marker.outliercolor or marker.line.outliercolor is set, otherwise defaults to outliers.

quartilemethod query-string | enum

Sets the method used to compute the sample's Q1 and Q3 quartiles. The linear method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The exclusive method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The inclusive method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

scalegroup string

If there are multiple violins that should be sized according to to some metric (see scalemode), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's width is undefined, scalegroup will default to the trace's name. In this case, violins with the same names will be linked together

Default: ""
scalemode query-string | enum

Sets the metric by which the width of each violin is determined. width means each violin has the same (max) width count means the violins are scaled by the number of sample points making up each violin.

selected object
1 nested properties
marker object
3 nested properties

Sets the marker color of selected points.

opacity query-string | number

Sets the marker opacity of selected points.

size query-string | number

Sets the marker size of selected points.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

side query-string | enum

Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under overlay mode, where one trace has side set to positive and the other to negative.

span query-string | array

Sets the span in data space for which the density function will be computed. Has an effect only when spanmode is set to manual.

spanmode query-string | enum

Sets the method by which the span in data space where the density function will be computed. soft means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. hard means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode manual and fill in the span attribute.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

unselected object
1 nested properties
marker object
3 nested properties

Sets the marker color of unselected points, applied only when a selection exists.

opacity query-string | number

Sets the marker opacity of unselected points, applied only when a selection exists.

size query-string | number

Sets the marker size of unselected points, applied only when a selection exists.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width query-string | number

Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.

x query-string | number | string[]

Sets the x sample data or coordinates. See overview for more info.

x0

Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y sample data or coordinates. See overview for more info.

y0

Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

Volume object

A schema to validate plotly trace properties

type const: "volume" required
Constant: "volume"
autocolorscale query-string | boolean

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. In case colorscale is unspecified or autocolorscale is true, the default palette will be chosen according to whether numbers in the color array are all positive, all negative or mixed.

caps object
3 nested properties
x object
2 nested properties
fill query-string | number

Sets the fill ratio of the caps. The default fill value of the caps is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

show query-string | boolean

Sets the fill ratio of the slices. The default fill value of the x slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

y object
2 nested properties
fill query-string | number

Sets the fill ratio of the caps. The default fill value of the caps is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

show query-string | boolean

Sets the fill ratio of the slices. The default fill value of the y slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

z object
2 nested properties
fill query-string | number

Sets the fill ratio of the caps. The default fill value of the caps is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

show query-string | boolean

Sets the fill ratio of the slices. The default fill value of the z slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

cauto query-string | boolean

Determines whether or not the color domain is computed with respect to the input data (here value) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

cmax query-string | number

Sets the upper bound of the color domain. Value should have the same units as value and if set, cmin must be set as well.

cmid query-string | number

Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as value. Has no effect when cauto is false.

cmin query-string | number

Sets the lower bound of the color domain. Value should have the same units as value and if set, cmax must be set as well.

coloraxis query-string | string

Sets a reference to a shared color axis. References to these shared color axes are coloraxis, coloraxis2, coloraxis3, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

colorbar object
48 nested properties
bgcolor query-string | color

Sets the color of padded area.

bordercolor query-string | color

Sets the axis line color.

borderwidth query-string | number

Sets the width (in px) or the border enclosing this color bar.

dtick

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, 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 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 query-string | enum

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.

labelalias

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.

Default: false
len query-string | number

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode query-string | enum

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

nticks query-string | integer

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.

orientation query-string | enum

Sets the orientation of the colorbar.

outlinecolor query-string | color

Sets the axis line color.

outlinewidth query-string | number

Sets the width (in px) of the axis line.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

showexponent query-string | enum

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.

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

thickness query-string | number

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode query-string | enum

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is h, top and bottom when orientation is v.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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 string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
side query-string | enum

Determines the location of color bar's title with respect to the color bar. Defaults to top when orientation if v and defaults to right when orientation if h.

text string

Sets the title of the color bar.

x query-string | number

Sets the x position with respect to xref of the color bar (in plot fraction). When xref is paper, defaults to 1.02 when orientation is v and 0.5 when orientation is h. When xref is container, defaults to 1 when orientation is v and 0.5 when orientation is h. Must be between 0 and 1 if xref is container and between -2 and 3 if xref is paper.

xanchor query-string | enum

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar. Defaults to left when orientation is v and center when orientation is h.

xpad query-string | number

Sets the amount of padding (in px) along the x direction.

xref query-string | enum

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

y query-string | number

Sets the y position with respect to yref of the color bar (in plot fraction). When yref is paper, defaults to 0.5 when orientation is v and 1.02 when orientation is h. When yref is container, defaults to 0.5 when orientation is v and 1 when orientation is h. Must be between 0 and 1 if yref is container and between -2 and 3 if yref is paper.

yanchor query-string | enum

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar. Defaults to middle when orientation is v and bottom when orientation is h.

ypad query-string | number

Sets the amount of padding (in px) along the y direction.

yref query-string | enum

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

colorscale query-string | colorscale

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, use cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

contour object
3 nested properties

Sets the color of the contour lines.

show query-string | boolean

Sets whether or not dynamic contours are shown on hover

width query-string | number

Sets the width of the contour lines.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

flatshading query-string | boolean

Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Same as text.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

isomax query-string | number

Sets the maximum boundary for iso-surface plot.

isomin query-string | number

Sets the minimum boundary for iso-surface plot.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

lighting object
7 nested properties
ambient query-string | number

Ambient light increases overall color visibility but can wash out the image.

diffuse query-string | number

Represents the extent that incident rays are reflected in a range of angles.

facenormalsepsilon query-string | number

Epsilon for face normals calculation avoids math issues arising from degenerate geometry.

fresnel query-string | number

Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.

roughness query-string | number

Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.

specular query-string | number

Represents the level that incident rays are reflected in a single direction, causing shine.

vertexnormalsepsilon query-string | number

Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.

lightposition object
3 nested properties
x query-string | number

Numeric vector, representing the X coordinate for each vertex.

y query-string | number

Numeric vector, representing the Y coordinate for each vertex.

z query-string | number

Numeric vector, representing the Z coordinate for each vertex.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

opacity query-string | number

Sets the opacity of the surface. Please note that in the case of using high opacity values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.

opacityscale

Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]] means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.

reversescale query-string | boolean

Reverses the color mapping if true. If true, cmin will correspond to the last color in the array and cmax will correspond to the first color.

scene query-string | string

Sets a reference between this trace's 3D coordinate system and a 3D scene. If scene (the default value), the (x,y,z) coordinates refer to layout.scene. If scene2, the (x,y,z) coordinates refer to layout.scene2, and so on.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

showscale query-string | boolean

Determines whether or not a colorbar is displayed for this trace.

slices object
3 nested properties
x object
4 nested properties
fill query-string | number

Sets the fill ratio of the slices. The default fill value of the slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

locations query-string | number | string[]

Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

show query-string | boolean

Determines whether or not slice planes about the x dimension are drawn.

y object
4 nested properties
fill query-string | number

Sets the fill ratio of the slices. The default fill value of the slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

locations query-string | number | string[]

Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

show query-string | boolean

Determines whether or not slice planes about the y dimension are drawn.

z object
4 nested properties
fill query-string | number

Sets the fill ratio of the slices. The default fill value of the slices is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

locations query-string | number | string[]

Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.

locationssrc string

Sets the source reference on Chart Studio Cloud for locations.

show query-string | boolean

Determines whether or not slice planes about the z dimension are drawn.

spaceframe object
2 nested properties
fill query-string | number

Sets the fill ratio of the spaceframe elements. The default fill value is 1 meaning that they are entirely shaded. Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

show query-string | boolean

Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
surface object
4 nested properties
count query-string | integer

Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.

fill query-string | number

Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a fill ratio less than one would allow the creation of openings parallel to the edges.

pattern query-string | string | string

Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is all meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital A, B, C, D and E may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.

show query-string | boolean

Hides/displays surfaces between minimum and maximum iso-values.

text string | string[]

Sets the text elements associated with the vertices. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

value query-string | number | string[]

Sets the 4th dimension (value) of the vertices.

valuehoverformat string

Sets the hover text formatting rulefor value 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.By default the values are formatted using generic number format.

Default: ""
valuesrc string

Sets the source reference on Chart Studio Cloud for value.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

x query-string | number | string[]

Sets the X coordinates of the vertices on X axis.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the Y coordinates of the vertices on Y axis.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
ysrc string

Sets the source reference on Chart Studio Cloud for y.

z query-string | number | string[]

Sets the Z coordinates of the vertices on Z axis.

zhoverformat string

Sets the hover text formatting rulefor z 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.46By default the values are formatted using zaxis.hoverformat.

Default: ""
zsrc string

Sets the source reference on Chart Studio Cloud for z.

Waterfall object

A schema to validate plotly trace properties

type const: "waterfall" required
Constant: "waterfall"
alignmentgroup string

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

Default: ""
base query-string | number

Sets where the bar base is drawn (in position axis units).

cliponaxis query-string | boolean

Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

connector object
3 nested properties
line object
3 nested properties

Sets the line color.

dash string

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).

Default: "solid"
width query-string | number

Sets the line width (in px).

mode query-string | enum

Sets the shape of connector lines.

visible query-string | boolean

Determines if connector lines are drawn.

constraintext query-string | enum

Constrain the size of text inside or outside a bar to be no larger than the bar itself.

customdata query-string | number | string[]

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

customdatasrc string

Sets the source reference on Chart Studio Cloud for customdata.

decreasing object
1 nested properties
marker object
2 nested properties

Sets the marker color of all decreasing values.

line object
dx query-string | number

Sets the x coordinate step. See x0 for more info.

dy query-string | number

Sets the y coordinate step. See y0 for more info.

hoverinfo query-string | string | string | query-string | string | string[]

Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

hoverinfosrc string

Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel object
9 nested properties
align query-string | enum | query-string | enum[]

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

alignsrc string

Sets the source reference on Chart Studio Cloud for align.

bgcolor query-string | color | query-string | color[]

Sets the background color of the hover labels for this trace

bgcolorsrc string

Sets the source reference on Chart Studio Cloud for bgcolor.

bordercolor query-string | color | query-string | color[]

Sets the border color of the hover labels for this trace.

bordercolorsrc string

Sets the source reference on Chart Studio Cloud for bordercolor.

font object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

namelength query-string | integer | query-string | integer[]

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

namelengthsrc string

Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate string | string[]

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%xother}, {%xother}, {%xother}. When showing info for several points, xother will be added to those with different x positions from the first point. An underscore before or after (x|y)other will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta and final. Anything contained in tag <extra> is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc string

Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext string | string[]

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

hovertextsrc string

Sets the source reference on Chart Studio Cloud for hovertext.

ids query-string | number | string[]

Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

idssrc string

Sets the source reference on Chart Studio Cloud for ids.

increasing object
1 nested properties
marker object
2 nested properties

Sets the marker color of all increasing values.

line object
insidetextanchor query-string | enum

Determines if texts are kept at center or start/end points in textposition inside mode.

insidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

legend query-string | string

Sets the reference to a legend to show this trace in. References to these legends are legend, legend2, legend3, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.

legendgroup string

Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.

Default: ""
legendgrouptitle object
2 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

text string

Sets the title of the legend group.

Default: ""
legendrank query-string | number

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with reversed legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

legendwidth query-string | number

Sets the width (in px or fraction) of the legend for this trace.

measure query-string | number | string[]

An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.

measuresrc string

Sets the source reference on Chart Studio Cloud for measure.

metasrc string

Sets the source reference on Chart Studio Cloud for meta.

name string

Sets the trace name. The trace name appears as the legend item and on hover.

offset query-string | number | query-string | number[]

Shifts the position where the bar is drawn (in position axis units). In group barmode, traces that set offset will be excluded and drawn in overlay mode instead.

offsetgroup string

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

Default: ""
offsetsrc string

Sets the source reference on Chart Studio Cloud for offset.

opacity query-string | number

Sets the opacity of the trace.

orientation query-string | enum

Sets the orientation of the bars. With v (h), the value of the each bar spans along the vertical (horizontal).

outsidetextfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

selectedpoints

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

showlegend query-string | boolean

Determines whether or not an item corresponding to this trace is shown in the legend.

stream object
2 nested properties
maxpoints query-string | number

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

token string

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

pattern=.*\S.*$
text string | string[]

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

textangle query-string | number

Sets the angle of the tick labels with respect to the bar. For example, a tickangle of -90 draws the tick labels vertically. With auto the texts may automatically be rotated to fit with the maximum size in bars.

textfont object
18 nested properties
color query-string | color | query-string | color[]
colorsrc string

Sets the source reference on Chart Studio Cloud for color.

family string | string[] | query-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.

familysrc string

Sets the source reference on Chart Studio Cloud for family.

lineposition query-string | string | string | query-string | string | string[]

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.

linepositionsrc string

Sets the source reference on Chart Studio Cloud for lineposition.

shadow string | string[]

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.

shadowsrc string

Sets the source reference on Chart Studio Cloud for shadow.

size query-string | number | query-string | number[]
sizesrc string

Sets the source reference on Chart Studio Cloud for size.

style query-string | enum | query-string | enum[]

Sets whether a font should be styled with a normal or italic face from its family.

stylesrc string

Sets the source reference on Chart Studio Cloud for style.

textcase query-string | enum | query-string | enum[]

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

textcasesrc string

Sets the source reference on Chart Studio Cloud for textcase.

variant query-string | enum | query-string | enum[]

Sets the variant of the font.

variantsrc string

Sets the source reference on Chart Studio Cloud for variant.

weight query-string | integer | query-string | integer[]

Sets the weight (or boldness) of the font.

weightsrc string

Sets the source reference on Chart Studio Cloud for weight.

textinfo query-string | string | string

Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).

textposition query-string | enum | query-string | enum[]

Specifies the location of the text. inside positions text inside, next to the bar end (rotated and scaled if needed). outside positions text outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. auto tries to position text inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If none, no text appears.

textpositionsrc string

Sets the source reference on Chart Studio Cloud for textposition.

textsrc string

Sets the source reference on Chart Studio Cloud for text.

texttemplate string | string[]

Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables initial, delta, final and label.

texttemplatesrc string

Sets the source reference on Chart Studio Cloud for texttemplate.

totals object
1 nested properties
marker object
2 nested properties

Sets the marker color of all intermediate sums and total values.

line object
uid string

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

uirevision

Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

visible query-string | enum

Determines whether or not this trace is visible. If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

width query-string | number | query-string | number[]

Sets the bar width (in position axis units).

widthsrc string

Sets the source reference on Chart Studio Cloud for width.

x query-string | number | string[]

Sets the x coordinates.

x0

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

Default: 0
xaxis query-string | string

Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

xhoverformat string

Sets the hover text formatting rulefor x 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.46By default the values are formatted using xaxis.hoverformat.

Default: ""
xperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
xperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the x0 axis. When x0period is round number of weeks, the x0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

xperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the x axis.

xsrc string

Sets the source reference on Chart Studio Cloud for x.

y query-string | number | string[]

Sets the y coordinates.

y0

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Default: 0
yaxis query-string | string

Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

yhoverformat string

Sets the hover text formatting rulefor y 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.46By default the values are formatted using yaxis.hoverformat.

Default: ""
yperiod

Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the y axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.

Default: 0
yperiod0

Only relevant when the axis type is date. Sets the base for period positioning in milliseconds or date string on the y0 axis. When y0period is round number of weeks, the y0period0 by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.

yperiodalignment query-string | enum

Only relevant when the axis type is date. Sets the alignment of data points on the y axis.

ysrc string

Sets the source reference on Chart Studio Cloud for y.

zorder query-string | integer

Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher zorder appear in front of those with lower zorder.

color string

A valid color in hex, rgb, rgba, hsl, hsv, or named CSS color

colorscale string | number | color[][]

A Plotly colorscale either by name or a custom array of [value, color] pairs.

query-string string

A string that will pull the value from the traces query results or inject an input value.

xaxis object
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
6 nested properties
clipmax

Clip autorange maximum if it goes beyond this value. Has no effect when autorangeoptions.maxallowed is provided.

clipmin

Clip autorange minimum if it goes beyond this value. Has no effect when autorangeoptions.minallowed is provided.

include array

Ensure this value is included in autorange.

includesrc string

Sets the source reference on Chart Studio Cloud for include.

maxallowed

Use this value exactly as autorange maximum.

minallowed

Use this value exactly as autorange minimum.

autotickangles query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to array. Used with categoryorder.

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

Sets the color of the dividers Only has an effect on multicategory axes.

dividerwidth query-string | number

Sets the width (in px) of the dividers Only has an effect on multicategory axes.

domain query-string | query-string | number[]

Sets the domain of this axis (in plot fraction).

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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).

Default: "solid"
gridwidth query-string | number

Sets the width (in px) of the grid lines.

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

Sets the width (in px) of the axis line.

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

minor object
14 nested properties
dtick

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, 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 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 query-string | color

Sets the color of the grid lines.

griddash string

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).

Default: "solid"
gridwidth query-string | number

Sets the width (in px) of the grid lines.

nticks query-string | integer

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 query-string | boolean

Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.

tick0

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 (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 query-string | color

Sets the tick color.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 query-string | enum

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 query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

rangeselector object
11 nested properties
activecolor query-string | color

Sets the background color of the active range selector button.

bgcolor query-string | color

Sets the background color of the range selector buttons.

bordercolor query-string | color

Sets the color of the border enclosing the range selector.

borderwidth query-string | number

Sets the width (in px) of the border enclosing the range selector.

buttons object[]
minItems=1
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

visible query-string | boolean

Determines whether or not this range selector is visible. Note that range selectors are only available for x axes of type set to or auto-typed to date.

x query-string | number

Sets the x position (in normalized coordinates) of the range selector.

xanchor query-string | enum

Sets the range selector's horizontal position anchor. This anchor binds the x position to the left, center or right of the range selector.

y query-string | number

Sets the y position (in normalized coordinates) of the range selector.

yanchor query-string | enum

Sets the range selector's vertical position anchor This anchor binds the y position to the top, middle or bottom of the range selector.

rangeslider object
8 nested properties
autorange query-string | boolean

Determines whether or not the range slider range is computed in relation to the input data. If range is provided, then autorange is set to false.

bgcolor query-string | color

Sets the background color of the range slider.

bordercolor query-string | color

Sets the border color of the range slider.

borderwidth query-string | integer

Sets the border width of the range slider.

range query-string | array

Sets the range of the range slider. If not set, defaults to the full xaxis range. If the axis type is log, then you must take the log of your desired range. 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.

thickness query-string | number

The height of the range slider as a fraction of the total plot area height.

visible query-string | boolean

Determines whether or not the range slider will be visible. If visible, perpendicular axes will be set to fixedrange

yaxis object
2 nested properties
range query-string | array

Sets the range of this axis for the rangeslider.

rangemode query-string | enum

Determines whether or not the range of this axis in the rangeslider use the same value than in the main plot when zooming in/out. If auto, the autorange will be used. If fixed, the range is used. If match, the current range of the corresponding y-axis on the main subplot is used.

scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.

showline query-string | boolean

Determines whether or not a line bounding this axis is drawn.

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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).

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

Sets the width (in px) of the zero line.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

standoff query-string | number

Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title font.size and the axis linewidth. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting standoff and turning on automargin, plotly.js will push the margins to fit the axis title at given standoff distance.

text string

Sets the title of this axis.

type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

Sets the width (in px) of the zero line.

yaxis object
anchor query-string | string | enum

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 query-string | string | string

Determines whether long tick labels automatically grow the figure margins.

autorange query-string | enum

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 object
6 nested properties
clipmax

Clip autorange maximum if it goes beyond this value. Has no effect when autorangeoptions.maxallowed is provided.

clipmin

Clip autorange minimum if it goes beyond this value. Has no effect when autorangeoptions.minallowed is provided.

include array

Ensure this value is included in autorange.

includesrc string

Sets the source reference on Chart Studio Cloud for include.

maxallowed

Use this value exactly as autorange maximum.

minallowed

Use this value exactly as autorange minimum.

autoshift query-string | 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 query-string | query-string | number[]

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 query-string | enum

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 query-string | enum

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 query-string | number | string[]

Sets the order in which categories on this axis appear. Only has an effect if categoryorder is set to array. Used with categoryorder.

categoryarraysrc string

Sets the source reference on Chart Studio Cloud for categoryarray.

categoryorder query-string | enum

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.

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 query-string | enum

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 query-string | enum

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 query-string | color

Sets the color of the dividers Only has an effect on multicategory axes.

dividerwidth query-string | number

Sets the width (in px) of the dividers Only has an effect on multicategory axes.

domain query-string | query-string | number[]

Sets the domain of this axis (in plot fraction).

dtick

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, 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 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 query-string | enum

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.

fixedrange query-string | boolean

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

gridcolor query-string | color

Sets the color of the grid lines.

griddash string

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).

Default: "solid"
gridwidth query-string | number

Sets the width (in px) of the grid lines.

hoverformat string

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

Default: ""
insiderange query-string | array

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

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.

Default: false
layer query-string | enum

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 query-string | color

Sets the axis line color.

linewidth query-string | number

Sets the width (in px) of the axis line.

matches query-string | string | enum

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

Determines the maximum range of this axis.

minallowed

Determines the minimum range of this axis.

minexponent query-string | number

Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

minor object
14 nested properties
dtick

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, 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 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 query-string | color

Sets the color of the grid lines.

griddash string

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).

Default: "solid"
gridwidth query-string | number

Sets the width (in px) of the grid lines.

nticks query-string | integer

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 query-string | boolean

Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.

tick0

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 (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 query-string | color

Sets the tick color.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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 query-string | enum

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 query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

mirror query-string | enum

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

nticks query-string | integer

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.

overlaying query-string | string | enum

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis, with traces and axes visible for both axes. If false, this axis does not overlay any same-letter axes. In this case, for axes with overlapping domains only the highest-numbered axis will be visible.

position query-string | number

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

range query-string | 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. Leaving either or both elements null impacts the default autorange.

rangebreaks object[]
minItems=1
rangemode query-string | enum

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data. Applies only to linear axes.

scaleanchor query-string | string | enum

If set to another axis id (e.g. x2, y), the range of this axis changes together with the range of the corresponding axis such that the scale of pixels per unit is in a constant ratio. Both axes are still zoomable, but when you zoom one, the other will zoom the same amount, keeping a fixed midpoint. constrain and constraintoward determine how we enforce the constraint. You can chain these, ie yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*} but you can only link axes of the same type. The linked axis can have the opposite letter (to constrain the aspect ratio) or the same letter (to match scales across subplots). Loops (yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*} or longer) are redundant and the last constraint encountered will be ignored to avoid possible inconsistent constraints via scaleratio. Note that setting axes simultaneously in both a scaleanchor and a matches constraint is currently forbidden. Setting false allows to remove a default constraint (occasionally, you may need to prevent a default scaleanchor constraint from being applied, eg. when having an image trace yaxis: {scaleanchor: "x"} is set automatically in order for pixels to be rendered as squares, setting yaxis: {scaleanchor: false} allows to remove the constraint).

scaleratio query-string | number

If this axis is linked to another by scaleanchor, this determines the pixel to unit scale ratio. For example, if this value is 10, then every unit on this axis spans 10 times the number of pixels as a unit on the linked axis. Use this for example to create an elevation profile where the vertical scale is exaggerated a fixed amount with respect to the horizontal.

separatethousands query-string | boolean

If "true", even 4-digit integers are separated

shift query-string | number

Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If autoshift is set to true, then this defaults to a padding of -3 if side is set to left. and defaults to +3 if side is set to right. Defaults to 0 if autoshift is set to false. Only has an effect if anchor is set to free.

showdividers query-string | boolean

Determines whether or not a dividers are drawn between the category levels of this axis. Only has an effect on multicategory axes.

showexponent query-string | enum

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 query-string | boolean

Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.

showline query-string | boolean

Determines whether or not a line bounding this axis is drawn.

showspikes query-string | boolean

Determines whether or not spikes (aka droplines) are drawn for this axis. Note: This only takes affect when hovermode = closest

showticklabels query-string | boolean

Determines whether or not the tick labels are drawn.

showtickprefix query-string | enum

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 query-string | enum

Same as showtickprefix but for tick suffixes.

side query-string | enum

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

spikecolor query-string | color

Sets the spike color. If undefined, will use the series color

spikedash string

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).

Default: "dash"
spikemode query-string | string

Determines the drawing mode for the spike line If toaxis, the line is drawn from the data point to the axis the series is plotted on. If across, the line is drawn across the entire plot area, and supercedes toaxis. If marker, then a marker dot is drawn on the axis the series is plotted on

spikesnap query-string | enum

Determines whether spikelines are stuck to the cursor or to the closest datapoints.

spikethickness query-string | number

Sets the width (in px) of the zero line.

tick0

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 (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 query-string | number

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor query-string | color

Sets the tick color.

tickfont object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

tickformat string

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

Default: ""
tickformatstops object[]
minItems=1
ticklabelindex query-string | integer | query-string | integer[]

Only for axes with type date or linear. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose ticklabelindex -1. This is useful for date axes with ticklabelmode period if you want to label the period that ends with each major tick instead of the period that begins there.

ticklabelindexsrc string

Sets the source reference on Chart Studio Cloud for ticklabelindex.

ticklabelmode query-string | enum

Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of type date When set to period, tick labels are drawn in the middle of the period between ticks.

ticklabeloverflow query-string | enum

Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. Otherwise on category and multicategory axes the default is allow. In other cases the default is hide past div.

ticklabelposition query-string | enum

Determines where tick labels are drawn with respect to the axis Please note that top or bottom has no effect on x axes or when ticklabelmode is set to period. Similarly left or right has no effect on y axes or when ticklabelmode is set to period. Has no effect on multicategory axes or when tickson is set to boundaries. When used on axes linked by matches or scaleanchor, no extra padding for inside labels would be added by autorange, so that the scales could match.

ticklabelshift query-string | integer

Shifts the tick labels by the specified number of pixels in parallel to the axis. Positive values move the labels in the positive direction of the axis.

ticklabelstandoff query-string | integer

Sets the standoff distance (in px) between the axis tick labels and their default position. A positive ticklabelstandoff moves the labels farther away from the plot area if ticklabelposition is outside, and deeper into the plot area if ticklabelposition is inside. A negative ticklabelstandoff works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.

ticklabelstep query-string | integer

Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type log or multicategory, or when tickmode is array.

ticklen query-string | number

Sets the tick length (in px).

tickmode query-string | enum

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). If sync, the number of ticks will sync with the overlayed axis set by overlaying property.

tickprefix string

Sets a tick label prefix.

Default: ""
ticks query-string | enum

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.

tickson query-string | enum

Determines where ticks and grid lines are drawn with respect to their corresponding tick labels. Only has an effect for axes of type category or multicategory. When set to boundaries, ticks and grid lines are drawn half a category to the left/bottom of labels.

ticksuffix string

Sets a tick label suffix.

Default: ""
ticktext query-string | number | string[]

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

ticktextsrc string

Sets the source reference on Chart Studio Cloud for ticktext.

tickvals query-string | number | string[]

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

tickvalssrc string

Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth query-string | number

Sets the tick width (in px).

title object
3 nested properties
font object
9 nested properties
family 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.

pattern=.*\S.*$
lineposition query-string | string | string

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 string

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.

Default: "none"
size query-string | number
style query-string | enum

Sets whether a font should be styled with a normal or italic face from its family.

textcase query-string | enum

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

variant query-string | enum

Sets the variant of the font.

weight query-string | integer

Sets the weight (or boldness) of the font.

standoff query-string | number

Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title font.size and the axis linewidth. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting standoff and turning on automargin, plotly.js will push the margins to fit the axis title at given standoff distance.

text string

Sets the title of this axis.

type query-string | enum

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

Controls persistence of user-driven changes in axis range, autorange, and title if in editable: true configuration. Defaults to layout.uirevision.

visible query-string | boolean

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

zeroline query-string | boolean

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

zerolinecolor query-string | color

Sets the line color of the zero line.

zerolinewidth query-string | number

Sets the width (in px) of the zero line.