NavVis IVION API

https://ivion-api.docs.navvis.com/v11.10.6/reference
Admin
NavVis IVION API is a JavaScript/TypeScript API for building interactive 3D scene applications with...
Tokens:108,758
Snippets:1,717
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### onTransitionStart

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/customlayer

Called when a location transition is started.

```APIDOC
## onTransitionStart

### Description
Called when a location transition is started

### Parameters
#### Path Parameters
- **event** (TransitionStartEventInterface) - Required - Transition event

### Returns
void
```

--------------------------------

### Method: onTransitionStart

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/AbstractSceneLayer.html

Callback function executed when a transition starts.

```APIDOC
## Method: onTransitionStart

### Description
Callback function executed when a transition starts.

### Returns
*   void
```

--------------------------------

### moveToStartingLoc

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/IvionInterface.html

Moves the user's view to the default starting location.

```APIDOC
## moveToStartingLoc

### Description
Moves user to the default starting location.

### Method
POST

### Endpoint
`/ivion/moveTo/startingLoc`

### Returns
- **Promise<void>** - Promise that is resolved when the moving transition is completely finished.
```

--------------------------------

### moveToStartingLoc

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/IvionInterface.html

Moves the user to the configured starting location. Returns a promise that resolves when the transition is complete.

```APIDOC
## moveToStartingLoc

### Description
Move to configured starting location.

### Method
`moveToStartingLoc()`

### Returns
`Promise<void>` - Promise that is resolved when the moving transition is completely finished.
```

--------------------------------

### onTransitionStart

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/scenelayerinterface

Called when a location transition is started. Accepts transition event data.

```APIDOC
## onTransitionStart

### Description
Called when a location transition is started.

### Parameters
* **event** (TransitionStartEventInterface) - Transition event

### Returns
* void
```

--------------------------------

### onDragStart

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/MouseEventReceiverInterface.html

Called when the user starts dragging the target.

```APIDOC
## onDragStart

### Description
Called when the user starts dragging the target.

### Method
`onDragStart?(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): boolean`

### Parameters
#### Path Parameters
- **position** (MouseEventCoordinatesInterface) - Required - Mouse position
- **viewport** (ViewportInterface) - Required - The current viewport
- **instanceId** (number) - Optional - The index of the instance if the event occurred on an InstancedMesh.

### Returns
- **boolean**
```

--------------------------------

### Collector.emit

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/collector

Publishes the bound signal event to start the collection process.

```APIDOC
## emit
emit: (...args: Parameters<THandler>) => void

Publish the bound signal event (call all handlers) to start the collection process.
```

--------------------------------

### InstructionApiInterface

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/InstructionApiInterface.html

Use the InstructionApiInterface to access methods which allow you to move to instruction and to get the position (in site coordinates) and floor of the instruction.

```APIDOC
## Interface InstructionApiInterface
Use the InstructionApiInterface to access methods which allow you to move to instruction and to get the position (in site coordinates) and floor of the instruction.
interface InstructionApiInterface {
floor: SiteModelEntityInterface;
position: Vector3;
text: string;
type: InstructionType;
moveToInstruction(): Promise<void>;
}
### Properties
floor position text type
### Methods
moveToInstruction
```

--------------------------------

### emit Property

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/Collector.html

Publishes the bound signal event to start the collection process.

```APIDOC
## emit
  * emit: (...args: Parameters<THandler>) => void

Publish the bound signal event (call all handlers) to start the collection process.
```

--------------------------------

### TransitionStartEventInterface

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/transitionstarteventinterface

Represents the data associated with the start of a transition event.

```APIDOC
## Interface TransitionStartEventInterface

### Description
Event information about the start of a transition to a new location.

### Properties
- **image** (ImageInterface) - Optional - Image at target location.
- **poiEntity** (PoiInterface) - Optional - Optional POI if the transition was originally triggered by one.
- **previousImage** (ImageInterface) - Optional - Image where the transition started.
- **siteModelEntity** (SiteModelEntityInterface) - Optional - Optional site model entity if the transition was originally triggered by one.
```

--------------------------------

### findAll

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/PoiTypeGroupRepositoryInterface.html

Gets all repository items. Returns cached data if available, or fetches a fresh copy from the server if forceFetch is true.

```APIDOC
## findAll

### Description
Gets all repository items. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server.

### Parameters
#### Query Parameters
- **forceFetch** (boolean) - Optional - Whether to bypass the cache and retrieve a fresh copy from the server.

### Returns
Promise<PoiTypeGroupInterface[]>: Promise with the repository items.
```

--------------------------------

### route

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/RouteApiInterface.html

Finds a route between a source and destination and opens associated UI elements. Optionally moves to the start of the route.

```APIDOC
## route

### Description
Find a route between the source and the destination. This will also open the user interface elements associated with the route.

### Method
route(source: Vector3 | PoiInterface, destination: Vector3 | PoiInterface, moveToStart?: boolean): Promise<RouteDataInterface>

### Parameters
#### Path Parameters
- **source** (Vector3 | PoiInterface) - Required - The starting point of the route. If a Vector3 location is specified, it should be in site coordinates.
- **destination** (Vector3 | PoiInterface) - Required - The ending point of the route. If a Vector3 location is specified, it should be in site coordinates.
- **moveToStart** (boolean) - Optional - A boolean specifying whether to move to start or not. If not provided this parameter will default to true.

### Returns
#### Success Response (Promise<RouteDataInterface>)
A promise which returns the route.
#### Error Response
In case there is no route found between the source and destination, the promise will be rejected with the specific reason for the rejection.
```

