drillToCustomUrl()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the IDrillToCustomUrl command. Dispatching this command will result into resolving the target url and dispatching IDashboardDrillToCustomUrlResolved event that will contain it.
Custom url can contain various identifier or attribute title placeholders, see: https://help.gooddata.com/pages/viewpage.action?pageId=86794855
export declare function drillToCustomUrl(drillDefinition: IDrillToCustomUrlModel, drillEvent: IDashboardDrillEvent, correlationId?: string): IDrillToCustomUrl;
Parameters
Parameter | Type | Description |
|---|---|---|
drillDefinition | drill definition with the target 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 custom url command