Interface ImageFilterInterface

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

interface ImageFilterInterface {
    boundingBox(xMin: number, yMin: number, xMax: number, yMax: number): this;
    build(): RestFilterInterface;
    hidden(status: boolean): this;
    hideOverlappingData(hideOverlappingData: boolean): this;
    limit(limit: number): this;
    offset(offset: number): this;
    siteModel(entities: SiteModelEntityInterface[]): this;
    sortBy(field: string): this;
    sortOrder(order: SortOrder): this;
    spacing(spacing: number): this;
    step(step: number): this;
}

Hierarchy (view full)

Methods

boundingBox build hidden hideOverlappingData limit offset siteModel sortBy sortOrder spacing step

Methods

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

hidden

  • hidden(status): this

  • Return only items that have the hidden flag set to the specified value.

    Parameters

    • status: boolean

    Returns this

hideOverlappingData

  • hideOverlappingData(hideOverlappingData): this

  • Parameters

    • hideOverlappingData: boolean

    Returns this

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

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

spacing

  • spacing(spacing): this

  • Return only images that are at least the given distance apart. This filter is 2D, i.e., the Z coordinate is ignored.

    Parameters

    • spacing: number

      Minimum distance between images [m].

    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