--------------------------------

### TransitionStartEventInterface

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/TransitionStartEventInterface.html

Represents the data associated with the start of a transition event, including images and site model information.

```APIDOC
## Interface TransitionStartEventInterface

Event information about the start of a transition to a new location

### Properties

*   **image**? (`ImageInterface`): Image at target location.
*   **poiEntity**? (`PoiInterface`): Optional POI if the transition was originally triggered by one.
*   **previousImage**? (`ImageInterface`): Image where the transition started.
*   **siteModelEntity**? (`SiteModelEntityInterface`): Optional site model entity if the transition was originally triggered by one.
```

--------------------------------

### findAll

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/DatasetRepositoryInterface.html

Gets all repository items. Optionally bypasses cache to fetch fresh data from the server.

```APIDOC
## findAll

### Description
Gets all repository items. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server.

### Method
findAll(forceFetch?: boolean)

### Parameters
#### Path Parameters
- `Optional`forceFetch (boolean) - Whether to bypass the cache and retrieve a fresh copy from the server.

### Returns
Promise<DatasetInterface[]> - Promise with the repository items.
```

--------------------------------

### onDragStart

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/mouseeventreceiverinterface

Called when the user starts dragging the target. Returns true to consume the event, false to pass it on.

```APIDOC
## onDragStart

### Description
Called when the user starts dragging the target.

### Method
`onDragStart?(position: MouseEventCoordinatesInterface, viewport: ViewportInterface, instanceId?: number): boolean`

### Parameters
#### Path Parameters
- **position** (MouseEventCoordinatesInterface) - Required - Mouse position
- **viewport** (ViewportInterface) - Required - The current viewport
- **instanceId** (number) - Optional - The index of the instance if the event occurred on an InstancedMesh.

### Returns
- **boolean** - Return true to consume the event, false to pass it on
```

--------------------------------

### Constructor

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/abstractscenelayer

Initializes a new instance of AbstractSceneLayer.

```APIDOC
## constructor
  * new AbstractSceneLayer(
view: AbstractViewInterface,
scene: Scene,
params: SceneLayerConfigInterface,
): AbstractSceneLayer
#### Parameters
    * view: AbstractViewInterface
    * scene: Scene
    * params: SceneLayerConfigInterface
#### Returns AbstractSceneLayer
```

--------------------------------

### getDefaultViewport

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/mainviewinterface

Gets the first viewport in the view.

```APIDOC
## getDefaultViewport

### Description
Get the first viewport.

### Method
```typescript
getDefaultViewport(): ViewportInterface
```

### Returns ViewportInterface

```

--------------------------------

### getActiveItem

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/SidebarMenuServiceInterface.html

Get the currently selected SidebarMenuItemInterface.

```APIDOC
## getActiveItem

### Description
Get the currently selected SidebarMenuItemInterface.

### Method
getActiveItem()

### Returns
SidebarMenuItemInterface
```

--------------------------------

### getDefaultViewport

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/mapviewinterface

Gets the default viewport configuration for the view.

```APIDOC
## getDefaultViewport

### Description
Gets the default viewport configuration for the view.

### Method
ViewportInterface

### Returns
ViewportInterface
```

--------------------------------

### Constructor: new AbstractSceneLayer

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/AbstractSceneLayer.html

Initializes a new instance of the AbstractSceneLayer class.

```APIDOC
## Constructor: new AbstractSceneLayer

### Description
Initializes a new instance of the AbstractSceneLayer class.

### Parameters
*   **view** (AbstractViewInterface) - The view interface.
*   **scene** (Scene) - The scene object.
*   **params** (SceneLayerConfigInterface) - Configuration parameters for the scene layer.

### Returns
*   AbstractSceneLayer - The newly created AbstractSceneLayer instance.
```

--------------------------------

### create

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/SiteRepositoryInterface.html

Factory method to create and return a new empty instance of the Site entity.

```APIDOC
## create

### Description
Factory method. Creates and returns a new empty instance of the entity.

### Method
create()

### Returns
SiteInterface: An instance of the entity.
```

--------------------------------

### PoiInterface Methods

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/poiinterface

This section details the methods available for interacting with PoiInterface objects.

```APIDOC
## copy

### Description
Creates a copy of the POI entity.

### Method
copy(source: PoiInterface, excludeTransients?: boolean, excludeId?: boolean): PoiInterface

### Parameters
#### Path Parameters
- **source** (PoiInterface) - Required - POI entity
- **excludeTransients** (boolean) - Optional - whether temporary fields should be excluded from the copy
- **excludeId** (boolean) - Optional - whether the ID field should be excluded from the copy, thus saving it won't overwrite the source entity.

### Returns
PoiInterface

## getIconSignedUrl

### Description
Get the POI's icon URL with proper authentication (signed URL for custom icons). Default icon is supplied if none defined.

### Method
getIconSignedUrl(): Promise<string>

### Returns
Promise<string> - Promise that resolves to the icon URL

## hasCustomIcon

### Description
Whether this POI has a custom icon or not.

### Method
hasCustomIcon(): boolean

### Returns
boolean - true if POI has a custom icon, false if using type icon or default

## setPointOfView

### Description
Set the pov point of view defined by the provided parameters as the default one that will be used when moving to this POI.

### Method
setPointOfView(location: Vector3, orientation: Quaternion, fov?: number, imageId?: number): void

### Parameters
#### Path Parameters
- **location** (Vector3) - Required - Location for the point of view
- **orientation** (Quaternion) - Required - Orientation for the point of view
- **fov** (number) - Optional - Field of view
- **imageId** (number) - Optional - ID of the image associated with the point of view
```

