Skip to content

EodashItemFilter

A collection-level search and filter panel. It wraps eox-itemfilter and populates it with the top-level STAC catalog links (child collections in catalog mode, or all items in API mode). Selecting an entry loads the corresponding collection or item into the active or compare map. It emits a select event when the user picks a result.

Example

Minimal usage with default filters:

js
{
  id: "item-filter",
  title: "Indicators",
  type: "internal",
  layout: { x: 0, y: 0, w: 3, h: 12 },
  widget: {
    name: "EodashItemFilter",
    properties: {
      filtersTitle: "Indicators",
      resultsTitle: "Results",
    },
  },
}

Compare-mode variant that loads the selection into the second map:

js
widget: {
  name: "EodashItemFilter",
  properties: {
    enableCompare: true,
    filtersTitle: "Compare dataset",
    titleProperty: "title",
  },
}

Properties

aggregateResults?

ts
optional aggregateResults?: string = undefined;

cssVars?

ts
optional cssVars?: string | Record<string, any> = "";

enableCompare?

ts
optional enableCompare?: boolean = false;

enableHighlighting?

ts
optional enableHighlighting?: boolean = true;

expandMultipleFilters?

ts
optional expandMultipleFilters?: boolean = true;

expandMultipleResults?

ts
optional expandMultipleResults?: boolean = true;

filterProperties?

ts
optional filterProperties?: object[] = [ { keys: ["title", "themes", "description"], title: "Search by name or description", type: "text", expanded: true, }, { key: "themes", title: "Filter by theme", type: "multiselect", expanded: true, }, ];

expanded?

ts
optional expanded?: boolean;

keys

ts
keys: string[];

title

ts
title: string;

type

ts
type: string;

filtersTitle?

ts
optional filtersTitle?: string = "Indicators";

imageProperty?

ts
optional imageProperty?: string = "";

onSelect?

ts
optional onSelect?: (...args) => any;

Parameters

args

...any[]

Returns

any


resultsTitle?

ts
optional resultsTitle?: string = "Results";

resultType?

ts
optional resultType?: string = "";

styleOverride?

ts
optional styleOverride?: string = "";

subTitleProperty?

ts
optional subTitleProperty?: string = "";

titleProperty?

ts
optional titleProperty?: string = "title";

Filter properties (filterProperties)

Each entry in filterProperties configures one filter section. The default provides a free-text search and a multiselect on themes.

FieldTypeDescription
keys / keystring | string[]STAC property key(s) matched by this filter. Use keys (array) for text search across multiple fields, key (string) for discrete filters.
titlestringLabel shown above the filter control.
typestringControl type: "text", "multiselect", "select", "range", etc.
expandedbooleanWhether the filter section starts open.

See also