Interface MPFilterParams

Parameter interface for MPFilter.

Export

MPFilterParams

interface MPFilterParams {
    categories?: string[];
    depth?: number;
    floorIndex?: number;
    geometry?: MPBounds;
    ignoreLocationActiveStatus?: boolean;
    ignoreLocationSearchableStatus?: boolean;
    locations?: string[];
    mapExtend?: MPBounds;
    parents?: string[];
    skip?: number;
    take?: number;
    types?: string[];
}

Properties

categories? depth? floorIndex? geometry? ignoreLocationActiveStatus? ignoreLocationSearchableStatus? locations? mapExtend? parents? skip? take? types?

Properties

Optional categories

categories?: string[]

A list of categories (keys) from, for example, MPLocation#categories.

Optional depth

depth?: number

The 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

floorIndex?: number

The floorIndex property makes it possible to get the locations on a specific floor.

Optional geometry

geometry?: MPBounds

A geometry to search inside.

Optional ignoreLocationActiveStatus

ignoreLocationActiveStatus?: boolean

Allows queries to return results that are marked as inactive using the active from/to mechanism.

Optional ignoreLocationSearchableStatus

ignoreLocationSearchableStatus?: boolean

Allows queries to return results that are marked as non-searchable.

Optional locations

locations?: string[]

A list of location ids to search in.

Optional mapExtend

mapExtend?: MPBounds

The outer bounds of the query.

Optional parents

parents?: string[]

A list of parent ids.

Optional skip

skip?: number

How many of the applicable locations to skip.

Optional take

take?: number

How many of the applicable locations to include.

Optional types

types?: string[]

A list of location types to search in.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc