Learn about the LineChart component for use in UI extensions.
LineChart
component renders a line chart for visualizing data. This type of chart is best suited for time series plots or trend data. Alternatively, you can use a BarChart component for comparing categorical data. Learn more about charts.
To see an example of how to implement charts in a UI extension, check out HubSpot’s Charts example project.
Parameter | Type | Description |
---|---|---|
data | Object | An object containing the chart’s data in an array.
|
axes | Object | Configures the chart’s axes. Using the x and y fields, you’ll configure each axis individually with field and fieldType parameters, along with an optional label parameter:
options field to further configure the axes with the following options:
|
options | Object | Additional chart configuration options. Options include:
|
groupFieldByColor
parameter within the axes options
. For example, the line chart below use groupFieldByColor
to add colors to each Breakdown
category defined in the dataset.
colorList
field in the options
prop, then specify the colors to pick from as shown below.
groupFieldByColor
. To do so, include the colors
field within the axes options
, then specify each field value and color, as shown below. Learn more about colors.
stacking
axes option to stack grouped data for visual comparison. For example, the following line chart displays website visits over time broken down by source. To help users compare data within each breakdown category, stacking
has been set to true
.
breakdown
field data is all lowercase (e.g., direct
), the data prop includes propertyLabels
in its options
to convert the labels. Note that the data prop formatting is slightly different to accommodate both the dataset and its options
. Learn more about data options.