--------------------------------

### moveToInstruction

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/InstructionApiInterface.html

Moves the camera to the specified instruction.

```APIDOC
## Methods
### moveToInstruction
  * moveToInstruction(): Promise<void>
Move the camera to the instruction.
#### Returns Promise<void>
```

--------------------------------

### Accessor: visible

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/AbstractSceneLayer.html

Gets or sets the visibility of the scene layer.

```APIDOC
## Accessor: visible

### Description
Gets or sets the visibility of the scene layer.

### Getter
#### Returns
*   boolean - The current visibility state.

### Setter
#### Parameters
*   **visible** (boolean) - The desired visibility state.
#### Returns
*   void
```

--------------------------------

### PoiInterface Methods

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/PoiInterface.html

This section details the methods available for interacting with POIs.

```APIDOC
## copy
### Description
Creates a copy of the POI entity.
### Method
copy(source: PoiInterface, excludeTransients?: boolean, excludeId?: boolean): PoiInterface
### Parameters
#### Path Parameters
- **source** (PoiInterface) - Required - POI entity
- **excludeTransients** (boolean) - Optional - whether temporary fields should be excluded from the copy
- **excludeId** (boolean) - Optional - whether the ID field should be excluded from the copy, thus saving it won't overwrite the source entity.
### Returns PoiInterface

## getIconSignedUrl
### Description
Get the POI's icon URL with proper authentication (signed URL for custom icons). Default icon is supplied if none defined.
### Method
getIconSignedUrl(): Promise<string>
### Returns Promise<string>
Promise that resolves to the icon URL

## hasCustomIcon
### Description
Whether this POI has a custom icon or not.
### Method
hasCustomIcon(): boolean
### Returns boolean
true if POI has a custom icon, false if using type icon or default

## setPointOfView
### Description
Set the pov point of view defined by the provided parameters as the default one that will be used when moving to this POI.
### Method
setPointOfView(location: Vector3, orientation: Quaternion, fov?: number, imageId?: number): void
### Parameters
#### Path Parameters
- **location** (Vector3) - Required
- **orientation** (Quaternion) - Required
- **fov** (number) - Optional
- **imageId** (number) - Optional
```

--------------------------------

### Move to Instruction - TypeScript

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/InstructionApiInterface.html

Call this method to move the camera to the current instruction's location. Ensure the interface is properly initialized before use.

```typescript
instructionApi.moveToInstruction()
```

--------------------------------

### Get Default Viewport

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AbstractViewInterface.html

Retrieves the first viewport associated with the view.

```typescript
getDefaultViewport(): ViewportInterface;
```

--------------------------------

### Accessor: targetViewport

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/AbstractSceneLayer.html

Gets or sets the target viewport for the scene layer.

```APIDOC
## Accessor: targetViewport

### Description
Gets or sets the target viewport for the scene layer.

### Getter
#### Returns
*   ViewportInterface - The target viewport.

### Setter
#### Parameters
*   **value** (ViewportInterface) - The viewport to set as the target.
#### Returns
*   void
```

--------------------------------

### create

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/PoiTypeRepositoryInterface.html

Factory method to create a new, empty instance of a PoiType.

```APIDOC
## create

### Description
Factory method. Creates and returns a new empty instance of the entity.

### Method
create()

### Returns
PoiTypeInterface - An instance of the entity.
```

--------------------------------

### login

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AuthApiInterface.html

Logs in a user with the provided credentials. This method is intended for local NavVis IVION accounts only.

```APIDOC
## login

### Description
Logs in a user with the provided credentials. Note that this will only work with local NavVis IVION accounts, not with OAuth or pre-authentication.

### Method
POST (Implicit, as it involves sending credentials)

### Endpoint
N/A (Client-side function)

### Parameters
#### Request Body
- **username** (string) - Required - Name of the user.
- **password** (string) - Required - Password of the user.
- **awaitDataLoad** (boolean) - Optional - Determines whether the returned promise should wait for the full initialization of NavVis IVION. Defaults to false.

### Response
#### Success Response (200)
- **UserEntityInterface**: Information about the logged-in user.

#### Error Response
- Rejects if e.g. the provided credentials are invalid.
```

--------------------------------

### Login with Credentials

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AuthApiInterface.html

Logs in a user using username and password. This method is for local NavVis IVION accounts only and does not support OAuth or pre-authentication. The `awaitDataLoad` flag can be set to true to ensure the returned promise waits for full NavVis IVION initialization, which is necessary when chaining with subsequent API functions.

```typescript
login(
username: string,
password: string,
awaitDataLoad?: boolean,
): Promise<UserEntityInterface>
```

--------------------------------

### getPoiRepository

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/IvionInterface.html

Gets the Point of Interest (POI) Repository object for managing POIs.

```APIDOC
## getPoiRepository

### Description
Gets the POI Repository object.

### Method
GET

### Endpoint
`/ivion/poiRepository`

### Returns
- **PoiRepositoryInterface** - The POI Repository object.
```

--------------------------------

### create

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/DatasetRepositoryInterface.html

Factory method to create and return a new empty instance of the Dataset entity.

```APIDOC
## create

### Description
Factory method. Creates and returns a new empty instance of the entity.

### Method
create()

### Returns
DatasetInterface - An instance of the entity.
```

--------------------------------

