IDashboardFilterView
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Interface that represents saved dashboard filter view created for a specific dashboard by a specific user.
There should always be just one default filter view for the user and the dashboard at any given time. The consistency must be handled by backend or client. The reason why the flag cannot be on the dashboard is that each user can have a different default filter view per dashboard and also the filter views can be created by users that have only VIEW permission for the workspace and cannot modify the dashboard object.
export interface IDashboardFilterView
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (ALPHA) | ||
| (ALPHA) | ||
| boolean | (ALPHA) (Optional) | |
| string | (ALPHA) | |
| (ALPHA) (Optional) Dashboard parameter overrides captured at the time the view was saved. Absent when the view was saved before parameters were supported. | ||
| (ALPHA) | ||
| string | (ALPHA) (Optional) | |
| (ALPHA) |
Property details
IDashboardFilterView.dashboardpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly dashboard: ObjRef;
IDashboardFilterView.filterContextpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly filterContext: IFilterContextDefinition;
IDashboardFilterView.isDefaultpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly isDefault?: boolean;
IDashboardFilterView.namepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly name: string;
IDashboardFilterView.parameterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard parameter overrides captured at the time the view was saved. Absent when the view was saved before parameters were supported.
readonly parameters?: IDashboardParameter[];
IDashboardFilterView.refpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly ref: ObjRef;
IDashboardFilterView.tabLocalIdentifierpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly tabLocalIdentifier?: string;
IDashboardFilterView.userpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly user: ObjRef;