SessionStorageAPI

• webVis API Reference
• SessionStorageAPI

Interface SessionStorageAPI

With these functions the user can control webvis' management of SessionStorage objects and Snapshots.

The Session describes the whole state of the 3D Space, which can be shared, stored and restored. Snapshot are a subset of a 3D Space and describe a momentary state, which can include other elements of the 3D Space like Clipplanes and Measurements.

Hierarchy

• SessionStorageAPI
  • ContextAPI

Index

Methods

changeSnapshot createSnapshot getSnapshotData getSnapshots importSession isOfflineStorageAvailable removeSnapshot requestSnapshotData restoreSession restoreSnapshot storeSession transferSession

Methods

changeSnapshot

• changeSnapshot(snapshotID, properties): SnapshotProperties

• Changes one or more properties of a Snapshot with the specified ID.

  Parameters

  • snapshotID: number

    The ID of the Snapshot you want to change.

  • properties: SnapshotProperties

    The properties of the Snapshot you want to change.

  Returns SnapshotProperties

  An object with the changed Properties.
• changeSnapshot(snapshotID, name?, screenshotURL?, order?): SnapshotProperties

• This changes the textual description of the Snapshot for given snapshotID to the value of text.

  Parameters

  • snapshotID: number

    The ID of the Snapshot.

  • Optional name: string

    The new name of the Snapshot.

  • Optional screenshotURL: string

    The new screenshot URL of the Snapshot.

  • Optional order: number

    The order inside the List of Snapshots.

  Returns SnapshotProperties

  Deprecated

  Calling changeSnapshot with single parameters is deprecated, please use SnapshotProperties instead.

createSnapshot

• createSnapshot(name?, options?): Promise<number>

• Creates a Snapshot of the current.

  Parameters

  • Optional name: string

    The Name of the Snapshot.

  • Optional options: SnapshotCreationOptions

    Options used for the Snapshot creation.

  Returns Promise<number>

  The Snapshot ID.

getSnapshotData

• getSnapshotData(snapshotID): {
      attachmentID: number;
      name: string;
      order: number;
  }

• Parameters

  • snapshotID: number

  Returns {
      attachmentID: number;
      name: string;
      order: number;
  }

  The data of the specified Snapshot.

  • attachmentID: number

  • name: string

  • order: number

  Deprecated

  getSnapshotData is deprecated, please use requestSnapshotData instead.

getSnapshots

• getSnapshots(): number[]

• Returns the ids of all available Snapshots.

  Returns number[]

  The ids of all available Snapshots.

importSession

• importSession(data, format?): Promise<any>

• Imports a session from the data string of the given format. Supported formats are: JSON.

  Parameters

  • data: any

    the content of the file.

  • Optional format: "xscn"

  Returns Promise<any>

isOfflineStorageAvailable

• isOfflineStorageAvailable(): Promise<boolean>

• Checks if offline storage is currently available which can be used to transfer a session via transferSession.

  Returns Promise<boolean>

removeSnapshot

• removeSnapshot(snapshotID): void

• Deletes the Snapshot for given snapshotID.

  Parameters

  • snapshotID: number

  Returns void

requestSnapshotData

• requestSnapshotData(snapshotID): Promise<void | SnapshotProperties>

• Parameters

  • snapshotID: number

  Returns Promise<void | SnapshotProperties>

  The data of the specified Snapshot.

restoreSession

• restoreSession(handle): Promise<void>

• Restores a Session for the given access handle from the infrastructure.

  Parameters

  • handle: string

  Returns Promise<void>

restoreSnapshot

• restoreSnapshot(snapshotID, options?): Promise<void>

• Restores the Snapshot for the given snapshotID. The settings parameter allows to control the subset of the Snapshot data to be restored.

  Parameters

  • snapshotID: number

  • Optional options: SnapshotRestoreOptions

  Returns Promise<void>

storeSession

• storeSession(offline?, progressCallback?): Promise<string | void>

• Temporarily stores the Session in the infrastructure and returns an access handle.

  Parameters

  • Optional offline: boolean

  • Optional progressCallback: StoreSessionProgressCallback

  Returns Promise<string | void>

  The access handle of the stored Session.

transferSession

• transferSession(progressCallback?): Promise<string | void>
• Experimental

  Temporarily transfers the Session to a local storage and returns an access handle.

  Parameters

  • Optional progressCallback: StoreSessionProgressCallback

    Can be used to track the progress of the transfer.

  Returns Promise<string | void>

  The access handle of the transferred Session.