Filters

Using the addFilter(...) API function user can set and apply filtering on added layers (based on datasets).

addFilter(filter: FilterCreationProps): Filter

type FilterCreationProps = {
  id: string;
  type: 'range' | 'select' | 'time-range' | 'multi-select' | 'polygon';
  sources: {
    dataId?: string;
    fieldName: string;
  };
  value: Range | boolean | Range | string[] | Feature;
};

Parameters

• Name	Description
  id string id id	Unique filter id
  'type' string Filter type range Filter type
  dataId string dataId dataId	(Optional) Dataset id (if omitted, the first dataset which has a field with the name specified in field will be used)
  fieldName string fieldName fieldName	Name of the field to apply the filter to
  value FilterValueType value value	Filter value (the type depends on the filter kind, e.g. an array of two numbers for a range filter)