• Reference
  • Nodes
  • Components
  • Chart

Chart Component

Charts are a powerful and flexible way to visualize your data, letting Dynaboard do the heavy lifting.

Create a chart node and specify its data source. Your data can come from any other node, most commonly the output of a function node (e.g. {{function1.data}}). From there, the chart node has a handful of options to customize its look and feel.

Charts in Dynaboard are built on top of the incredible Plotly charting library, used many top data teams.

Supported Charts

  • Line charts (LINE)
  • Bar charts (BAR)
  • Scatter plots (SCATTER)

Properties

Visible

PropisVisible
Typeboolean
Default{{true}}

Whether or not this node is visible.

Enabled

PropisEnabled
Typeboolean
Default{{true}}

Whether or not this node is enabled.

Tooltip

Proptooltip
Typestring
Defaultundefined

The tooltip text to display when hovered or focused over this node.

Top

Proptop
Typenumber
Default1

The position of the node from the top side of the grid (grid-row-start).

Left

Propleft
Typenumber
Default1

The position of the node from the left side of the grid (grid-column-start).

Width

Propwidth
Typestring
Default650px

The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width must be specified using CSS units (e.g. 100px or 100%).

Min Width

PropminWidth
Typestring
Defaultnone

The minimum width of the node. When this node is in a grid layout, this property is ignored.

Max Width

PropmaxWidth
Typestring
Defaultnone

The maximum width of the node. When this node is in a grid layout, this property is ignored.

Height

Propheight
Typestring
Default450px

The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height must be specified using CSS units (e.g. 100px or 100%).

Min Height

PropminHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Max Height

PropmaxHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Overflow

Propoverflow
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.

Overflow X

PropoverflowX
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal axis for content that is larger than its container.

Overflow Y

PropoverflowY
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the vertical axis for content that is larger than its container.

Custom Styles

Propstyles
Typestring
Defaultelement.styles { }

Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.

Object Fit

PropobjectFit
TypeObjectFit ('none' | 'contain' | 'cover' | 'fill' | 'scale-down')
Defaultcover

The strategy used to set how the content of a replaced element should be resized to fit its container.

Chart Title

Proptitle
Typestring
Defaultundefined

The title of the chart to be displayed on top of the chart.

Legend

PropallowLegend
Typeboolean
Default{{false}}

Whether or not to allow legend in the chart.

Legend Orientation

ProplegendOrientation
TypeLegendOrientations ('v' | 'h')
Defaultv

The orientation of the legend in the chart.

Legend Position

ProplegendPosition
TypeLegendPositions ('top' | 'bottom' | 'left' | 'right')
Defaulttop

The position of the legend in the chart.

Interactive

PropisInteractive
Typeboolean
Default{{true}}

Whether or not to be interactive with the chart.

Data Source

PropdataSource
TypeArray<UnknownRecord>
Defaultundefined

The data source to use for the chart. Data sources should be an array of objects with a consistent set of keys. For example can represent a cartesian X/Y coordinate by having an array of objects with keys x and y.

Parent Chart Type

PropparentChartType
TypeParentChartTypes ('cartesian' | 'pie' | 'custom')
Defaultcartesian

The type of chart to be configured.

Bar Mode

PropbarMode
TypeBarModes ('group' | 'stack')
Defaultgroup

The mode of the bar chart.

Dimensions

Propdimensions
Typearray
Default[]

The dimension configuration for the chart.

Dimension

Propdimensions[]
Typeobject

A set of data to represent on the chart

Key

Propdimensions[].key
Typestring

The key in the source data to represent on the X-axis

ID

Propdimensions[].id
Typestring

The ID of this dimension

Name

Propdimensions[].name
Typestring

The name of the dimension

Side

Propdimensions[].side
TypeYAxisSides ('left' | 'right')

Which side of the graph should the Y-Axis for this dimension appear

YKey

Propdimensions[].yKey
Typestring

The key in the source data to represent on the Y-axis

Type

Propdimensions[].type
TypeChartTypes ('bar' | 'line' | 'scatter' | 'none')

Which type of chart to use for this dimension

Mode

Propdimensions[].mode
TypeChartModes ('lines' | 'markers' | 'lines+markers')

How should the dimension be represented

LineShape

Propdimensions[].lineShape
TypeChartLineShapes ('linear' | 'spline')

The style of the line representing this dimension

MarkerColor

Propdimensions[].markerColor
Typestring

The color of this dimension on the chart

X Key

PropxKey
Typestring

The key to use from the data source to provide the X values of the chart.

Horizontal axis title

ProphorizontalAxisTitle
Typestring
Defaultundefined

The title to add for the X axis of the chart.

Left vertical axis title

PropleftVerticalAxisTitle
Typestring
Defaultundefined

The title to add for the left Y axis of the chart.

Right vertical axis title

ProprightVerticalAxisTitle
Typestring
Defaultundefined

The title to add for the right Y axis of the chart.

Horizontal axis type

ProphorizontalAxisType
TypeChartAxisTypes ('-' | 'linear' | 'log' | 'date' | 'category' | 'multicategory')
Default-

The scale type to use for the X axis.

Left vertical axis type

PropleftVerticalAxisType
TypeChartAxisTypes ('-' | 'linear' | 'log' | 'date' | 'category' | 'multicategory')
Default-

The scale type to use for the left Y axis.

Right vertical axis type

ProprightVerticalAxisType
TypeChartAxisTypes ('-' | 'linear' | 'log' | 'date' | 'category' | 'multicategory')
Default-

The scale type to use for the right Y axis.

Event Handlers

On Hover

HandlerchartNode.onHover

Called when the user hovers on the node. Use this event to trigger downstream actions when this node is hovered.

On Leave

HandlerchartNode.onLeave

Called when the user is not hovering over the node. Use this event to trigger downstream actions when this node is no longer hovered.

Last updated on November 11, 2022