GoodData.UI API reference
  • GoodData.UI
  • Docs & APIs
  • Developers
  • GoodData.CN
  • GoodData.UI
  • Docs & APIs
  • Get GoodData.CN Community Edition
  • 10.26.0
  • Code samples
  • Gallery
  • GitHub

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

ParameterTypeDescription
filterContextRefObjRefreference to filter context to use instead of the default filter context

Returns:

IDashboardLoader

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.

  • IDashboardLoader.withFilterContext() method
  • Parameters
  • Remarks
GoodData resources:
  • Documentation
Follow the community:
  • Community
Copyright © 2007–2025 GoodData Corporation. All Rights Reserved. Code licensed under a dual license - CC BY‑NC 4.0 for trial experience and GoodData.UI EULA for commercial use