getWidgetReferencedObjects()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > getWidgetReferencedObjects

IWorkspaceDashboardsService.getWidgetReferencedObjects() method

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get all metadata objects referenced by a given widget.

Signature:

getWidgetReferencedObjects(widget: IWidget, types?: SupportedWidgetReferenceTypes[]): Promise<IWidgetReferences>;

Parameters

Parameter	Type	Description
widget	IWidget	widget to get referenced objects for
types	SupportedWidgetReferenceTypes[]	(Optional) optional array of object types to include, when not specified, all supported references will be retrieved

Returns:

Promise<IWidgetReferences>