Skip to content

Chart

Charts are used to house traces and set up layout configurations (titles, axis labels, ect.).

A chart contains 1 to many traces. This is really useful if you want to combine traces that are on different date grains, bars and lines, or even overlay big numbers over line chart to show the current value and the trend.

The layout is where you define static labels like titles but also where you can set interactive elements like buttons and drop downs. With those interactive elements you can toggle between traces or cohorts on traces.

chart:
  name: a-chart-name
  traces:
    - ref(a-trace-name)
  layout:
    title: 'Aggregated Fibonacci'
    yaxis:
      title: 'Widgets Sold' #Describe the data in your y axis
    xaxis:
      title: 'Week' #Describe the data in your x axis
    stack: False

Attributes

Field Type Default Description
name string None The unique name of the object across the entire project.
selector #/$defs/Selector None The selector for the choosing which trace data is shown.
traces Array of Trace [] A list of trace either written in line in the chart called using the ref() function.
layout Layout None The layout attribute of the chart accepts any valid plotly layout configurations.