### Get JWT Token

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AuthApiInterface.html

Retrieves the locally stored JWT for authenticating requests.

```typescript
getToken(): string;
```

--------------------------------

### create

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/imagerepositoryinterface

Factory method to create a new, empty instance of an ImageInterface.

```APIDOC
## create

### Description
Factory method. Creates and returns a new empty instance of the entity.

### Method
create()

### Returns
ImageInterface - An instance of the entity.
```

--------------------------------

### getPoiTypeRepository

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/IvionInterface.html

Gets the Point of Interest (POI) Type Repository object for managing POI types.

```APIDOC
## getPoiTypeRepository

### Description
Gets the POI Type Repository object.

### Method
GET

### Endpoint
`/ivion/poiTypeRepository`

### Returns
- **PoiTypeRepositoryInterface** - The POI Type Repository object.
```

--------------------------------

### Signal Constructor

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/Signal.html

Initializes a new instance of the Signal class.

```APIDOC
## constructor
  * new Signal<THandler extends (...args: any[]) => any>(): Signal<THandler>
#### Type Parameters
    * THandler extends (...args: any[]) => any
#### Returns Signal<THandler>
```

--------------------------------

### Get Last Mouse Position

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AbstractViewInterface.html

Returns the last recorded mouse position within the view.

```typescript
getLastMousePosition(): MouseEventCoordinatesInterface;
```

--------------------------------

### goToItem

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/sidebarmenuserviceinterface

Opens a specific sidebar menu item. This method only works for items currently visible in the menu. It returns a promise that resolves upon successful navigation or rejects if the user cancels the action.

```APIDOC
## goToItem

### Description
Opens the SidebarMenuItemInterface. Note: only works for items that are visible in the menu.

### Method
goToItem(item: SidebarMenuItemInterface)

### Parameters
#### Path Parameters
* **item** (SidebarMenuItemInterface) - Required - The menu item to navigate to.

### Returns
Promise<void>
Promise that resolves when navigation has completed and rejects if user has canceled the action (e.g. to keep unsaved changes in the current view).
```

--------------------------------

### findOne

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/DatasetRepositoryInterface.html

Get a single repository item by its ID. Optionally bypasses cache for fresh data.

```APIDOC
## findOne

### Description
Get one repository item by id. The cached data will be returned if the data has been fetched before. Use the forceFetch parameter to retrieve a fresh copy from the server. In case a new record is fetched, the data and dataMap will be updated accordingly.

### Method
findOne(id: number, forceFetch?: boolean)

### Parameters
#### Path Parameters
- id (number) - Required - Identifier of the repository item
- `Optional`forceFetch (boolean) - Whether to bypass the cache and retrieve a fresh copy from the server.

### Returns
Promise<DatasetInterface> - 
```

--------------------------------

### create

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/ImageRepositoryInterface.html

Factory method to create a new, empty instance of an image entity.

```APIDOC
## create

### Description
Factory method. Creates and returns a new empty instance of the entity.

### Method
create

### Returns ImageInterface
An instance of the entity.
```

--------------------------------

### Methods

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/abstractscenelayer

Methods for interacting with and managing the AbstractSceneLayer.

```APIDOC
## Methods
### getActiveViewport
  * getActiveViewport(): ViewportInterface
Retrieve the active viewport. This is either the targetViewport if defined or otherwise the view's default viewport.   
Note: use this over targetViewport if you just need the active viewport for this layer and don't care whether a specific one or the default one is specified.
#### Returns ViewportInterface


### `Protected`isVisibleInViewport
  * isVisibleInViewport(viewport: ViewportInterface): boolean
#### Parameters
    * viewport: ViewportInterface
#### Returns boolean


### onAfterRender
  * onAfterRender(camera: Camera): void
Called after rendering of all viewports
#### Parameters
    * camera: Camera
Camera used to render the view
#### Returns void


### onAfterRenderViewport
  * onAfterRenderViewport(viewport: ViewportInterface): void
Called after rendering of a viewport
#### Parameters
    * viewport: ViewportInterface
Viewport where rendering took place
#### Returns void


### onAfterSceneRenderViewport
  * onAfterSceneRenderViewport(viewport: ViewportInterface, scene: Scene): void
Called after the rendering of a scene in a viewport.
#### Parameters
    * viewport: ViewportInterface
Viewport where the rendering took place
    * scene: Scene
The last scene that was rendered.
#### Returns void


### onBeforeRender
  * onBeforeRender(camera: Camera): void
Called before rendering
#### Parameters
    * camera: Camera
Camera used to render the view
#### Returns void


### onBeforeRenderViewport
  * onBeforeRenderViewport(viewport: ViewportInterface): void
Called before rendering a viewport. Updates layer visibility depending on viewport and avoids raycasting objects if #targetViewport doesn't match the passed viewport.
Note: If you override this method and change the position, orientation or scale of a mesh, and you rely on mouse events on the meshes or use getObjectsUnderCursor(), call this.sceneGroup.updateWorldMatrix(false, true); in your overridden method.
#### Parameters
    * viewport: ViewportInterface
Viewport where rendering takes place
#### Returns void


### onBeforeSceneRenderViewport
  * onBeforeSceneRenderViewport(viewport: ViewportInterface, scene: Scene): void
Called before the rendering a scene in a viewport.
#### Parameters
    * viewport: ViewportInterface
Viewport where the rendering is going to take place
    * scene: Scene
The scene about to rendered
#### Returns void
```

--------------------------------

### getLanguage

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/IvionInterface.html

