@gooddata/sdk-ui-ext

This package contains various extensions on top of the stable components included in GoodData.UI.

Remarks

The extensions land here instead of their own project as part of their staged development.

Notable member of the package is InsightView, the component that allows you to embed Analytical Designer insights.

Classes

Class	Description
EmptyAfmSdkError	*(ALPHA)*
FluidLayoutDescriptor	*(ALPHA)*

Functions

Function	Description
clearInsightViewCacheForInsight(workspace, ref)	Clears the cached definition of a single insight used by the InsightView components.
clearInsightViewCaches()	Clears all the caches used by the InsightView components.
DefaultNotification({ notification, markNotificationAsRead, onNotificationClick, closeNotificationsPanel, }, input)	Default implementation of the Notification component.
DefaultNotificationsList({ Notification, NotificationsListEmptyState, NotificationsListErrorState, NotificationSkeletonItem, activeView, status, error, activeNotifications, markNotificationAsRead, onNotificationClick, hasNextPage, loadNextPage, itemHeight, itemsGap, itemPadding, skeletonItemsCount, maxListHeight, closeNotificationsPanel, }, input)	Default implementation of the NotificationsList component.
DefaultNotificationsListEmptyState({ activeView, }, input)	Default implementation of the NotificationsListEmptyState component.
DefaultNotificationsListErrorState({ error }, input)	Default implementation of the NotificationsListErrorState component.
DefaultNotificationsPanel({ NotificationsPanelHeader, NotificationsList, NotificationsListEmptyState, NotificationsListErrorState, Notification, NotificationSkeletonItem, activeView, changeActiveView, markNotificationAsRead, markAllNotificationsAsRead, unreadNotificationsCount, hasUnreadNotifications, activeNotifications, onNotificationClick, closeNotificationsPanel, status, error, loadNextPage, hasNextPage, itemHeight, itemsGap, itemPadding, skeletonItemsCount, maxListHeight, }, input)	Default implementation of the NotificationsPanel component.
DefaultNotificationsPanelHeader({ activeView, changeActiveView, markAllNotificationsAsRead, hasUnreadNotifications, unreadNotificationsCount, }, input)	Default implementation of the notifications panel header.
InsightView(props)	Renders insight which was previously created and saved in the Analytical Designer.
isDrillDownDefinition(obj)	*(BETA)* Type-guard testing whether the provided object is an instance of IDrillDownDefinition.
isEmptyAfm(obj)	*(ALPHA)*
isSizeInfo(obj)	*(ALPHA)* Type guard for ISizeInfoDefault
isSizeInfoDefault(obj)	*(ALPHA)* Type guard for ISizeInfoDefault
isVisualizationDefaultSizeInfo(obj)	*(ALPHA)* Type guard for IVisualizationDefaultSizeInfo
NotificationsPanel(props)
provideCreateRoot(_fn)	In order to use React18 for visualization rendering, one has to provide createRoot function. Older React17 render is used by default.

Interfaces

Interface	Description
IDrillDownDefinition	*(BETA)* Information about the DrillDown interaction - the attribute that is next in the drill down hierarchy.
IFluidLayoutDescriptor	*(ALPHA)* Fluid Layout descriptor. Provides parameters of fluid layout.
IInsightTitleProps
IInsightViewProps
ILayerTableDefinition	*(ALPHA)* Defines a single layer’s table conversion result for multi-layer geo charts.
ILayoutDescriptor	*(ALPHA)* Layout descriptor. Provides parameters of used layout.
INotificationComponentProps	Props for the Notification component.
INotificationSkeletonItemComponentProps	Props for the NotificationSkeletonItem component.
INotificationsListComponentProps	Props for the NotificationsList component.
INotificationsListEmptyStateComponentProps	Props for the NotificationsListEmptyState component.
INotificationsListErrorStateComponentProps	Props for the NotificationsListErrorState component.
INotificationsPanelButtonComponentProps	OpenNotificationsPanelButton component props.
INotificationsPanelComponentProps	NotificationsPanel component props.
INotificationsPanelCustomComponentsProps
INotificationsPanelHeaderComponentProps	Props for the NotificationsPanelHeader component.
INotificationsPanelProps
ISizeInfo	*(ALPHA)* Info about min, max and default in layout units. If no value is provided for min/max/default layout will use its generic defaults for it.
IVisualizationDefaultSizeInfo	*(ALPHA)* Info about visualization’s min, max and default for width and height with required default value.
IVisualizationMeta	*(ALPHA)* Metadata of the visualization.
IVisualizationSizeInfo	*(ALPHA)* Info about visualization’s min, max and default for width and height.

Variables

Variable	Description
DefaultNotificationSkeletonItem	Default implementation of the NotificationSkeletonItem component.
fluidLayoutDescriptor	*(ALPHA)*
PluggableVisualizationErrorCodes	*(ALPHA)*

Type Aliases

Type Alias	Description
INotificationsPanelView	View mode of the notifications panel.
ISizeInfoDefault	*(ALPHA)* Info about min, max and default in layout units with required default value.
LayoutType	*(ALPHA)*
PluggableVisualizationErrorType	*(ALPHA)*