Overview of sdk-ui

Home > @gooddata/sdk-ui

sdk-ui package

This package provides base functionality useful for building React visualizations on top of GoodData.

Remarks

The functionality includes functions for getting data from the Analytical Backend, components and React hooks that serve as building blocks for custom visualizations, visualization definition placeholders, support for drilling, and so on.

See the other @gooddata/sdk-ui-* packages (for example, @gooddata/sdk-ui-charts) for pre-built visualizations that you can use instead of building your own.

Classes

Class	Description
BadRequestSdkError	This error means that server could not understand the request due to invalid syntax.
CancelledSdkError	This error means that request has been cancelled usually after component has been unmounted.
ClusteringNotReceivedSdkError	This error means that execution of forecast ended with error.
DataTooLargeToComputeSdkError	This error means that processed request would generate a result too large to be processed by the backend.
DataTooLargeToDisplaySdkError	This error means that executed data were too large to be displayed by GoodData.UI.
DataViewFacade	Wrapper for IDataView.
DataViewLoader	(ALPHA) DataViewLoader allows you to speficy, load and access data results with convenient series and slices API.
DynamicScriptLoadSdkError	This error means that loading of dynamic script/plugin failed.
ForecastNotReceivedSdkError	This error means that execution of forecast ended with error.
GeoLocationMissingSdkError	This error means that location bucket is missing
GeoTokenMissingSdkError	This error means that mapbox token of GeoChart is missing
NegativeValuesSdkError	This error means that processed result contains negative values which does not make sense within the given visualization (e.g. pie chart with negative values).
NoDataSdkError	This error means that the processed result does not contain any data.
NotFoundSdkError	This error means that requested entity (e.g. a visualization) was not found on the server.
ProtectedReportSdkError	This error means that requested visualization is restricted by access rules. Please contact your administrator.
UnauthorizedSdkError	This error means that you are not authorized.
UnexpectedSdkError	This error means that GoodData.UI does not know how to handle such error.

Abstract Classes

Abstract Class	Description
GoodDataSdkError	Base class for all anticipated GoodData.UI SDK errors.

Functions