Retrieves the current language setting of the IVION system. Example: returns `en` for English.

```APIDOC
## getLanguage

### Description
Get language (example: returns `en` for English).

### Method
GET

### Endpoint
`/ivion/language`

### Returns
- **string** - Language key. See setLanguage for the list of supported languages.
```

--------------------------------

### TransitionStartHandler

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/types/TransitionStartHandler.html

A handler function that is called when a transition starts. It receives an event object containing details about the transition.

```APIDOC
## Type Alias TransitionStartHandler

TransitionStartHandler: (event: TransitionStartEventInterface) => void

### Type Declaration

* (event: TransitionStartEventInterface): void

### Parameters

* **event** (TransitionStartEventInterface) - Description of the event object passed to the handler.

### Returns

* void
```

--------------------------------

### create

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/RestRepositoryInterface.html

Factory method. Creates and returns a new empty instance of the entity.

```APIDOC
## create

### Description
Factory method. Creates and returns a new empty instance of the entity.

### Method
create

### Returns
T - An instance of the entity.
```

--------------------------------

### goToPoi

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/PoiServiceInterface.html

Moves the user's view to a specified POI. If no POI is provided, it defaults to the currently opened POI.

```APIDOC
## goToPoi

### Description
Moves the view to the POI.

### Method
goToPoi(poi?: PoiInterface): Promise<void>

### Parameters
#### Path Parameters
- **poi** (PoiInterface) - Optional - POI to move to. If not specified, the PoiServiceInterface.openedPoi is used.

### Returns
Promise<void>
```

--------------------------------

### login

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/authapiinterface

Logs in a user using their provided username and password. This method is intended for local NavVis IVION accounts only and does not support OAuth or pre-authentication.

```APIDOC
## login

### Description
Logs in a user with the provided credentials. Note that this will only work with local NavVis IVION accounts, not with OAuth or pre-authentication.

### Method
`login(username: string, password: string, awaitDataLoad?: boolean): Promise<UserEntityInterface>`

### Parameters
#### Path Parameters
* `username` (string) - Name of the user.
* `password` (string) - Password of the user.
* `awaitDataLoad` (boolean) - Optional flag that determines whether the returned promise should wait for the full initialization of NavVis IVION. Defaults to false.

### Returns
`Promise<UserEntityInterface>` - A promise that is resolved after successful login and rejected if e.g. the provided credentials are invalid.
```

--------------------------------

### Get Screenshot

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AbstractViewInterface.html

Captures a screenshot of the current view. Allows specifying the MIME type and quality for the image.

```typescript
getScreenshot(mimeType?: string, quality?: number): ScreenshotDataInterface;
```

--------------------------------

### findAll Method

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/RestRepositoryInterface.html

Fetches all entities from the repository. By default, it returns cached data if available. Set forceFetch to true to bypass the cache and retrieve fresh data from the server.

```typescript
findAll(forceFetch?: boolean): Promise<T[]>;

```

--------------------------------

### getClosestImageInDir

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/ImageServiceInterface.html

Finds the closest non-hidden image to a target point, which is located relative to a starting image and viewing direction.

```APIDOC
## getClosestImageInDir

### Description
Find the closest non-hidden image to the target point. The target point is located in distance (dir * dist) in the direction of view.

### Method
getClosestImageInDir

### Parameters
#### Path Parameters
- **image** (ImageInterface) - Required - The starting image from which to search.
- **currViewingDir** (ViewOrientationInterface) - Required - The current viewing direction.
- **dir** (number) - Required - The direction modifier: +1 for forward, -1 for backward.
- **distance** (number) - Required - How far away to move to approximately.

### Returns Promise<ImageInterface>
The nearest image in the direction at the distance, or reject if none found.
```

--------------------------------

### Properties

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/InstructionApiInterface.html

Properties available for an instruction.

```APIDOC
## Properties
### `Readonly`floor
floor: SiteModelEntityInterface
Return the floor of the instruction.
### `Readonly`position
position: Vector3
Return the position (site coordinate) of the instruction.
### `Readonly`text
text: string
Return the text of the instruction.
### `Readonly`type
type: InstructionType
The type of the instruction.
```

--------------------------------

### onLoadComplete

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/ConfigurationInterface.html

A callback function invoked after data is loaded and the view is positioned at the starting location. Deprecated for NPM API usage.

```APIDOC
## onLoadComplete

### Description
Callback that is invoked after data has been loaded and the view has moved to the starting location.

### Property
`onLoadComplete?: () => void`

#### Deprecated
Do not use this with the NPM API, use getApi().then(callback) instead.
```

--------------------------------

### getApi

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/functions/getapi

Retrieves the NavVis IVION API from the provided base URL. 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, or when WebGL is unavailable.

```APIDOC
## Function getApi

### Description
Retrieve the NavVis IVION API from the provided base URL.

### Signature
`getApi(baseUrl: string, config?: ConfigurationInterface): Promise<ApiInterface>`

### Parameters
#### Path Parameters
* **baseUrl** (string) - Required - Base URL of NavVis IVION instance, e.g. https://www.navvis.com/iv.
* **config** (ConfigurationInterface) - Optional - Client configuration 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.
```

--------------------------------

### Point Constructor

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/Point.html

Initializes a new Point object with a Vector3 coordinate.

```APIDOC
## constructor
  * new Point(coord: Vector3): Point
#### Parameters
    * coord: Vector3
#### Returns Point
```

--------------------------------

### Get Objects Under Cursor

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AbstractViewInterface.html

