Skip to main content
Version: 0.7.3


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

UnfoldedMap.setFilter(info: FilterInfo): Promise<boolean>
type FilterInfo = {
id: string;
dataId?: string;
field: string;
value: FilterValueType;


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