Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImageFilterInterface

Filter builder for images, to be used with {@link RestRepository.filter}

Hierarchy

Index

Methods

boundingBox

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

build

hidden

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

    Parameters

    • status: boolean

    Returns ImageFilterInterface

limit

offset

siteModel

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

sortBy

sortOrder

spacing

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

step

  • Regularly subsample the list of items returned.

    deprecated

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

    Parameters

    • step: number

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

    Returns ImageFilterInterface

Generated using TypeDoc