Filter Functions

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.

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.

JavaScript

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

Python

# Adding the filter to the map
map.add_filter(PartialRangeFilter(
    sources=[PartialFilterSource(
        data_id="test-dataset-filter",
        field_name="Magnitude"
    )],
    value=(4,5)
))

Arguments

Add Filter From Config

Add a filter to the map based on its JSON config. These methods can use the content of filter JSON editors directly.

JavaScript

addFilterFromConfig(filterConfig: FilterCreationFromConfigProps): Filter

Python

add_filter_from_config(
  self,
  filter_config: Union[Dict, str]
) -> Filter:

Arguments

Get Filter by ID

Retrieve a filter by passing its id.

JavaScript

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

Python

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

Arguments

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.

JavaScript

filters = map.getFilters();

Python

filters = map.get_filters()

Remove Filter

Remove a filter by passing its filterId.

JavaScript

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

Python

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

Arguments

Update Filter

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

JavaScript

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

Python

map.update_filter(
    "filter-id",
    PartialRangeFilter(
        value=(4, 5),
    ),
)

Arguments

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:

JavaScript

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

Python

map.update_timeline("filter-id", FilterTimelineUpdateProps(
    view="side",
    is_animating=True
))

Arguments