Module Filter

Adds a filter. The list of available metadata schema items can be retieved by calling JMap.Layer.getMetadataSchema.

example

// add a filter to the config
JMap.Application.Layer.Tree.Filter.add({
 1,
 metadataItemId: 0,
 type: "date",
 operator: "between",
 value: [new Date("2021-06-02T00:00:00"),new Date("2021-06-22:T00:00:00")]
})

Applies the current filter configuration on the map. All layers not matching the filter will be hidden, and only those that match the filter will stay visible on the map. If no filter is defined (or appliable), no change is applied on the map.

example

// Apply the current filter
JMap.Application.Layer.Tree.Filter.applyToMap()

Closes the Add Filter dialog box (without saving the filter).

example

// close Add Filter UI
JMap.Application.Layer.Tree.Filter.closeAddFilterDialog()

Removes the specified filter from the filter configuration.

example

// delete filter id=1
JMap.Application.Layer.Tree.Filter.deleteById(1)

Tests if the specified filter exists.

example

// create a filter
JMap.Application.Layer.Tree.Filter.add({
 1,
 metadataItemId: 0,
 type: "date",
 operator: "between",
 value: [new Date("2021-06-02T00:00:00"),new Date("2021-06-22:T00:00:00")]
})

// will return true
JMap.Application.Layer.Tree.Filter.existById(1)

Returns an object containing the current name filter and an array of all current filters.

example

// get filters configuration
console.log(JMap.Application.Layer.Tree.Filter.getAll())
// {
//   "nameFilter":"Mont",
//   "filters":[
//     {"id":1,
//       "metadataItemId":0,
//       "operator":"between",
//       "type":"date",
//       "value":[
//       "2021-06-01T10:25:00.000Z",
//       "2021-06-22T10:25:00.000Z"
//       ]
//     }
//   ]
// }

Retrieves the specified filter by id.

example

// get filter id=1
JMap.Application.Layer.Tree.Filter.getById(1)
// {"id":1,
//   "metadataItemId":0,
//   "operator":"between",
//   "type":"date",
//   "value":[
//     "2021-06-01T10:25:00.000Z",
//     "2021-06-22T10:25:00.000Z"
//   ]
// }

Tests if the layer tree filters are active.

Layer tree filters are active, but initially not applied, when the user activates the Filter user interface either by clicking on a button or by calling a JMap NG API method to activate it. See JMap.Application.Layer.Tree.Filter.isApplied for more details.

example

// activate the filters
JMap.Application.Layer.Tree.Filter.setActive(false)

// will return false
JMap.Application.Layer.Tree.Filter.isActive()

Tests if the layer tree filters are applied.

Layer tree filters are applied (in action) only if the filtering is active (JMap.Application.Layer.Tree.Filter.isActive returns true) and either one of those two conditions are met:

a) the name filter contains at least 2 characters b) one of the layer filters has been added to the filtering configuration

example

// filter configuration is initially empty

// activate the filters
JMap.Application.Layer.Tree.Filter.setActive(true)

// set the name filter to "a"
JMap.Application.Layer.Tree.Filter.setName("a")

// will return false
const isFilterApplied = JMap.Application.Layer.Tree.Filter.isApplied()

Tests if at least one filter associated with the specified metadata id exists.

example

// filter collection is initially empty

// create a filter
JMap.Application.Layer.Tree.Filter.add({
 1,
 metadataItemId: 0,
 type: "date",
 operator: "between",
 value: [new Date("2021-06-02T00:00:00"),new Date("2021-06-22:T00:00:00")]
})

// will return false
JMap.Application.Layer.Tree.Filter.oneFilterExistForMetadataId(6)

Opens the Add Filter dialog box, and activates the Layer panel if it is not already active.

example

// open Add Filter UI
JMap.Application.Layer.Tree.Filter.openAddFilterDialog()

Tests if the layer tree filters are active.

Layer tree filters are active, but initially not applied, when the user activates the Filter user interface either by clicking on a button or by calling a JMap NG API method to activate it. See JMap.Application.Layer.Tree.Filter.isApplied for more details

example

// activate the filters
JMap.Application.Layer.Tree.Filter.setActive(false)

// will return false
JMap.Application.Layer.Tree.Filter.isActive()

Sets the name filter. Name filter needs to have at least 2 characters to be applied.

Panel layer will show only layers whose name matches the name filter. The name filter is case-insensitive and diacritical characters insensitive.

example

// In the layer panel will display only layers whose name matches "pro" (case-insensitive)
JMap.Application.Layer.setName("pro")