Function	Description
attributeItemNameMatch(name)	Creates a predicate that return true for any attribute result header with the provided name.
BackendProvider({ children, backend })	BackendProvider can be used to inject analytical backend instance to all ui-sdk components in your app.
BackendProviderWithCorrelation({ backend: externalBackend, correlationData, children, })	Combined provider for both backend and correlation metadata. This is a convenience component that wraps BackendProvider and CorrelationProvider to provide both a backend instance and correlation metadata to components.
ClientWorkspaceProvider(props)	(ALPHA) ClientWorkspaceProvider can be used as a replacement of the WorkspaceProvider(), if you want to work with the workspace in LCM context. It allows you to: - Use dataProduct and client identifier as a replacement of the workspace identifier. Workspace identifier is resolved and provided to the WorkspaceProvider() automatically. Use workspace identifier to obtain dataProduct, client and segment identifiers by the useClientWorkspaceIdentifiers() hooks. If the backend does not support clientId / dataProduct LCM provisioning, or the workspace is not provisioned via LCM, segment / client / dataProduct values will be undefined. To read more details about LCM, see: https://help.gooddata.com/pages/viewpage.action?pageId=86796865
composedFromIdentifier(identifier)	Creates a new predicate that returns true of any arithmetic measure where measure with the provided identifier is used as an operand.
composedFromUri(uri)	Creates a new predicate that returns true of any arithmetic measure where measure with the provided URI is used as an operand.
compressForUrl(data)	Compresses data to a URL-safe string
convertDrillableItemsToPredicates(drillableItems)
convertError(error)	Converts any error into an instance of GoodDataSdkError.
CorrelationProvider({ children, correlationData })	CorrelationProvider provides request correlation metadata to components. When nested, correlation metadata from ancestor providers is merged with the current provider.
createNumberJsFormatter(separators)	Creates value formatter that uses @gooddata/number-formatter to format raw measure values according to the format string.
decompressFromUrl(compressedData)	Decompresses data from a URL-safe string
defaultErrorHandler(error)	Default error handler - logs error to console as error.
ErrorComponent({ icon, className, width, height, style, message, description, clientHeight, })	Component that renders a default error message.
Execute(props)	The executor provides a more curated experience to obtain and work with data from backends.
identifierMatch(identifier)	Creates a new predicate that returns true for any header that belongs to either attribute or measure with the provided identifier.
isAnyPlaceholder(obj)	Type-guard testing whether the provided object is an instance of AnyPlaceholder.
isAttributeColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a column definition is an attribute column
isBadRequest(obj)	Typeguard checking whether input is an instance of BadRequestSdkError;
isCancelledSdkError(obj)	Typeguard checking whether input is an instance of CancelledSdkError;
isClusteringNotReceived(obj)	Typeguard checking whether input is an instance of ClusteringNotReceivedSdkError
isComposedPlaceholder(obj)	Type-guard testing whether the provided object is an instance of IComposedPlaceholder.
isDataTooLargeToCompute(obj)	Typeguard checking whether input is an instance of DataTooLargeToComputeSdkError;
isDataTooLargeToDisplay(obj)	Typeguard checking whether input is an instance of DataTooLargeToDisplaySdkError;
isDrillableItem(item)
isDrillableItemIdentifier(item)
isDrillableItemUri(item)
isDrillIntersectionAttributeItem(header)
isDynamicScriptLoadSdkError(obj)	Typeguard checking whether input is an instance of DynamicScriptLoadSdkError;
isEmptyValueColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a value column definition is an empty pivoting case
isExplicitDrill(obj)
isForecastNotReceived(obj)	Typeguard checking whether input is an instance of ForecastNotReceivedSdkError
isGeoLocationMissing(obj)	Typeguard checking whether input is an instance of GeoLocationMissingSdkError;
isGeoTokenMissing(obj)	Typeguard checking whether input is an instance of GeoTokenMissingSdkError;
isGoodDataSdkError(obj)	Typeguard checking whether input is an instance of GoodDataSdkError;
isGrandTotalColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a column definition is a grand total column
isGrandTotalRowDefinition(row)	(ALPHA) Type guard to check if a row definition is a grand total row.
isHeaderPredicate(obj)	Typeguard checking whether the object is an IHeaderPredicate instance.
isLocale(locale)	Type-guard for language codes that can be used with GoodData.
isMeasureGroupHeaderColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a column definition is a measure group header column
isMeasureGroupValueColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a column definition is a measure group value column
isNegativeValues(obj)	Typeguard checking whether input is an instance of NegativeValuesSdkError;
isNoDataSdkError(obj)	Typeguard checking whether input is an instance of NoDataSdkError;
isNotFound(obj)	Typeguard checking whether input is an instance of NotFoundSdkError;
isPlaceholder(obj)	Type-guard testing whether the provided object is an instance of IPlaceholder.
isProtectedReport(obj)	Typeguard checking whether input is an instance of ProtectedReportSdkError;
isStandardValueColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a value column definition is a standard pivoting case
isSubtotalColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a column definition is a subtotal column
isSubtotalRowDefinition(row)	(ALPHA) Type guard to check if a row definition is a subtotal row.
isTableAttributeHeaderValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableAttributeHeaderValue
isTableGrandTotalHeaderValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableGrandTotalHeaderValue
isTableGrandTotalMeasureValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableGrandTotalMeasureValue
isTableGrandTotalSubtotalMeasureValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableGrandTotalSubtotalMeasureValue
isTableMeasureHeaderValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableMeasureHeaderValue
isTableMeasureValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableMeasureValue
isTableOverallTotalMeasureValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableOverallTotalMeasureValue
isTableSubtotalMeasureValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableSubtotalMeasureValue
isTableTotalHeaderValue(obj)	(ALPHA) Type guard checking whether input is an instance of ITableTotalHeaderValue
isTransposedValueColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a value column definition is a transposed case (measures in rows)
isUnauthorized(obj)	Typeguard checking whether input is an instance of UnauthorizedSdkError;
isUnknownSdkError(obj)	Typeguard checking whether input is an instance of UnexpectedSdkError;
isValueColumnDefinition(columnDefinition)	(ALPHA) Type guard to check if a column definition is a value column
isValueRowDefinition(row)	(ALPHA) Type guard to check if a row definition is a value row.
LoadingComponent({ className, color, speed, inline, height, width, imageHeight, imageWidth, })	Component that renders a default loading indicator.
localIdentifierMatch(localIdOrMeasure)	Creates a new predicate that returns true for any header that belongs to either attribute or measure with the provided local identifier.
newComposedPlaceholder(placeholders, computeValue)	Create a new composed placeholder. See IComposedPlaceholder.
newErrorMapping(intl)	Returns a new, localized error code descriptors.
newPlaceholder(defaultValue, options)	Create a new placeholder. See IPlaceholder.
objMatch(obj)	Creates a new predicate that returns true for any header that belongs to either attribute or measure matching the provided object.
objRefMatch(objRef)	Creates a new predicate that returns true for any header that belongs to either attribute or measure with the provided object reference.
OrganizationProvider({ organization, children })	Organization context provider.
pickCorrectMetricWording(translations, settings)	(BETA) The function to pick correct wording 'measure' or 'metric'
pickCorrectWording(translations, settings)	(BETA)
PlaceholdersProvider(props)	Wraps component into a PlaceholdersContext consumer enabling the children of this to access the current placeholders state.
removeAllWordingTranslationsWithSpecialSuffix(translations)	(BETA) The function to remove all translation keys that contain special suffixes "._measure" or "._metric"
ResolvedClientWorkspaceProvider(props)	(ALPHA) ResolvedClientWorkspaceProvider can be used as a replacement of the WorkspaceProvider(), if you are accessing workspace in LCM context. This provider expects that the client workspace is already resolved on input to the provider. The provider will then establish a client workspace and workspace contexts so that the resolved information can be accessed by the children. Note: check out the ClientWorkspaceProvider() for version of provider that performs the resolution of client workspace identifiers to workspace.
resolveLCMWorkspaceIdentifiers(backend, { client, dataProduct, workspace })	(ALPHA) Resolves LCM workspace identifiers. This function will use the data product and client information and consult the backend in order to obtain identifier of workspace contains analytics for that data product & client combination. Note that at the moment only the bear Analytical Backend supports the workspace identification using LCM workspace identifiers. Attempting to use this function for other backends will yield empty result.
resolveUseCancelablePromisesError(states)	Resolve error of multiple useCancelablePromise() hooks - gets first error in the sequence of cancelable promise states.
resolveUseCancelablePromisesStatus(cancelablePromisesStates, options)	Resolve status of multiple useCancelablePromise() hooks.
TranslationsCustomizationContextProvider({ children, translationsCustomizationIsLoading, translations, })	(BETA)
TranslationsCustomizationProvider({ render, customize, translations: translationsParam, backend: backendParam, workspace: workspaceParam, })	(BETA) This provider is here because of the need for customization of translations.
uriMatch(uri)	Creates a new predicate that returns true for any header that belongs to either attribute or measure with the provided URI.
useBackend(backend)	Hook to get analytical backend instance provided to BackendProvider().
useBackendStrict(backend, context)	Hook to get analytical backend instance provided to BackendProvider().
useBackendWithCorrelation(backend, correlationMetadata)	Hook to get a backend instance with correlation metadata from context, and optionally merge them with additional correlation metadata provided as a parameter.
useCancelablePromise(options, deps)	This hook provides easy way to work with Promises in React components.
useClientWorkspaceError()	(ALPHA) Hook to obtain loading error of the ClientWorkspaceProvider().
useClientWorkspaceIdentifiers()	(ALPHA) Hook to obtain all resolved identifiers from the ClientWorkspaceProvider() - workspace, segment, dataProduct and client.
useClientWorkspaceInitialized()	(ALPHA) Hook to check if client workspace is initialized.
useClientWorkspaceStatus()	(ALPHA) Hook to obtain loading status of the ClientWorkspaceProvider() - "success", "error", "loading" or "pending".
useComposedPlaceholder(placeholder, resolutionContext)	React hook to obtain composed placeholder value.
useCorrelationData()	Hook to get correlation metadata from the nearest correlation provider.
useDataExport({ execution, exportConfig, onCancel, onError, onLoading, onPending, onSuccess, }, deps)	This hook provides easy way to export data in your preferred format (csv/xlsx/raw) for the provided IPreparedExecution.
useExecutionDataView(config, deps)	React hook to get data for a specific execution.
useInsightDataView(config, deps)	React hook to get data for a specific insight.
useLocalStorage(key, initialValue)	Hook for using local storage. Ideally, you want to keep initial value immutable to avoid unnecessary re-renders.
useOrganization()	Hook to get organization identifier provided to OrganizationProvider().
usePagedResource(resourceFactory, fetchParams, fetchDeps, resetDeps, getCacheKey, initialState, preventResetPromises)	Hook for getting data from paged resource
usePlaceholder(placeholder)	React hook to obtain/set placeholder value.
usePlaceholders(placeholders)	React hook to obtain/set multiple placeholder values at once.
useResolveValuesWithPlaceholders(values, resolutionContext)	React hook that resolves multiple value(s) that can possibly contain also placeholder(s) to actual value(s).
useResolveValueWithPlaceholders(value, resolutionContext)	React hook that resolves any value(s) that can possibly contain also placeholder(s) to actual value(s).
useWorkspace(workspace)	Hook to get workspace instance provided to WorkspaceProvider().
useWorkspaceStrict(workspace, context)	Hook to get workspace instance provided to WorkspaceProvider().
withTranslationsCustomization(Component)	(BETA)
WorkspaceProvider({ children, workspace })	WorkspaceProvider can be used to inject analytical workspace instance to all ui-sdk components in your app.

