NavVis IVION API
    Preparing search index...

    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;
        epano(includeEpanoImages: boolean): this;
        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 Summary)

    Index

    Methods

    boundingBox build epano hidden hideOverlappingData limit offset siteModel sortBy sortOrder spacing step

    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

    • Whether the images returned should be just epanos, or normal images, Not specifying this filter will return all types of images.

      Parameters

      • includeEpanoImages: boolean

        Whether to include epano, or normal images

      Returns this

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

      Parameters

      • status: boolean

      Returns this

    • Parameters

      • hideOverlappingData: boolean

      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

    • 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

    • 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

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

    Settings

    Member Visibility

    On This Page

    Methods