Identifies and returns all 3D objects intersected by a ray originating from the cursor's position on the screen.

```typescript
getObjectsUnderCursor(
  pos: MouseEventCoordinatesInterface,
): Intersection<Object3D<Object3DEventMap>>[];
```

--------------------------------

### Get Camera

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AbstractViewInterface.html

Retrieves the camera used for rendering the view. If multiple viewports exist, it returns the camera for the default viewport.

```typescript
getCamera(): Camera;
```

--------------------------------

### Login with Access and Upload Tokens

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AuthApiInterface.html

Logs in a user with both an access token and an upload token. Similar to `loginWithToken`, this supports local accounts or OAuth Resource Servers, disables UI logout, and requires manual token refreshing using `updateToken`.

```typescript
loginWithTokens(
accessToken: string,
uploadToken: string,
awaitDataLoad?: boolean,
): Promise<UserEntityInterface>
```

--------------------------------

### Get Route Data - RouteApiInterface

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/routeapiinterface

Finds a route between a source and destination without updating views. The promise rejects if no route is found.

```typescript
getRoute(
  source: Vector3,
  destination: Vector3,
): Promise<RouteDataInterface>;
```

--------------------------------

### Get a screenshot of the current view

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/MapViewInterface.html

Captures a screenshot of the current 3D view. Supports specifying MIME type and quality for the image.

```typescript
const screenshotData = view.getScreenshot('image/jpeg', 0.9);
console.log(screenshotData);
```

--------------------------------

### goToItem

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/SidebarMenuServiceInterface.html

Opens the specified SidebarMenuItemInterface. This method only works for items that are currently visible in the menu.

```APIDOC
## goToItem

### Description
Opens the SidebarMenuItemInterface.
Note: only works for items that are visible in the menu.

### Method
goToItem(item: SidebarMenuItemInterface)

### Parameters
#### Path Parameters
- **item** (SidebarMenuItemInterface) - Required - The menu item to navigate to.

### Returns
Promise<void>
Promise that resolves when navigation has completed and rejects if user has canceled the action (e.g. to keep unsaved changes in the current view).
```

--------------------------------

### Get objects under the cursor

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/MapViewInterface.html

Retrieves an array of objects that are intersected by a ray cast from the cursor's position on the screen. Requires MouseEventCoordinatesInterface.

```typescript
const mousePos = view.getLastMousePosition();
const intersections = view.getObjectsUnderCursor(mousePos);
```

--------------------------------

### create

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/PoiTypeGroupRepositoryInterface.html

Factory method to create and return a new empty instance of the PoiTypeGroup entity.

```APIDOC
## create

### Description
Factory method. Creates and returns a new empty instance of the entity.

### Returns
PoiTypeGroupInterface: An instance of the entity.
```

--------------------------------

### Get Route Between Two Points

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/RouteApiInterface.html

Finds a route between a source and destination without updating any views. The promise will be rejected if no route is found.

```typescript
getRoute(source: Vector3, destination: Vector3): Promise<RouteDataInterface>
```

--------------------------------

### Method: onKeyUp

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/AbstractSceneLayer.html

Callback function executed when a key up event occurs.

```APIDOC
## Method: onKeyUp

### Description
Callback function executed when a key up event occurs.

### Returns
*   void
```

--------------------------------

### getPositionOnGroundPlane

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/abstractviewinterface

Gets a 3D position on a ground plane based on screen coordinates and a specified height. It unprojects screen coordinates and intersects with a plane.

```APIDOC
## getPositionOnGroundPlane

### Description
Get 3D position of specified screen coordinates assuming a ground plane at given height. This method is viewport-aware and takes care of the extra transformation. It unprojects the screen coordinates and intersects the ray with a plane with normal (0,0,1) at specified height in order to get the 3D point coordinates on the plane. If z is undefined, the plane is assumed to be 1 unit away from the camera position in the direction the camera is facing.

### Method
getPositionOnGroundPlane

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Parameters
* **x** (number) - Required - Screen X coordinate
* **y** (number) - Required - Screen Y coordinate
* **z** (number) - Required - Z coordinate of ground plane. Can be undefined.
* **viewport** (ViewportInterface) - Optional - Viewport to use (optional)

### Returns
Vector3 - 3D position of mouse or gesture event on the plane (or null)
```

--------------------------------

### findOne

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/datasetrepositoryinterface

Get a single repository item by its ID. Returns cached data if available, or fetches fresh data from the server if forceFetch is true.

```APIDOC
## findOne

### Description
Get one repository item by id. The cached data will be returned if the data has been fetched before. Use the forceFetch parameter to retrieve a fresh copy from the server. In case a new record is fetched, the data and dataMap will be updated accordingly.

### Method
findOne(id: number, forceFetch?: boolean): Promise<DatasetInterface>

### Parameters
#### Parameters
- **id** (number) - Required - Identifier of the repository item
- **forceFetch** (boolean) - Optional - Whether to bypass the cache and retrieve a fresh copy from the server.

### Returns
Promise<DatasetInterface>
```

--------------------------------

### onContextMenu

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/classes/abstractscenelayer

Called when the context menu is about to be shown. Implement this to add custom context menu items.

```APIDOC
## onContextMenu

### Description
Called when the context menu is about to be shown. Return context menu items from this method to add them to the context menu. Return undefined (or do not implement the method) if you do not want to add an entry from the specific layer. Return false to prevent the context menu from opening.

### Method
`onContextMenu(pos: MouseEventCoordinatesInterface): OnContextMenuResult | Promise<OnContextMenuResult>`

### Parameters
* **pos** (MouseEventCoordinatesInterface) - Mouse position

### Returns
OnContextMenuResult | Promise<OnContextMenuResult> - List of context menu items
```

