Type Alias: SimplifiedFilter

SimplifiedFilter: object

Simplified filter format that accepts Field objects and parameters directly, eliminating the need for manual filter object construction.

optional dataSource: DataSource

The DataSource object. Required for dashboards with multiple data sources.

field: Field

Required. The Field object returned from getFields(). The fieldName is constructed automatically.

operator: FilterOperator

Required. The filter operator. This must be a FilterOperator enum value.

optional values: FilterValues | string | number | boolean | Date

The filter values. Single values are automatically wrapped in arrays.

1import { FilterOperator } from "@salesforce/analytics-embedding-sdk";
2import type { SimplifiedFilter } from "@salesforce/analytics-embedding-sdk";
3
4const filter: SimplifiedFilter = {
5  field: { apiName: "Name", objectName: "Account", dataType: "text", fieldType: "Dimension" },
6  operator: FilterOperator.Equals,
7  values: "Acme Corp", // or array: ["Acme Corp"]
8  dataSource: { apiName: "SalesData" }, // optional for dashboards
9};
10
11await component.applyFilters([filter]);