Interface PoiFilterInterface

Filter builder for POIs, to be used with filter

Hierarchy

Methods

  • 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 PoiFilterInterface

  • 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 PoiFilterInterface

  • 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 PoiFilterInterface

  • 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 PoiFilterInterface

  • Regularly subsample the list of items returned.

    Parameters

    • step: number

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

    Returns PoiFilterInterface

    Deprecated

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

Generated using TypeDoc