Filters are used to define custom ranges on your map's datasets. In addition, time filters can be leveraged to animate data over a span of time.

Add Filter

Apply a new filter to the map. This function requires that you specify a filter id, id, one or more sources (including a dataId and fieldName), and a value.

Filter Type	Description
`'range'`	A filter limiting data to values within a specified range.
`'select'`	A filter limiting data to values that match one specific criteria. Can be a specific number, string, or boolean
`'time-range'`	A filter limiting data to only that which falls within a range of time.
`'multi-select'`	A filter limiting data to values that match one or more criteria.
`'polygon'`	A filter limiting data to values that fall within a GeoJSON Polygon feature.

The value is restricted by the type of filter selected. For instance, 'range' filters support a value range in an array (e.g. [4,5], while a select filter will only support a single criteria.

map.addFilter({
  type: "range",
  sources: [
    {
      dataId: "test-dataset-filter",
      fieldName: "Magnitude",
    },
  ],
  value: [4, 5],
});

# Adding the filter to the map
map.add_filter(
  type="range",
  sources=[...],
  value=(0, 100)
)

Arguments

Note: Python Arguments require Python syntax and snake_case parameter names.

Argument	Type	Description
`filter`	`object`	An object containing filter details.
`filter.id`	`string`	Unique identifier of the filter.
`filter.type`	`string`	Type of filter to create. See list above.
`filter.sources`	`object array`	An array of filter sources. Only `TimeRangeFilter` supports multiple sources.
`filter.sources.data_id`	`string`	The unique identifier for the dataset to filter.
`filter.sources.field_name`	`string`	The name of the field containing the data to filter.
`filter.value`	`string`, `number`, `timestamp`, `array`	The values to use in the filter. For more information, see the `Filter` object.

For more information, including full Python documentation, see addFilter() in the full API reference.

Get Filter by ID

Retrieve a filter by passing its id.

filter = map.getFilterById("test-filter-01");

filter = map.get_filter_by_id('test-filter-01')

Arguments

Note: Python Arguments require Python syntax and snake_case parameter names.

Argument	Type	Description
`filterId`	`string`	The identifier for the filter to retrieve.

For more information, including full Python documentation, see getFilterById() in the full API reference.

Get Filters

Retrieve a list of all filters available on the map. Filters are returned as an array of Filter objects, containing each filter's id, public facing label and color, as well as other settings applied to the filters.

filters = map.getFilters();

filters = map.get_filters()

For more information, including full Python documentation, see getFilters() in the full API reference.

Remove Filter

Remove a filter by passing its filterId.

map.removeFilter("test-filter-01");

map.remove_filter('test-filter-01')

Arguments

Note: Python Arguments require Python syntax and snake_case parameter names.

Argument	Type	Description
`filterId`	`string`	The identifier for the filter to remove.

For more information, including full Python documentation, see removeFilter() in the full API reference.

Update Filter

Update an existing filter by passing its id along the settings you wish to update.

map.updateFilter("test-filter-1", {
  type: "range",
  sources: [
    {
      dataId: "test-dataset-filter",
      fieldName: "Magnitude",
    },
  ],
  value: [5, 6],
});

# Updating the existing filter on the map
map.update_filter(
  "test-filter-1",
  type = "range",
  source = [{"data_id": DATASET_UUID, "field_name": "test"}],
  value = (0,100)
)

Arguments

Note: Python Arguments require Python syntax and snake_case parameter names.

Argument	Type	Description
`filterId`	`string`	Unique identifier of the filter to update.
`filter`	`object`	An object containing filter details.
`filter.type`	`string`	Type of filter to create. See list above.
`filter.sources`	`object array`	An array of filter sources. Only `TimeRangeFilter` supports multiple sources.
`filter.sources.data_id`	`string`	The unique identifier for the dataset to filter.
`filter.sources.field_name`	`string`	The name of the field containing the data to filter.
`filter.value`	`string`, `number`, `timestamp`, `array`	The values to use in the filter. For more information, see the `Filter` object.

For more information, including full Python documentation, see updateFilter() in the full API reference.

Update Timeline

Updates an animated timeline by passing the associated time filter's id. The filter timeline object has options for several time formatting and animation settings:

map.updateTimeline("test-timeline-1", {
  timeFormat: "DD/MM/YYYY",
  isAnimating: false,
});

map.update_timeline(
  "test-timeline-1",
    time_format =  "DD/MM/YYYY",
    is_animating: False
)

Arguments

Note: Python Arguments require Python syntax and snake_case parameter names.

Argument	Type	Description
`filterId`	`string`	Unique identifier of the filter with the timeline to update.
`values`	`object`	An object containing parameters used to update the filter timline.
`values.view`	`string`	Current timeline presentation.
`values.timeFormat`	`string`	Time format that the timeline is using in day.js supported format.
`values.timezone`	`string`	Timezone that the timeline is using in tz format.
`values.isAnimating`	`boolean`	Flag indicating whether the timeline is animating or not.
`values.animationSpeed`	`number`	Speed at which timeline is animating.
`values.step`	`number`	Minimum animation step size in milliseconds.

For more information, including full Python documentation, see updateTimeline() in the full API reference.