Interface IvionInterface

Hierarchy

  • IvionInterface

Methods

getLanguage getMainView getMapView getMenuItems getPoiRepository getPoiTypeRepository getShareUrl isLicensed isMoving moveToDataset moveToGeoLocation moveToImage moveToImageId moveToPoi moveToPoiId moveToSiteModelEntity moveToSiteModelEntityId moveToStartingLoc reinit resetView setLanguage setPoiTypesVisibility

Methods

getLanguage

  • Get language (example: returns en for English).

    Returns

    Language key. See setLanguage for the list of supported languages.

    Returns string

getMainView

getMapView

getMenuItems

  • Menu items organized in a tree structure with an array on the root level.

    Supported actions that can be performed on the retrieved items structure:

    • Adding new items in any place of the tree
    • Updating existing items
    • Deleting existing items

    Returns

    Menu items

    Returns SidebarMenuItemInterface[]

getPoiRepository

getPoiTypeRepository

getShareUrl

  • Get share URL containing information about current image, longitude and latitude.

    Returns

    Share URL.

    Returns string

isLicensed

  • Checks whether the instance key includes the module for the frontend API.

    Returns

    Whether frontend API is included in the license

    Returns boolean

isMoving

  • Return whether the view is currently being moved to another location, e.g., because moveToImage() had been called earlier.

    Returns

    Movement active.

    Returns boolean

moveToDataset

  • Moves user to a specified dataset. If image file ID is given, move is done to that image in dataset.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    • datasetId: number

      Dataset's ID.

    • Optional imageFileId: number

      ID of image file. If not given or not found, first image from dataset is used.

    • Optional viewDir: ViewOrientationInterface

    Returns Promise<void>

moveToGeoLocation

  • Move to specified geographic location by locating the closest image floor location and moving the view there. Images without geo-registration (i.e. where location is null) are ignored. If no image is found nearby but the location is still contained in a dataset, the view will be moved to the exact location and the point cloud will be activated.

    Note

    If viewDir is undefined, the viewing direction is determined automatically.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    • loc: Vector3

      Geographic location in WGS-84 or local

    • isLocal: boolean

      If false, coordinate is transformed from WGS-84 to local

    • viewDir: ViewOrientationInterface

      View orientation. If undefined, camera is oriented to view the location.

    • fixedLat: number

      If is not undefined then this value will override the viewing direction's latitude value.

    • fov: number

      Field of view as number. If undefined, the FOV is left unchanged.

    • normal: Vector3

      Normal vector of the destination. Used to determine if destination is floor/wall/ceiling.

    • forceLoc: boolean

      Flag to force movement to specified location even if an image is found nearby.

    • Optional sameFloor: boolean

      If true, only images of the current floor are considered as destination.

    Returns Promise<void>

moveToImage

  • Moves user to an image's location.

    Note

    If viewDistance is not specified, a server-side raycast query for the center of the screen is performed in order to find the scene depth (assuming the user is focusing on the screen center).

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    • image: ImageInterface

      Image object.

    • Optional viewDir: ViewOrientationInterface

      View orientation. If undefined, current view direction is left unchanged.

    • Optional viewDistance: number

      Radius parameter. Image meshes are scaled to this radius before animation starts.

    • Optional fov: number

      Field of view as float. If undefined, the FOV is left unchanged.

    Returns Promise<void>

moveToImageId

  • Moves user to an image's location, uses numerical ID of the image object.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    • imageId: number

      Image's ID. If not provided or undefined, defaults to first image.

    • viewDir: ViewOrientationInterface

      View orientation. If undefined, current view direction is left unchanged.

    • fov: number

      Field of view as float. If undefined, the FOV is left unchanged.

    Returns Promise<void>

moveToPoi

  • Moves user to a location closest to the POI and sets the viewing direction such that the user is looking at the POI.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    • poi: PoiInterface

      The POI object.

    • hideDetails: boolean

      By default NavVis IVION auto opens POI details panel, If true then that action is prevented.

    • viewDir: ViewOrientationInterface

      View orientation. If undefined, the default direction is used.

    • fov: number

      Field of view as float. If undefined, the FOV is left unchanged.

    Returns Promise<void>

moveToPoiId

  • Similar to moveToPoi, uses numerical ID of POI.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    • poiId: number

      The POI's ID.

    • hideDetails: boolean

      By default NavVis IVION auto opens POI details panel, If true then that action is prevented.

    • viewDir: ViewOrientationInterface

      View orientation. If undefined, the default direction is used.

    • fov: number

      Field of view as float. If undefined, the FOV is left unchanged.

    Returns Promise<void>

moveToSiteModelEntity

  • Moves user to the center of a specified site model entity.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    Returns Promise<void>

moveToSiteModelEntityId

  • Moves user to the center of a specified site model entity.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Parameters

    • entityId: number

      ID of the entity to move to.

    • showDetails: boolean

      Whether to open the details panel or not.

    • Optional viewDir: ViewOrientationInterface

      View orientation. If undefined, the direction is not changed.

    Returns Promise<void>

moveToStartingLoc

  • Move to configured starting location.

    Returns

    Promise that is resolved when the moving transition is completely finished.

    Returns Promise<void>

reinit

  • Reinitialize NavVis IVION instance and re-fetch all data from database.

    Returns

    Promise that is resolved when the NavVis IVION instance has reinitialized. The promise will not be rejected.

    Returns Promise<void>

resetView

  • Moves the camera/user back to the center of the last visited image's sphere.

    Returns void

setLanguage

  • Set language (example: en for English).

    Parameters

    • key: string

      Language key. Supported language keys are:

      • cs: Czech
      • en: English
      • es: Spanish
      • de: German
      • ja: Japanese
      • zh: Simplified Chinese
      • zh_tw: Traditional Chinese

    Returns void

setPoiTypesVisibility

  • Set visibility for all or only given POI types.

    Parameters

    • visible: boolean

      true to show and false to hide POI types. If parameter is not correct boolean type, function has no effect

    • Optional types: number[]

      Array with POI type IDs to set visibility. If not given, all POI types are set

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc