Overview of sdk-ui-charts

Home > @gooddata/sdk-ui-charts

sdk-ui-charts package

This package provides a set of React-based chart visualizations that you can use to visualize your data.

Remarks

These include bar charts, pie charts, line charts, and more. For a table visualization, see the @gooddata/sdk-ui-pivot package. For map-based charts, see the @gooddata/sdk-ui-geo package.

Functions

Function	Description
AreaChart(props)	Area chart shows data as an area under a line intersecting dots.
BarChart(props)	Bar chart shows data in horizontal bars.
BubbleChart(props)	Bubble chart shows data as bubbles using Cartesian coordinates.
BulletChart(props)	Bullet chart is a variation of a bar chart that displays performance of a measure (primary measure) and its progress towards a goal (target measure).
ColumnChart(props)	Column chart shows data in vertical columns.
ComboChart(props)	Combo chart combines two types of visualizations, for example, a column chart and a line chart.
DependencyWheelChart(props)	A dependency wheel is a type of flow diagram, where nodes are laid out in a circle, and links are drawn between them. This width of the link and size of the nodes are proportional to the flow quantity or weight of each link.
DonutChart(props)	Donut chart shows data as proportional segments of a disc and has a hollowed out center.
FunnelChart(props)	A funnel chart displays values as progressively decreasing proportions.
Headline(props)	Headline shows a single number or compares two numbers. You can display both measures and attributes.
Heatmap(props)	Heatmap represents data as a matrix where individual values are represented as colors. Heatmaps can help you discover trends and understand complex datasets.
LineChart(props)	Line chart shows data as line-connected dots.
PieChart(props)	Pie chart shows data as proportional segments of a disc.
PyramidChart(props)	A pyramid chart displays values on top of each other, useful for example for showing hierarchies or workflows.
Repeater(props)	(BETA)
SankeyChart(props)	A Sankey diagram is a type of flow diagram, in which the width of the link between two nodes is shown proportionally to the flow quantity.
ScatterPlot(props)	Scatter plot shows data as points using Cartesian coordinates.
Treemap(props)	Treemap chart presents your data hierarchically as nested rectangles.
WaterfallChart(props)	Waterfall chart shows data as proportional segments of a disc.
Xirr(props)	(BETA) Xirr computes the Internal Rate of Return from the given measure and date dimension.

Interfaces

Interface	Description
IAreaChartBucketProps
IAreaChartProps
IAxisConfig
IAxisNameConfig	Customize whether to display the axis name and if so, where relative to the axis it should be positioned.
IBarChartBucketProps
IBarChartProps
IBubbleChartBucketProps
IBubbleChartProps
IBucketChartProps	Props for all bucket charts.
IBulletChartBucketProps
IBulletChartProps
IChartCallbacks	Defines callbacks to execute for different events.
IChartClusteringConfig	(BETA) Forecast configuration
IChartConfig	Chart config is used to customize visual aspects of the different charts.
IChartLimits
IColorConfig	Configuration options for color settings.
IColumnChartBucketProps
IColumnChartProps
IComboChartBucketProps
IComboChartProps
ICommonChartProps	Props applicable for all charts
IComparison	Configuration options for comparing values.
IContinuousLineConfig	Indicates whether the continuous line for the missing value display or not on Area, Line, and Combo chart
IDataLabelsConfig
IDataPointsConfig
IDependencyWheelChartBucketProps
IDependencyWheelChartProps
IDisplayFormHyperlinksConfig	(BETA) Customize behavior of the hyperlink display forms in the chart.
IDistinctPointShapes	(BETA) Configuration for distinct point shapes feature.
IDonutChartBucketProps
IDonutChartProps
IForecast	(BETA) Forecast configuration
IFunnelChartBucketProps
IFunnelChartProps
IGridConfig
IHeadlineBucketProps
IHeadlineProps
IHeatmapBucketProps
IHeatmapProps
IInlineVisualizationsConfig	(BETA)
ILabelConfig	Configuration options for labeling conditions.
ILegendConfig
ILegendData
ILegendItem
ILineChartBucketProps
ILineChartProps
IOrientationConfig	Chart orientation config
IPieChartBucketProps
IPieChartProps
IPyramidChartBucketProps
IPyramidChartProps
IRepeaterAbsoluteColumnWidth
IRepeaterAttributeColumnLocator	Locates all columns for an attribute or columns for particular attribute element.
IRepeaterAttributeColumnLocatorBody	Object defining the IRepeaterAttributeColumnLocator object body.
IRepeaterAttributeColumnWidthItem
IRepeaterAttributeColumnWidthItemBody	Object defining the IRepeaterAttributeColumnWidthItem object body.
IRepeaterAutoColumnWidth
IRepeaterBucketProps	(BETA)
IRepeaterColumnSizing
IRepeaterMeasureColumnLocator	Locates table column by column measure's localId.
IRepeaterMeasureColumnLocatorBody	Object defining the IRepeaterMeasureColumnLocator object body.
IRepeaterMeasureColumnWidthItem
IRepeaterMeasureColumnWidthItemBody	Object defining the IRepeaterMeasureColumnWidthItem object body.
IRepeaterProps	(BETA)
ISankeyChartBucketProps
ISankeyChartProps
IScatterPlotBucketProps
IScatterPlotProps
ITooltipConfig	Tooltip customization
ITotalConfig
ITreemapBucketProps
ITreemapProps
IWaterfallChartBucketProps
IWaterfallChartProps
IXirrBucketProps	(BETA)
IXirrProps	(BETA)

Variables

Variable	Description
ViewByAttributesLimit	Maximum number of attributes for view-by slicing.

Type Aliases

Type Alias	Description
AxisNamePosition	Position of the axis label relative to the axis.
CalculationType	Defines the calculation types for an algorithm.
ChartAlignTypes	Vertical chart alignment options.
ChartCellImageSizing	(BETA) Image sizing configuration for the chart.
ChartCellTextWrapping	(BETA) Text wrapping configuration for the chart.
ChartCellVerticalAlign	(BETA) Vertical alignment configuration for the chart.
ChartInlineVisualizationType	(BETA) Possible types of the inline visualizations.
ChartOrientationType	Available orientation positions.
ChartRowHeight	(BETA) Row height configuration for the chart.
ComparisonFormat	Comparison format type
ComparisonPosition	Defines how the comparison value will be placed.
IDataLabelsVisible	Data label visibility options.
IDataPointsVisible	Data points visibility options.
OnLegendReady	Callback to be called once the legend is rendered.
PointShapeSymbolType	(BETA) Supported point shape symbols for distinct point shapes feature.
PositionType	Available legend positions.
RepeaterColumnLocator
RepeaterColumnResizedCallback
RepeaterColumnWidth
RepeaterColumnWidthItem
RepeaterDefaultColumnWidth