drillToAttributeUrl()
Home > @gooddata/sdk-ui-dashboard > drillToAttributeUrl
drillToAttributeUrl() 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.
Creates the IDrillToAttributeUrl command. Dispatching this command will result into resolving the target attribute url and dispatching IDashboardDrillToAttributeUrlResolved event that will contain it.
For more details, see: https://help.gooddata.com/pages/viewpage.action?pageId=86794855
Signature:
export declare function drillToAttributeUrl(drillDefinition: IDrillToAttributeUrlModel, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillToAttributeUrl;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
drillDefinition |
drill definition with the target attribute url to resolve. | |
|
drillEvent |
original drill event, that triggered this particular drill interaction. | |
|
correlationId |
string |
(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing. |
Returns:
drill to attribute url command