Interface PoiFilterInterface

Filter builder for POIs, to be used with RestRepositoryInterface.filter

interface PoiFilterInterface {
    attributes(attributes: Dictionary<string>): this;
    boundingBox(xMin: number, yMin: number, xMax: number, yMax: number): this;
    build(): RestFilterInterface;
    limit(limit: number): this;
    offset(offset: number): this;
    poiType(poiTypes: PoiTypeInterface[]): this;
    poiTypeGroup(poiTypeGroups: PoiTypeGroupInterface[]): this;
    siteModel(entities: SiteModelEntityInterface[]): this;
    sortBy(field: string): this;
    sortOrder(order: SortOrder): this;
    step(step: number): this;
}

Hierarchy (view full)

Methods

attributes boundingBox build limit offset poiType poiTypeGroup siteModel sortBy sortOrder step

Methods

attributes

  • attributes(attributes): this

  • Return only items with an attribute value matching the specified values.

    If multiple attribute key value pairs are supplied, only points of interest that have attribute values matching ALL key value pairs in the dictionary are returned.

    Parameters

    • attributes: Dictionary<string>

      The attribute values

    Returns this

boundingBox

  • boundingBox(xMin, yMin, xMax, yMax): this

  • Return only items that are inside the specified bounding box.

    Parameters

    • xMin: number

      Lower X coordinate.

    • yMin: number

      Lower Y coordinate.

    • xMax: number

      Upper X coordinate.

    • yMax: number

      Upper Y coordinate.

    Returns this

build

limit

  • limit(limit): this

  • Return the specified maximum number of items.

    Parameters

    • limit: number

      Maximum number of items to return.

    Returns this

offset

  • offset(offset): this

  • Skip the specified number of items.

    Parameters

    • offset: number

      Number of items to skip.

    Returns this

poiType

  • poiType(poiTypes): this

  • Return only items that are of the specified type(s)

    Multiple types can be provided, the item's type has to match one of them.

    Parameters

    Returns this

poiTypeGroup

  • poiTypeGroup(poiTypeGroups): this

  • Return only items that have a type that is part of the specified type group(s)

    Multiple type groups can be provided, the item's type has to be part of one of them.

    Parameters

    Returns this

siteModel

  • siteModel(entities): this

  • Return only items that are inside the specified site model entity.

    Multiple entities can be provided, the item has to be contained in only one of them. Specify undefined to include items that are in no site model entity.

    This method can be called multiple times.

    Parameters

    Returns this

sortBy

  • sortBy(field): this

  • Sort results by the specific field name.

    Parameters

    • field: string

      Field name to sort by.

    Returns this

sortOrder

  • sortOrder(order): this

  • Sort results in the specific order (ascending or descending).

    Parameters

    Returns this

step

  • step(step): this

  • Regularly subsample the list of items returned.

    Parameters

    • step: number

      Step size, where 1 returns every item, 2 returns every other item, etc.

    Returns this

    Deprecated

    use with items with non-sequential IDs might lead to inconsistent results

Settings

Member Visibility

On This Page

Methods