AttachmentAPI

• webVis API Reference
• AttachmentAPI

Interface AttachmentAPI

With the AttachmentAPI you can access additional data attached to a node.

Hierarchy

• AttachmentAPI
  • ContextAPI

Index

Methods

createAttachment fetchAttachmentData getAttachmentData getAttachmentDataURI removeAttachment setAttachmentData setAttachmentDataURI

Methods

createAttachment

• createAttachment(dataType?: AttachmentType): number

• Creates a new attachment.

  Parameters

  • Optional dataType: AttachmentType

    Specifies the attachment data type.

  Returns number

  The attachment id.

fetchAttachmentData

• fetchAttachmentData(attachmentID?: number): Promise<any>

• Fetches & returns the attachment data.

  Parameters

  • Optional attachmentID: number

    Specifies the attachment object.

  Returns Promise<any>

  The attached data.

getAttachmentData

• getAttachmentData(attachmentID?: number): any

• Returns the attachment data.

  Deprecated

  getAttachmentData is deprecated, please use fetchAttachmentData instead.

  Parameters

  • Optional attachmentID: number

    Specifies the attachment object.

  Returns any

  The attached data

getAttachmentDataURI

• getAttachmentDataURI(attachmentID?: number): string

• Returns the attachment data URI.

  Parameters

  • Optional attachmentID: number

    Specifies the attachment object.

  Returns string

removeAttachment

• removeAttachment(attachmentID?: number): void

• Removes an existing attachment.

  Parameters

  • Optional attachmentID: number

    Specifies the attachment object.

  Returns void

setAttachmentData

• setAttachmentData(attachmentID?: number, data?: any): void

• Sets the attachment data.

  Parameters

  • Optional attachmentID: number

    Specifies the attachment object.

  • Optional data: any

    The new attachment data.

  Returns void

setAttachmentDataURI

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

• Sets the attachment data URI.

  Parameters

  • Optional attachmentID: number

    Specifies the attachment object.

  • Optional dataURI: string

    The attachment data URI.

  Returns void