Interface FilterInterface

Filter builder, to be used with RestRepositoryInterface.filter

interface FilterInterface {
    boundingBox(xMin, yMin, xMax, yMax): this;
    build(): RestFilterInterface;
    limit(limit): this;
    offset(offset): this;
    siteModel(entities): this;
    sortBy(field): this;
    sortOrder(order): this;
    step(step): this;
}

Hierarchy (view full)

Methods

  • 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

  • Return the specified maximum number of items.

    Parameters

    • limit: number

      Maximum number of items to return.

    Returns this

  • Skip the specified number of items.

    Parameters

    • offset: number

      Number of items to skip.

    Returns 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

  • Sort results by the specific field name.

    Parameters

    • field: string

      Field name to sort by.

    Returns this

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

    Parameters

    Returns 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

Generated using TypeDoc