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.

AttachmentAPI

Interface AttachmentAPI

webvis: The AttachmentAPI

Overview

The AttachmentAPI provides basic functionalities to define additional data optionally attached to a node. This data can be of any type defined in AttachmentType and is stored in the form of a URI. The AttachmentAPI provides methods to fetch, set and remove the data.

Quick Start

Example: Create a new attachment with text data.

const context = webvis.getContext();

// Create a new attachment
const attachmentId = context.createAttachment(webvis.AttachmentType.TEXT);

// Set the attachment data
context.setAttachmentData(attachmentId, "hello world");

// Fetch the attachment data
await context.fetchAttachmentData(attachmentId); // returns "hello world"

Adding Attachments to nodes

Attachments can be added to nodes using the setProperty method.

Example: attaching an attachment to a node.

const context = webvis.getContext();

// Create a new attachment and set data
const attachmentId = context.createAttachment(webvis.AttachmentType.TEXT);
context.setAttachmentData(attachmentId, "hello world");

// Attach the attachment to a node
context.setProperty(nodeId, webvis.Property.ATTACHMENT, attachmentId);

// Fetch the attachment data
await context.getProperty(nodeId, webvis.Property.ATTACHMENT); // returns "hello world"

Events

The following events are associated with the AttachmentAPI:

interface AttachmentAPI {
    createAttachment(dataType: AttachmentType): number;
    fetchAttachmentData<T = any>(attachmentID: number): Promise<T>;
    getAttachmentData<T = any>(attachmentID: number): T;
    getAttachmentDataURI(attachmentID: number): string;
    removeAttachment(attachmentID: number, safe?: boolean): RemoveState;
    setAttachmentData<T = any>(attachmentID: number, data: T): void;
    setAttachmentDataURI(attachmentID: number, dataURI: string): void;
}

Hierarchy (View Summary)

Methods

createAttachment fetchAttachmentData getAttachmentData getAttachmentDataURI removeAttachment setAttachmentData setAttachmentDataURI

Methods

createAttachment

fetchAttachmentData

  • fetchAttachmentData<T = any>(attachmentID: number): Promise<T>

  • Fetches and returns the attachment data of the specified attachment.

    Type Parameters

    • T = any

      The data type fitting the AttachmentType of the attachment data.

    Parameters

    • attachmentID: number

      Specifies the attachment object.

    Returns Promise<T>

    The attached data.

getAttachmentData

  • getAttachmentData<T = any>(attachmentID: number): T

  • Returns the attachment data.

    Type Parameters

    • T = any

    Parameters

    • attachmentID: number

      Specifies the attachment object.

    Returns T

    The attached data

    Deprecated

    getAttachmentData is deprecated, please use fetchAttachmentData instead.

getAttachmentDataURI

  • getAttachmentDataURI(attachmentID: number): string

  • Returns the attachment data URI.

    Parameters

    • attachmentID: number

      Specifies the attachment object.

    Returns string

    The attachment data URI.

removeAttachment

  • removeAttachment(attachmentID: number, safe?: boolean): RemoveState

  • Removes the Attachment from the scene and all related snapshots.

    Triggers an AttachmentRemovedEvent.

    Parameters

    • attachmentID: number

      Specifies the attachment object.

    • Optionalsafe: boolean

      Performs a safe remove which interrupt the removal process if the attachment is part of one or more snapshots. If no safe remove, a snapshot could link to missing data. Default: false.

    Returns RemoveState

    The state of the removal process.

setAttachmentData

  • setAttachmentData<T = any>(attachmentID: number, data: T): void

  • Sets the attachment data.

    Triggers an AttachmentDataChangedEvent.

    Type Parameters

    • T = any

    Parameters

    • attachmentID: number

      Specifies the attachment object.

    • data: T

      The new attachment data.

    Returns void

setAttachmentDataURI

  • setAttachmentDataURI(attachmentID: number, dataURI: string): void

  • Sets the attachment data URI.

    Parameters

    • attachmentID: number

      Specifies the attachment object.

    • dataURI: string

      The attachment data URI.

    Returns void