selectFilterableWidgetByRef()
Home > @gooddata/sdk-ui-dashboard > selectFilterableWidgetByRef
selectFilterableWidgetByRef() function
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.
Selects filterable widget by its ref (including custom widgets). This selector will return undefined if the provided ref to non-filterable widget.
Signature:
selectFilterableWidgetByRef: (ref: ObjRef | undefined) => DashboardSelector<IWidget | ICustomWidget | undefined>
Parameters
Parameter | Type | Description |
---|---|---|
ref | ObjRef | undefined |
Returns:
DashboardSelector<IWidget | ICustomWidget | undefined>
Remarks
To limit the scope only to analytical widgets, use selectAnalyticalWidgetByRef().