Class AnnotationController

constructor

• new AnnotationController(
      client: SceneViewAPIClient,
      jwtProvider: JwtProvider,
      deviceIdProvider: () => string | undefined,
  ): AnnotationController

  Parameters

  • client: SceneViewAPIClient
  • jwtProvider: JwtProvider
  • deviceIdProvider: () => string | undefined

  Returns AnnotationController

onStateChange

addAnnotationSet

• addAnnotationSet(id: string): Promise<AnnotationState>

  Activates an annotation set for the current session. This method will emit an event on onStateChange when the annotation set has been added, and return a promise the resolves with the new annotation state.

  Parameters

  • id: string

    The ID of the annotation set.

  Returns Promise<AnnotationState>

  A promise that resolves with the new annotation state.

connect

• connect(pollingIntervalInMs?: number): void

  Starts the automatic retrieval of annotation state. When a new annotation state is retrieved, an event will be emitted on onStateChange.

  Parameters

  • pollingIntervalInMs: number = 10000

    The interval to poll for a new annotation state.

  Returns void

disconnect

• disconnect(): void

  Stops the automatic retrieval of annotation state.

  Returns void

fetch

• fetch(opts?: { signal?: AbortSignal }): Promise<AnnotationState>

  Performs a manual fetch of the annotation state. This method will emit an event on onStateChange when the annotation set has been added, and return a promise the resolves with the new annotation state.

  Parameters

  • opts: { signal?: AbortSignal } = {}

    Options to configure the fetch behavior. If an abort signal is given, then this will not emit a change event if the signal is aborted.

  Returns Promise<AnnotationState>

  A promise that resolves with the new annotation state.

removeAnnotationSet

• removeAnnotationSet(id: string): Promise<AnnotationState>

  Deactivates an annotation set for the current session. This method will emit an event on onStateChange when the annotation set has been added, and return a promise the resolves with the new annotation state.

  Parameters

  • id: string

    The ID of the annotation set.

  Returns Promise<AnnotationState>

  A promise that resolves with the new annotation state.