withFilterContext()
Home > @gooddata/sdk-ui-loaders > IDashboardLoader > withFilterContext
IDashboardLoader.withFilterContext() method
Override filter context to use for the loaded dashboard.
Signature:
withFilterContext(filterContextRef: ObjRef): IDashboardLoader;
Parameters
Parameter | Type | Description |
---|---|---|
filterContextRef | ObjRef | reference to filter context to use instead of the default filter context |
Returns:
Remarks
Note: Each dashboard has its own, default filter context - that filter context will be used automatically unless you override it using this call. You typically don't need to do this: filter context overrides are needed most commonly during export and scheduled exports - where application has to create point-in-time snapshot of the filters so that they can be reused during exports instead of the default filter context.