Interface FilterInterface

Filter builder, to be used with filter

Hierarchy

FilterInterface
- PoiFilterInterface
- ImageFilterInterface

Index

Methods

boundingBox build limit offset siteModel sortBy sortOrder step

Methods

boundingBox

boundingBox(xMin, yMin, xMax, yMax): FilterInterface
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 FilterInterface

build

build(): RestFilterInterface
Construct the filter

Returns RestFilterInterface
The filter

limit

limit(limit): FilterInterface
Return the specified maximum number of items.
Parameters
- limit: number
  
  Maximum number of items to return.
Returns FilterInterface

offset

offset(offset): FilterInterface
Skip the specified number of items.
Parameters
- offset: number
  
  Number of items to skip.
Returns FilterInterface

siteModel

siteModel(entities): FilterInterface
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
- entities: SiteModelEntityInterface[]
  
  List of site model entities.
Returns FilterInterface

sortBy

sortBy(field): FilterInterface
Sort results by the specific field name.
Parameters
- field: string
  
  Field name to sort by.
Returns FilterInterface

sortOrder

sortOrder(order): FilterInterface
Sort results in the specific order (ascending or descending).
Parameters
- order: SortOrder
  
  Sort order.
Returns FilterInterface

step

step(step): FilterInterface
Regularly subsample the list of items returned.
Parameters
- step: number
  
  Step size, where 1 returns every item, 2 returns every other item, etc.
Returns FilterInterface

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

Generated using TypeDoc