Warning
Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.
SessionStorageAPI¶
Interface SessionStorageAPI
changeSnapshot(
snapshotID: number,
properties: SnapshotProperties,
): SnapshotProperties;
changeSnapshot(
snapshotID: number,
name?: string,
screenshotURL?: string,
order?: number,
): SnapshotProperties;
createSnapshot(
name?: string,
options?: SnapshotCreationOptions,
): Promise<number>;
getSnapshotData(
snapshotID: number,
): { attachmentID: number; name: string; order: number };
getSnapshots(): number[];
importSession(data: any, format?: "xscn"): Promise<any>;
isOfflineStorageAvailable(): Promise<boolean>;
removeSnapshot(snapshotID: number): void;
requestSnapshotData(snapshotID: number): Promise<void | SnapshotProperties>;
restoreSession(handle: string): Promise<void>;
restoreSnapshot(
snapshotID: number,
options?: SnapshotRestoreOptions,
): Promise<void>;
storeSession(): Promise<string | void>;
transferSession(
progressCallback: StoreSessionProgressCallback,
): Promise<string | void>;
transferSession(): Promise<string | void>;
}
Hierarchy (View Summary)
- SessionStorageAPI
Methods
change
- changeSnapshot(
snapshotID: number,
properties: SnapshotProperties,
): 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.
- snapshotID: number
- changeSnapshot(
snapshotID: number,
name?: string,
screenshotURL?: string,
order?: number,
): 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.
Optionalname: stringThe new name of the Snapshot.
OptionalscreenshotURL: stringThe new screenshot URL of the Snapshot.
Optionalorder: numberThe order inside the List of Snapshots.
Returns SnapshotProperties
- snapshotID: number
create
- createSnapshot(
name?: string,
options?: SnapshotCreationOptions,
): Promise<number> Creates a Snapshot of the current.
Parameters
Optionalname: stringThe Name of the Snapshot.
Optionaloptions: SnapshotCreationOptionsOptions used for the Snapshot creation.
Returns Promise<number>
The Snapshot ID.
get
- getSnapshotData(
snapshotID: number,
): { attachmentID: number; name: string; order: number } Parameters
- snapshotID: number
Returns { attachmentID: number; name: string; order: number }
The data of the specified Snapshot.
Deprecated
getSnapshotData is deprecated, please use requestSnapshotData instead.
get
import
is
- isOfflineStorageAvailable(): Promise<boolean>
Returns Promise<boolean>
Deprecated
isOfflineStorageAvailable is deprecated.
Checks if offline storage is currently available which can be used to transfer a session via transferSession.
remove
request
- requestSnapshotData(snapshotID: number): Promise<void | SnapshotProperties>
Parameters
- snapshotID: number
Returns Promise<void | SnapshotProperties>
The data of the specified Snapshot.
restore
restore
- restoreSnapshot(
snapshotID: number,
options?: SnapshotRestoreOptions,
): 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
Optionaloptions: SnapshotRestoreOptions
Returns Promise<void>
store
- storeSession(): Promise<string | void>
Temporarily stores the Session in the connected hub instance and returns an access handle. This function does not transfer Caches of referenced resources to the connected hub instance. For that, see transferSession.
Returns Promise<string | void>
The access handle of the stored Session.
transfer
- transferSession(
progressCallback: StoreSessionProgressCallback,
): Promise<string | void> ExperimentalParameters
- progressCallback: StoreSessionProgressCallback
Can be used to track the progress of the transfer.
Returns Promise<string | void>
The access handle of the transferred Session.
Deprecated
transferSession with progress callback is deprecated. Please use transferSession without parameters and utilize the returned Promise instead!
Temporarily stores the Session in the connected hub instance and returns an access handle. Transfers Caches of referenced resources to the connected hub instance if they are not already present.
- progressCallback: StoreSessionProgressCallback
- transferSession(): Promise<string | void>
ExperimentalTemporarily stores the Session in the connected hub instance and returns an access handle. Transfers Caches of referenced resources to the connected hub instance if they are not already present.
Returns Promise<string | void>
The access handle of the transferred Session.
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.