Options
All
  • Public
  • Public/Protected
  • All
Menu

NavVis IVION API

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

ActiveSiteSelectedHandler

ActiveSiteSelectedHandler: (selectedSite: SiteInterface, oldSite: SiteInterface) => void

Type declaration

    • Signal handler for active site selected events

      Parameters

      • selectedSite: SiteInterface

        The new active site (may be undefined)

      • oldSite: SiteInterface

        The previously active site (may be undefined)

      Returns void

AuthenticationChangedHandler

AuthenticationChangedHandler: (user: UserEntityInterface, isDataAccessible: boolean) => void

Type declaration

    • Signal handler that is called after a user logged in or out.

      Parameters

      • user: UserEntityInterface

        User after the authentication changed. Will be a "guest" user after logging out.

      • isDataAccessible: boolean

        Whether data is accessible or not. Will be true, if a user just logged in. Otherwise data is only accessible if private mode is not enabled.

      Returns void

FloorChangeHandler

FloorChangeHandler: (event: FloorChangeEventInterface) => void

Type declaration

FloorUpdateHandler

FloorUpdateHandler: (event: FloorUpdateEventInterface) => void

Type declaration

LanguageChangeHandler

LanguageChangeHandler: (language: Language) => void

Type declaration

    • Signal handler that is called when the user interface language is changed.

      Parameters

      • language: Language

        The new user interface language.

      Returns void

OnContextMenuResult

OnContextMenuResult: ContextMenuEntryInterface | ContextMenuEntryInterface[] | boolean | undefined

PoiClickHandler

PoiClickHandler: (poi: PoiInterface, origin: PoiClickOrigin) => boolean

Type declaration

    • Signal handler that is called when a user clicks the POI either in the scene or UI. Return true in order to consume the event and prevent the default on POI click action. Return false to let the default action proceed.

      Parameters

      Returns boolean

PoiCloseHandler

PoiCloseHandler: (poi: PoiInterface) => void

Type declaration

    • Signal handler that is called when the POI details panel is closed.

      Parameters

      Returns void

PoiDeleteHandler

PoiDeleteHandler: (poi: PoiInterface) => void

Type declaration

    • Signal handler that is called when a POI is deleted.

      Parameters

      Returns void

PoiHighlightHandler

PoiHighlightHandler: (pois: PoiInterface[]) => void

Type declaration

    • Signal handler that is called when POIs are highlighted in scene.

      Parameters

      Returns void

PoiMouseOutHandler

PoiMouseOutHandler: (poi: PoiInterface) => void

Type declaration

    • Signal handler that is called when a user leaves the POI in scene with mouse.

      Parameters

      Returns void

PoiMouseOverHandler

PoiMouseOverHandler: (poi: PoiInterface) => void

Type declaration

    • Signal handler that is called when a user enters the POI in scene with mouse.

      Parameters

      Returns void

PoiOpenHandler

PoiOpenHandler: (poi: PoiInterface) => void

Type declaration

    • Signal handler that is called when the POI details panel is opened.

      Parameters

      Returns void

PoiSaveHandler

PoiSaveHandler: (poi: PoiInterface, created: boolean) => void

Type declaration

    • Signal handler that is called when a POI is saved.

      Parameters

      • poi: PoiInterface

        Saved POI

      • created: boolean

        True if a new POI is created, false if an existing one is updated

      Returns void

PoiUnhighlightHandler

PoiUnhighlightHandler: (pois: PoiInterface[]) => void

Type declaration

    • Signal handler that is called when POIs are unhighlighted in the scene.

      Parameters

      Returns void

RouteChangeHandler

RouteChangeHandler: (route: RouteDataInterface) => void

Type declaration

RouteInstructionMouseClickHandler

RouteInstructionMouseClickHandler: (instruction: InstructionApiInterface) => void

Type declaration

RouteInstructionMouseOutHandler

RouteInstructionMouseOutHandler: (instruction: InstructionApiInterface) => void

Type declaration

    • Signal handler that is called when the mouse has moved out of a route instruction.

      Parameters

      Returns void

RouteInstructionMouseOverHandler

RouteInstructionMouseOverHandler: (instruction: InstructionApiInterface) => void

Type declaration

    • Signal handler that is called when the mouse is moved over a route instruction.

      Parameters

      Returns void

ThirdPartyLibrariesInfo

ThirdPartyLibrariesInfo<T, ThirdPartyLibraryDetailsInterface>: {[ K in T]: ThirdPartyLibraryDetailsInterface }

Dictionary that holds version data about third party libraries

Type parameters

  • T: string

  • ThirdPartyLibraryDetailsInterface

TransitionEndHandler

TransitionEndHandler: (event: TransitionEndEventInterface) => void

Type declaration

TransitionStartHandler

TransitionStartHandler: (event: TransitionStartEventInterface) => void

Type declaration

ZoomHandler

ZoomHandler: () => void

Type declaration

    • (): void
    • Signal handler for zoom events

      Returns void

Functions

getApi

  • Retrieve the NavVis IVION API from the provided base URL

    Parameters

    Returns Promise<ApiInterface>

    Promise for NavVis IVION API object. The promise resolves once data has been loaded and the view has been moved to the startup location. If private mode is enabled, the promise resolves only after a user has logged in. The promise rejects if there is an error during loading or initialization. The promise also rejects when WebGL is unavailable.

Generated using TypeDoc