--------------------------------

### Get Position on Ground Plane

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/AbstractViewInterface.html

Calculates the 3D coordinates of a point projected onto the ground plane from given screen coordinates and depth.

```typescript
getPositionOnGroundPlane(
  x: number,
  y: number,
  z: number,
  viewport?: ViewportInterface,
): Vector3;
```

--------------------------------

### generate

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/SiteModelRepositoryInterface.html

Automatically generates a site model based on all datasets, overwriting existing data.

```APIDOC
## generate

### Description
Automatically generate a site model based on all datasets in the instance. **Note** that this will overwrite any existing site model data.

### Method
generate(): Promise<SiteModelEntityInterface[]>

### Returns
Promise<SiteModelEntityInterface[]> - 
```

--------------------------------

### Calculate and Display Route - RouteApiInterface

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/routeapiinterface

Calculates a route between a source and destination and displays associated UI elements. Optionally moves the view to the start of the route.

```typescript
route(
  source: Vector3 | PoiInterface,
  destination: Vector3 | PoiInterface,
  moveToStart?: boolean,
): Promise<RouteDataInterface>
```

--------------------------------

### Get Objects Under Cursor

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/mapviewinterface

Retrieves a list of 3D objects that are intersected by the cursor at a given screen position. This is useful for implementing click or hover interactions.

```typescript
const intersections = mapView.getObjectsUnderCursor(mouseCoordinates);
if (intersections.length > 0) {
  const firstObject = intersections[0].object;
}
```

--------------------------------

### loadScene

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/MeshApiInterface.html

Recursively loads .gltf file content from a given URL path. It takes a path to the .gltf file and a callback function that is executed once the mesh is loaded.

```APIDOC
## loadScene

### Description
Given URL path the method will recursively load the .gltf file content.

### Method
loadScene

### Parameters
#### Path Parameters
* **path** (string) - Required - URL with .gltf root file.
* **onLoad** (function) - Required - Called when the mesh is loaded with groups argument.

### Returns
void
```

--------------------------------

### getApi

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/functions/getApi.html

Retrieve the NavVis IVION API from the provided base URL. This function returns a Promise that resolves with the ApiInterface object once data has been loaded and the view has been moved to the startup location. It rejects if there is an error during loading or initialization, or if WebGL is unavailable.

```APIDOC
## Function getApi

### Description
Retrieve the NavVis IVION API from the provided base URL.

### Signature
`getApi(baseUrl: string, config?: ConfigurationInterface): Promise<ApiInterface>`

### Parameters
#### Path Parameters
- **baseUrl** (string) - Required - Base URL of NavVis IVION instance, e.g. https://www.navvis.com/iv.
- **config** (ConfigurationInterface) - Optional - Client configuration 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.
```

--------------------------------

### Get Available Modes

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/ModeSwitchServiceInterface.html

Retrieves a list of currently available modes. This considers the site's current state, such as whether content is published or in draft.

```typescript
getAvailableModes(): ModeState[]
```

--------------------------------

### createWatchedTween

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/MainViewInterface.html

Creates a tween object that is automatically managed by the view's rendering loop. The tween is added to a watch list when started and removed upon completion or stopping.

```APIDOC
## createWatchedTween createWatchedTween<T>(object: T, group?: false | Group): Tween<T>

### Description
Create a tween that is added to the watch list when started and removed from the watch list when it completes or when it is stopped.
As long as at least one tween is watched, the view will render at a fixed frame rate.

### Type Parameters
* T

### Parameters
#### Path Parameters
* object (T) - Required - The object to tween. This is passed on to the Tween constructor.
* group (false | Group) - Optional - The tween group. This is passed on to the Tween constructor.

### Returns Tween<T>
The tween with onStart(), onStop() and onComplete() callbacks installed.
```

--------------------------------

### AbstractViewInterface Methods

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/abstractviewinterface

This section details the methods available in the AbstractViewInterface for interacting with the 3D view.

```APIDOC
## Method: addToScene

### Description
Adds a scene layer to the 3D view. This allows for custom data layers to be integrated.

### Signature
addToScene(layer: SceneLayerInterface): void

### Parameters
*   **layer** (SceneLayerInterface) - Required - The scene layer to add to the view.
```

```APIDOC
## Method: centerOn

### Description
Centers all viewports on a specified 3D position. Optionally adjusts the frustum depth for orthographic cameras.

### Signature
centerOn(position: Vector3, frustumDepth?: number): void

### Parameters
*   **position** (Vector3) - Required - The position to center the view on.
*   **frustumDepth** (number) - Optional - Adjusts the frustum size for orthographic cameras.
```

```APIDOC
## Method: closeContextMenu

### Description
Closes any currently open context menu in the view.

### Signature
closeContextMenu(): void
```

```APIDOC
## Method: createSceneGroup

### Description
Creates a new, empty scene group object. This can be used to organize objects within the 3D scene.

### Signature
createSceneGroup(): Object3D

### Returns
*   Object3D - A new scene group object.
```

```APIDOC
## Method: createWatchedTween

### Description
Creates a tween object that is automatically managed by the view's rendering loop. The view remains active as long as watched tweens exist. The tween is added to a watch list when started and removed when completed or stopped.

### Signature
createWatchedTween<T>(object: T, group?: false | Group): Tween<T>

### Type Parameters
*   **T** - The type of the object being tweened.

### Parameters
*   **object** (T) - Required - The object to be tweened.
*   **group** (false | Group) - Optional - The tween group to associate with this tween.
```