Interfaces

Interface	Description
IBackendProviderProps	Props of the BackendProvider() component.
IBackendProviderWithCorrelationProps	Combined provider for both backend and correlation metadata.
IClientWorkspaceIdentifiers	(ALPHA) Resolved LCM identifiers of the workspace.
IClientWorkspaceProviderCoreProps	(ALPHA) Common props of the ClientWorkspaceProvider().
IClientWorkspaceProviderWithClientAndDataProductProps	(ALPHA)
IClientWorkspaceProviderWithWorkspaceProps	(ALPHA)
IComposedPlaceholder	Represents placeholder composed from other placeholders.
ICorrelationProviderProps	Props of the CorrelationProvider() component.
IDataAccessMethods	Defines methods to access data in the data view.
IDataSeries	Data series is a sequence of data points that are all computed from a single measure, scoped for particular attribute elements.
IDataSeriesCollection	An iterable collection of data series.
IDataSlice	Data slice is a sequence of data points that are all computed for a particular attribute elements and/or totals but different data series.
IDataSliceCollection	An iterable collection of data slices.
IDataVisualizationProps	Common props for visualization of data computed by the analytical backend.
IDrillableItemIdentifier
IDrillableItemUri
IDrillConfig
IDrillEvent
IDrillEventContext	Drill context for all visualization type.
IDrillEventContextGroup	Drill context for chart element group (multiple series + click on axis value) where every point has own intersection.
IDrillEventContextHeadline	Drill context for headline
IDrillEventContextPoint	Drill context for pointy-charts
IDrillEventContextTable	Drill context for table
IDrillEventContextXirr	Drill context for XIRR
IDrillEventIntersectionElement
IDrillIntersectionAttributeItem
IDrillPoint	Drill context for headline
IErrorDescriptors	Mapping between error code and human readable description of the error. Key is error code as defined in ErrorCodes.
IErrorProps	Props of the ErrorComponent().
IExecuteErrorComponentProps	Properties of the error component provided to Execute or RawExecute components
IExecuteInsightProps	Props of the ExecuteInsight component.
IExecuteProps	Props of the Execute() component.
IExecutionConfiguration	Convenient interface to define execution by series and slices.
IExtendedExportConfig
IHeaderPredicateContext	Additional data that describes the context in which the IHeaderPredicate match is being tested.
IHighchartsCategoriesTree
IHighchartsParentTick
IKpiProps	Props of the Kpi component.
ILoadingProps	Props of the LoadingComponent().
ILoadingState
IOrganizationProviderProps	Properties of the organization provider.
IPlaceholderOptions	Common placeholder options.
IPlaceholdersProviderProps	Props of the PlaceholdersProvider() component.
IRawExecuteProps	Props of the RawExecute component.
ITableAttributeColumnDefinition	(ALPHA) Defines a column that shows row attribute values (like "Country" or "City"). **What it does:** These are the leftmost columns that show your row groupings. If you have "Country" and "City" in your rows bucket, you'll get two attribute columns. **When it's created:** - Automatically created for each attribute in the rows bucket - Always appears first (leftmost) in the table - Created regardless of whether you have measures in rows or columns **Real example:** | Country | City | Sales | <- "Country" and "City" are attribute columns |---------|------|-------| | USA | NYC | 100 | | USA | LA | 200 |
ITableAttributeHeaderValue	(ALPHA) Cell located in ITableAttributeColumnDefinition – typically the leftmost part of the table describing the current row's attribute values. It represents a single IResultAttributeHeader coming from the execution response and can be present in both value rows and subtotal rows. **Visual example** Attribute | Measure | -----------+---------+ USA | 100 | <- "USA" is attributeHeader
ITableDataAttributeScope	(ALPHA)
ITableDataAttributeTotalScope	(ALPHA)
ITableDataMeasureGroupScope	(ALPHA)
ITableDataMeasureScope	(ALPHA)
ITableDataMeasureTotalScope	(ALPHA)
ITableGrandTotalHeaderValue	(ALPHA) Header cell labeling a **grand-total row** (usually located in the first columns). **Visual example:** | Q1 | Q2 | ColSum Σ | -----------+-----+-----+----------+ USA | 100 | 120 | 220 | CAN | 80 | 90 | 170 | RowSum Σ | 180 | 210 | 390 | <- RowSum Σ is grandTotalHeader
ITableGrandTotalMeasureValue	(ALPHA) Numeric cell containing **grand totals** – totals across rows or columns. **Visual example** // Column grand total: | Q1 | ColSum Σ | -----------+-----+----------+ USA | 100 | 220 | <- 220 is grandTotalValue // Row grand total: | Q1 | Q2 | -----------+-----+-----+ USA | 100 | 120 | RowSum Σ | 180 | 210 | <- 180 and 210 are grandTotalValue cells
ITableGrandTotalRowDefinition	(ALPHA)
ITableGrandTotalSubtotalMeasureValue	(ALPHA) Numeric cell at the **intersection of row and column subtotals + grandtotals** – the *subtotals of grandtotals*. **Visual example** // Column grand total + row subtotal: | Q1 | ColSum Σ | -----------+-----+----------+ Sum A | 100 | 220 | <- 220 is grandTotalSubtotalValue // Row grand total + column subtotal: | Q1 | Sum A | -----------+-----+-------+ USA | 100 | 120 | RowSum Σ | 180 | 210 | <- 210 is grandTotalSubtotalValue
ITableMeasureGroupHeaderColumnDefinition	(ALPHA) Defines the column that shows measure names when measures are in rows. **What it does:** When you put measures in rows instead of columns, you need a column to show which measure each row represents ("Sales", "Profit", etc.). **When it's created:** - Only when measureDimension === "rows" (measures are transposed) - Always created when you have measures in rows - Appears right after your attribute columns **Real example:** | Country | City | Measure | Q1 | Q2 | <- "Measure" column shows measure names |---------|------|---------|-----|-----| | USA | NYC | Sales | 100 | 150 | | USA | NYC | Profit | 20 | 30 | | USA | LA | Sales | 200 | 250 | | USA | LA | Profit | 40 | 50 |
ITableMeasureGroupValueColumnDefinition	(ALPHA) Defines the single value column when measures are in rows and there are no column attributes. **What it does:** When measures are in rows and you don't have any attributes in columns, you get one simple "Values" column that shows all the numbers. **When it's created:** - Only when measures are in rows and there are no pivoting columns. - Appears as the rightmost column after the measure header column **Real example:** | Country | City | Measure | Value | <- "Value" is the measure group value column |---------|------|---------|-------| | USA | NYC | Sales | 100 | | USA | NYC | Profit | 20 | | USA | LA | Sales | 200 | | USA | LA | Profit | 40 | **What happens if you DO have column attributes:** If you have attributes in columns (like "Q1", "Q2"), then instead of this single column, you get multiple ITableValueColumnDefinition columns - one for each column attribute combination.
ITableMeasureHeaderValue	(ALPHA) Cell inside the ITableMeasureGroupHeaderColumnDefinition. Appears **only when measures are transposed into rows**. Each cell corresponds to one IResultMeasureHeader and labels the measure for that specific row. **Visual example** Attribute | Measure | Value | -----------+---------+-------+ USA | Sales | 100 | <- "Sales" is measureHeader USA | Cost | 80 | <- "Cost" is measureHeader The "Sales" and "Cost" **names** in the "Measure" column are measureHeader cells. The numeric values (100, 80) are regular value cells. **When measures are in columns (no transposition), this interface is NOT used.** Instead, measure names appear as regular column headers in the table structure.
ITableMeasureValue	(ALPHA) Numeric cell containing a **raw measure value** for regular (non-aggregated) row/column intersections. **Visual examples:** // Normal (measures in columns): Country | Sales | -----------+--------+ USA | 100 | <- 100 is value cell // Transposed (measures in rows): Country | | | -----------+---------+-------+ USA | Sales | 100 | <- 100 is value cell
ITableOverallTotalMeasureValue	(ALPHA) Numeric cell at the **overall grand-total** intersection (bottom-right corner) aggregating across *all* rows and columns. **Visual example:** | Q1 | Q2 | ColSum Σ | -----------+-----+-----+----------+ USA | 100 | 120 | 220 | CAN | 80 | 90 | 170 | RowSum Σ | 180 | 210 | 390 | <- 390 is overallTotalValue
ITableSubtotalMeasureValue	(ALPHA) Numeric cell containing **subtotals** aggregated across sibling rows/columns. **Visual example** // Row subtotal: | Sales | -----------+--------+ USA | 100 | Sum A | 170 | <- 170 is subtotalValue // Column subtotal: | Q1 | Sum A | -----------+-----+---------+ USA | 100 | 220 | <- 220 is subtotalValue
ITableSubtotalRowDefinition	(ALPHA)
ITableTotalHeaderValue	(ALPHA) Cell that represents total header. Each cell corresponds to one IResultTotalHeader and labels the total for that specific row / column. **Visual example** Attribute | Value | -----------+-------+ USA | 100 | Sum A | 80 | <- "Sum A" is totalHeader
ITableValueRowDefinition	(ALPHA)
ITranslationsCustomizationContextProviderProps	(BETA)
ITranslationsCustomizationProviderProps	(BETA)
IUseExecutionDataViewConfig	Configuration for useExecutionDataView() hook. See also UseExecutionDataViewCallbacks.
IUseInsightDataViewConfig	Configuration for useInsightDataView() hook.
IUsePagedResourceResult
IUsePagedResourceState
IVisualizationCallbacks	Super-interface for all visualization callbacks.
IVisualizationProps	Super-interface for all visualization props.
IWithLoadingEvents
IWorkspaceProviderProps	Props of the WorkspaceProvider() component.

