Private constructorPrivate Creates an instance of MPFilter.
Optional take: numberHow many of the applicable locations to include.
Optional skip: numberHow many of the applicable locations to skip.
Optional depth: numberThe depth property makes it possible to get the n'th descendant of a parent location.
Thus, the depth property only applies to filters that has set one or more parents. The hierarchical tree of data is generally structured as Venue > Building > Floor > Room > POI.
For example, this means that a Floor is the 1st descendant of a Building. So to get all locations inside a Building, set the [depth] to 3.
The default value is 1, giving you only the immediate descendant of the specified parents.
Optional floorIndex: numberThe floorIndex property makes it possible to get the locations on a specific floor.
Optional categories: string[]A list of categories (keys) from, for example, MPLocation#categories.
Optional locations: string[]A list of location ids to search in.
Optional types: string[]A list of location types to search in.
Optional parents: string[]A list of parent ids.
Optional mapExtend: MPBoundsThe outer bounds of the query.
Optional geometry: MPBoundsA geometry to search inside.
Optional ignoreLocationSearchableStatus: booleanAllows queries to return results that are marked as non-searchable.
Optional ignoreLocationActiveStatus: booleanAllows queries to return results that are marked as inactive using the active from/to mechanism.
Optional categoriesA list of categories (keys) from, for example, MPLocation#categories.
Optional depthThe depth property makes it possible to get the n'th descendant of a parent location.
Thus, the depth property only applies to filters that has set one or more parents. The hierarchical tree of data is generally structured as Venue > Building > Floor > Room > POI.
For example, this means that a Floor is the 1st descendant of a Building. So to get all locations inside a Building, set the [depth] to 3.
The default value is 1, giving you only the immediate descendant of the specified parents.
Optional floorThe floorIndex property makes it possible to get the locations on a specific floor.
Optional geometryA geometry to search inside.
Optional ignoreAllows queries to return results that are marked as inactive using the active from/to mechanism.
Optional ignoreAllows queries to return results that are marked as non-searchable.
Optional locationsA list of location ids to search in.
Optional mapThe outer bounds of the query.
Optional parentsA list of parent ids.
Optional skipHow many of the applicable locations to skip.
Optional takeHow many of the applicable locations to include.
Optional typesA list of location types to search in.
Static createCreator for MPError, invoke with 0 parameters to apply an empty filter.
Optional object: MPFilterParamsGenerated using TypeDoc
A filter that can be applied during search, this will limit the returned MPEntitys to those that fulfills the filter.
Export