```APIDOC
## Method: forgetTween

### Description
Removes a tween from the view's watch list. This should typically be called from the tween's `onComplete()` or `onStop()` callbacks.

### Signature
forgetTween(tween: Tween<unknown>): void

### Parameters
*   **tween** (Tween<unknown>) - Required - The tween object to remove from the watch list.
```

```APIDOC
## Method: getCamera

### Description
Retrieves the camera used for rendering the view. If multiple viewports exist, it returns the camera for the default viewport.

### Signature
getCamera(): Camera

### Returns
*   Camera - The view's camera object.
```

```APIDOC
## Method: getDefaultViewport

### Description
Gets the default viewport of the 3D view.

### Signature
getDefaultViewport(): ViewportInterface

### Returns
*   ViewportInterface - The default viewport object.
```

```APIDOC
## Method: getLastMousePosition

### Description
Retrieves the last recorded mouse position within the view.

### Signature
getLastMousePosition(): MouseEventCoordinatesInterface

### Returns
*   MouseEventCoordinatesInterface - An object containing the last mouse coordinates.
```

```APIDOC
## Method: getObjectsUnderCursor

### Description
Identifies and returns all 3D objects that intersect with the cursor at a given screen position.

### Signature
getObjectsUnderCursor(pos: MouseEventCoordinatesInterface): Intersection<Object3D<Object3DEventMap>>[]

### Parameters
*   **pos** (MouseEventCoordinatesInterface) - Required - The screen coordinates to check for intersections.
```

```APIDOC
## Method: getPositionOnGroundPlane

### Description
Calculates a 3D position on the ground plane based on screen coordinates and an optional viewport.

### Signature
getPositionOnGroundPlane(x: number, y: number, z: number, viewport?: ViewportInterface): Vector3

### Parameters
*   **x** (number) - Required - The X coordinate.
*   **y** (number) - Required - The Y coordinate.
*   **z** (number) - Required - The Z coordinate.
*   **viewport** (ViewportInterface) - Optional - The viewport to use for the calculation.
```

```APIDOC
## Method: getScreenshot

### Description
Captures a screenshot of the current view. Allows specifying the MIME type and quality for the image.

### Signature
getScreenshot(mimeType?: string, quality?: number): ScreenshotDataInterface

### Parameters
*   **mimeType** (string) - Optional - The MIME type of the image (e.g., 'image/png').
*   **quality** (number) - Optional - The quality of the image (for formats like JPEG).
```

```APIDOC
## Method: invalidateScene

### Description
Invalidates the scene, triggering a re-render. This should be called whenever scene contents are modified. The rendering occurs at a fixed rate, so repeated calls might not result in immediate re-renders.

### Signature
invalidateScene(callback?: () => void): void

### Parameters
*   **callback** (() => void) - Optional - A callback function to execute after the scene is rendered.
```

```APIDOC
## Method: unprojectEvent

### Description
Converts a mouse event's screen coordinates into a 3D world coordinate. An optional Z-depth can be provided.

### Signature
unprojectEvent(event: MouseEvent, z?: number): Vector3

### Parameters
*   **event** (MouseEvent) - Required - The mouse event object.
*   **z** (number) - Optional - The Z-depth to use for unprojection.
```

```APIDOC
## Method: unprojectScreenCoordinates

### Description
Converts 2D screen coordinates (x, y) into a 3D world coordinate. An optional Z-depth and viewport can be specified.

### Signature
unprojectScreenCoordinates(x: number, y: number, z?: number, viewport?: ViewportInterface): Vector3

### Parameters
*   **x** (number) - Required - The screen X coordinate.
*   **y** (number) - Required - The screen Y coordinate.
*   **z** (number) - Optional - The Z-depth to use for unprojection.
*   **viewport** (ViewportInterface) - Optional - The viewport to use for the unprojection.
```

```APIDOC
## Method: watchTween

### Description
Adds a tween object to the view's watch list. The rendering loop will remain active as long as at least one tween is being watched.

### Signature
watchTween(tween: Tween<unknown>): void

### Parameters
*   **tween** (Tween<unknown>) - Required - The tween object to watch.
```

--------------------------------

### Get the current position on the ground plane

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/MapViewInterface.html

Calculates a 3D position on the ground plane based on screen coordinates (x, y) and a depth value (z). An optional viewport can be specified.

```typescript
const groundPosition = view.getPositionOnGroundPlane(100, 200, 0);
console.log(groundPosition);
```

--------------------------------

### findAll

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/poirepositoryinterface

Retrieves all POIs from the repository, with an option to force a fresh fetch from the server.

```APIDOC
## findAll

### Description
Gets all repository items. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server.

### Method
findAll

### Parameters
#### Query Parameters
- **forceFetch** (boolean) - Optional - Whether to bypass the cache and retrieve a fresh copy from the server.

### Returns
Promise<PoiInterface[]>: Promise with the repository items.
```

--------------------------------

### Get Poi Icon Signed URL

Source: https://ivion-api.docs.navvis.com/v11.10.6/reference/interfaces/PoiInterface.html

Retrieves the URL for a POI's icon, providing proper authentication for custom icons. A default icon is supplied if none is defined.

```typescript
getIconSignedUrl(): Promise<string>;
```
Tokens:
Raw