Variables

Variable	Description
DefaultColorPalette	Default value for IColorPalette.
DefaultDataAccessConfig	Default configuration for the data access methods. Uses default @gooddata/number-formatter formatter and no result formatting.
DefaultLocale	Default value for ILocale.
ErrorCodes	Error codes recognized by the SDK.
ExecuteInsight	Gets data for a specific stored insight.
HeaderPredicates	Set of factory functions to create the most commonly-used HeaderPredicates.
Kpi	Kpi is a simple component which calculates and renders a single formatted measure value.
RawExecute	Raw executor is the most basic React component to drive custom executions to obtain data from backends.

Type Aliases

Type Alias	Description
AnyArrayOf	Generate all possible combinations of arrays signatures for the union type.
AnyMeasure	Represents all possible measure signatures.
AnyPlaceholder	Any placeholder type - placeholder or composed placeholder.
AnyPlaceholderOf	Generate all possible combinations of placeholder signatures for the union type.
ArrayOf	Wrap each member of union type in the array.
AttributeFilterOrPlaceholder	Alias for all possible attribute filter or placeholder signatures.
AttributeFiltersOrPlaceholders	Alias for all possible attribute filters or their placeholder signatures.
AttributeMeasureOrPlaceholder	Alias for all possible attribute, measure or placeholder signatures.
AttributeOrPlaceholder	Alias for all possible attribute or placeholder signatures.
AttributesMeasuresOrPlaceholders	Alias for all possible attributes, measures or their placeholders signatures.
AttributesOrPlaceholders	Alias for all possible attributes or their placeholder signatures.
ChartElementType
ChartType
ComposedPlaceholderResolutionContext	Get composed placeholder resolution context type.
DataAccessConfig
DataPoint	Data Point represents a value computed for particular data series, possibly sliced for additional set of attribute elements OR possibly being a total.
DataPointCoordinates
DataSeriesDescriptor	Full descriptive information about the data series.
DataSeriesDescriptorMethods
DataSeriesHeaders
DataSeriesId
DataSliceDescriptor	Full descriptive information of a data slice includes all attribute element and total headers for the slice and next to them descriptors of attribute objects whose elements figure in the headers.
DataSliceDescriptorMethods
DataSliceHeaders	Data slice name is specified using the result headers.
DataSliceId
DataViewWindow	Structure specifying a particular portion of data.
DrillEventIntersectionElementHeader
ExplicitDrill	Drillable item reference or predicate that enables insight / kpi drilling if it matches some attribute or measure of the insight / kpi.
FilterOrMultiValuePlaceholder
FilterOrPlaceholder	Alias for all possible filter or placeholder signatures.
FiltersOrPlaceholders	Alias for all possible filters or their placeholder signatures.
Flatten	Flatten array type.
HeaderTranslator
HeadlineElementType
HeadlineType
IClientWorkspaceProviderProps	(ALPHA) Props of the ClientWorkspaceProvider() component.
IDrillableItem
IDrillEventCallback
IExecuteErrorComponent	Represents an error component provided to Execute or RawExecute components
IExecuteLoadingComponent	Represents a loading component provided to Execute or RawExecute components
IExportFunction
IHeaderPredicate	A function called for IMappingHeader instances.
ILocale	Language codes that can be used with GoodData.
IMappingHeader
IPlaceholder	Placeholder represents a reference to a specific part of the execution - attribute(s), measure(s), filter(s), sort(s) or total(s), that may change the value at runtime.
ITableColumnDefinition	(ALPHA) Represents all possible column types in a pivot table structure. Think of a pivot table as having these column types from left to right: 1. **Attribute columns** - Show row grouping labels (like "Country", "City") 2. **Measure header column** - Shows measure names (only when measures are in rows) 3. **Value/Total columns** - Show actual numbers and totals The exact combination depends on your data setup: **When measures are in columns (normal pivot table):** | | | Brand > Product | | | | | |---------------------|----------------|----------------| | | | GoodData | | ColMin Σ | | | |---------------------|----------------| | | | | Panther | Bear | Sum A | | |---------|--------|---------------------|----------------|----------------| | Country | City | Sales | Sales | Sales | Sales | |---------|--------|----------|----------|----------------|----------------| | USA | NYC | 100 | 150 | 250 | 100 | | USA | LA | 200 | 250 | 450 | 200 | Country, City are ITableAttributeColumnDefinition - Sales is ITableValueColumnDefinition - Sum A is ITableSubtotalColumnDefinition - ColSum Σ is ITableGrandTotalColumnDefinition **When measures are in rows (transposed + non-pivoted):** | Country | City | MeasureGroupHeader | MeasureGroupValue | |---------|------|---------------------|-----------------------| | USA | NYC | Sales | 100 | | USA | NYC | Profit | 20 | Country, City are ITableAttributeColumnDefinition - MeasureGroupHeader is ITableMeasureGroupHeaderColumnDefinition - MeasureGroupValue is ITableMeasureGroupValueColumnDefinition **When measures are in rows (transposed + pivoted):** | | Quarter | | |----------------------------------------|----------------| | | Country | City | MeasureGroupHeader | Q1 | ColSum Σ | |---------|------|-----------------------|----------------|----------------| | USA | NYC | Sales | 250 | 500 | | USA | NYC | Profit | 450 | 900 | Country, City are ITableAttributeColumnDefinition - MeasureGroupHeader is ITableMeasureGroupHeaderColumnDefinition - Q1 is ITableValueColumnDefinition - ColSum Σ is ITableGrandTotalColumnDefinition
ITableData	(ALPHA) **The complete table data structure**. This is the main interface that represents a fully processed table data with all the metadata needed to render pivot tables, flat tables, and transposed tables. It contains the structural definitions (rows/columns), the actual cell data, and flags that describe the table layout and data interpretation.
ITableDataHeaderScope	(ALPHA) Union of all possible scope types that identify what a specific row or column represents. **Think of scopes as the "address" system for table data:** - Each row has a rowScope: ITableDataHeaderScope[] array - Each column has a columnScope: ITableDataHeaderScope[] array - These arrays describe the "path" to identify exactly what data belongs in each cell When all scopes are regular scopes (attributes and measures) it represents value column or value row. When scopes are mixed regular and total scopes, it represents subtotal column or subtotal row. When all scopes are total scopes it represents grand total column or grand total row.
ITableDataValue	(ALPHA) Union of **all possible cell value shapes** that can appear in the table data matrix. Each variant corresponds to a concrete column × row intersection produced by dataViewToTableData. Header cells (attributeHeader, measureHeader, totalHeader) - Numeric cells with raw measure data (value) - Aggregations (subtotalValue, grandTotalValue, grandTotalSubtotalValue, overallTotalValue) When interpreting the data matrix you should always rely on the concrete subtype. **Example table without transposition:** Attr A | Col A | Sum A | ColSum Σ | ----------+---------+---------+----------+ Row X | 100 | 200 | 300 | Sum B | 400 | 600 | 1000 | RowSum Σ | 500 | 800 | 1300 | Attr A is attribute column, Col A is value column, Sum A is subtotal column, ColSum Σ is grand total column - Row X is value row, Sum B is subtotal row, RowSum Σ is grand total row In this example: - Row X is attributeHeader - Sum B is totalHeader - RowSum Σ is grandTotalHeader - Row X : Col A - 100 is value - Row X : Sum A - 200 is subtotalValue - Row X : ColSum Σ - 300 is grandTotalValue - Sum B : Col A - 400 is subtotalValue - Sum B : Sum A - 600 is subtotalValue - Sum B : ColSum Σ - 1000 is grandTotalSubtotalValue - RowSum Σ : Col A - 500 is grandTotalValue - RowSum Σ : Sum A - 800 is grandTotalSubtotalValue - RowSum Σ : ColSum Σ - 1300 is overallTotalValue
ITableGrandTotalColumnDefinition	(ALPHA) Defines columns that show grand total values. **What it does:** Shows grand totals - these are columns that show the aggregation of values for the top level pivoting attribute, always appears as the rightmost columns. **When it's created:** - Only when you have at least 1 attribute in the columns bucket (pivoting). - Only when you set total for the leftmost column attribute. - In the example, total is set for Brand x Sales. **Real example:** | | | Brand > Product | | | | |---------------------|----------------| | | | GoodData | ColMin Σ | | | |---------------------| | | | | Panther | Bear | | |---------|--------|---------------------|----------------| | Country | City | Sales | Sales | Sales | |---------|--------|----------|----------|----------------| | USA | NYC | 100 | 150 | 100 | | USA | LA | 200 | 250 | 200 |
ITableRowDefinition	(ALPHA) Union of all possible row types in the table data structure. Think of the final table as a stack of these row types: 1. **Value rows** – normal data rows (one per combination of row attributes) 2. **Subtotal rows** – subtotal rows (only when subtotals are configured) 3. **Grand-total rows** – grand-total rows (only when grand totals are configured) The exact mix depends on your configuration (pivoting, transposition, totals settings). **Example layout (no transposition, subtotals + grand totals enabled):** | Country | City | Q1 Sales | Q2 Sales | |-------------|----------|----------|----------| | USA | NYC | 100 | 150 | <- value row | USA | LA | 200 | 250 | <- value row | USA | SUBTOTAL | 300 | 400 | <- subtotal row | CAN | TOR | 80 | 90 | <- value row | CAN | SUBTOTAL | 80 | 90 | <- subtotal row | GRAND TOTAL | | 380 | 490 | <- grand-total row
ITableSubtotalColumnDefinition	(ALPHA) Defines columns that show subtotal values. **What it does:** Shows subtotals - these are columns that show the aggregation of values for a specific attribute pivoting subgroup. **When it's created:** - Only when you have at least 2 attributes in the columns bucket (pivoting). - Only when you set total for pivoting subgroup (not the leftmost column attribute - then it's grand total). - In the example, total is set for Product x Sales. **Real example:** | | | Brand > Product | | | | |---------------------|----------------| | | | GoodData | | | | |---------------------|----------------| | | | Panther | Bear | Sum A | |---------|--------|---------------------|----------------| | Country | City | Sales | Sales | Sales | |---------|--------|----------|----------|----------------| | USA | NYC | 100 | 150 | 250 | | USA | LA | 200 | 250 | 450 |
ITableValueColumnDefinition	(ALPHA) Defines columns that contain actual data values (values and subtotals). **What it does:** These columns show your actual data - sales numbers, counts, percentages, etc. The columnScope tells you exactly what this column represents. **When it's created:** The system creates these based on your column headers. Here's how: **Simple case - just measures:** | Country | Sales | Profit | <- Sales and Profit are value columns |---------|-------|--------| | USA | 100 | 20 | **Pivoted case - attributes + measures in columns:** | Country | East Sales | East Profit | West Sales | West Profit | |---------|------------|-------------|------------|-------------| | USA | 100 | 20 | 150 | 30 | **Transposed case - measures in rows, attributes in columns:** | Country | Measure | East | West | |---------|---------|------|------| | USA | Sales | 100 | 150 | | USA | Profit | 20 | 30 |
IUseComposedPlaceholderHook	React hook to obtain IComposedPlaceholder value.
IUsePlaceholderHook	React hook to obtain and set IPlaceholder value.
MeasureOf	Generate union of measures from union of measure definitions.
MeasureOrPlaceholder	Alias for all possible measure or placeholder signatures.
MeasuresOrPlaceholders	Alias for all possible measures or their placeholder signatures.
NullableFilterOrPlaceholder	Alias for all possible nullable filter or placeholder signatures.
NullableFiltersOrPlaceholders	Alias for all possible nullable filters or their placeholder signatures.
OnDataView	(ALPHA)
OnError
OnExportReady
OnFiredDrillEvent
OnLoadingChanged
PlaceholderOf	Wrap each member of the union type in AnyPlaceholder.
PlaceholderResolvedValue	Convert any value that may contain placeholders to its resolved value type.
PlaceholdersResolvedValues	Convert tuple of values that may contain placeholders to tuple of their respective resolved value types.
PlaceholdersValues	Convert tuple of placeholders to tuple of their respective value types.
PlaceholderValue	Get placeholder value type.
SdkErrorType
SortsOrPlaceholders	Alias for all possible sorts or their placeholders signatures.
TableElementType
TableType
TotalsOrPlaceholders	Alias for all possible totals or their placeholders signatures.
UnionToIntersection	Convert union type to intersection type.
UseCancelablePromiseCallbacks	Callbacks for useCancelablePromise() hook
UseCancelablePromiseErrorState	Indicates error state for useCancelablePromise() hook
UseCancelablePromiseLoadingState	Indicates loading state for useCancelablePromise() hook
UseCancelablePromiseOptions	Options for the useCancelablePromise() hook.
UseCancelablePromisePendingState	Indicates pending state for useCancelablePromise() hook
UseCancelablePromiseState	Indicates the current state of useCancelablePromise() hook
UseCancelablePromiseStatus	Indicates the current state of the promise inside useCancelablePromise() hook
UseCancelablePromiseSuccessState	Indicates success state for useCancelablePromise() hook
UseDataExportCallbacks	Callbacks for useDataExport hook
UseDataExportState	Indicates current state of useDataExport hook
UseExecutionDataViewCallbacks	Callbacks for useExecutionDataView() hook.
UseInsightDataViewCallbacks	Callbacks for useInsightDataView() hook.
ValueFormatter
ValueOrMultiValuePlaceholder
ValueOrPlaceholder	Represents value of type T or any placeholder that may hold value T.
ValuesOrPlaceholders	Represents array of values T or placeholders that may hold value T.
VisElementType
VisType
WithLoadingResult
XirrType