Overview of sdk-ui-vis-commons · GoodData.UI API reference

sdk-ui-vis-commons package

This package provides functions commonly used when building visualizations.

Remarks

This package is mainly used internally by other @gooddata/sdk-ui-* packages, and we do not recommend using it directly outside of GoodData because its API can change at any time.

Functions

Function	Description
fixEmptyHeaderItems(dataView, emptyHeaderString)	This function will mutate the incoming data view and replace headers with empty name with a fallback string. This is so that we can show "(empty)" or similar strings in the UI.
getColorMappingPredicate(testValue)	Creates new predicate for mapping colors to chart entities: if attribute header, URI is expected to match testValue - otherwise (attr or measure descriptor) expecting local identifier match

Function

Description

fixEmptyHeaderItems(dataView, emptyHeaderString)

This function will mutate the incoming data view and replace headers with empty name with a fallback string. This is so that we can show "(empty)" or similar strings in the UI.

getColorMappingPredicate(testValue)

Creates new predicate for mapping colors to chart entities:

if attribute header, URI is expected to match testValue - otherwise (attr or measure descriptor) expecting local identifier match

Interfaces

Interface	Description
IColorMapping

Type Aliases

Type Alias	Description
ChartFillType