Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTMLElementAnchorData Abstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new HTMLElementAnchorData(properties: { data: any; format: "custom" | "image" | "text"; location: vec3; hideable?: boolean; id?: string; intersectionTarget?: string | string[] | Box; version?: string; viewports?: string[] }): HTMLElementAnchorData

  • Creates a custom data node.

    Parameters

    • properties: { data: any; format: "custom" | "image" | "text"; location: vec3; hideable?: boolean; id?: string; intersectionTarget?: string | string[] | Box; version?: string; viewports?: string[] }
      • data: any
      • format: "custom" | "image" | "text"
      • location: vec3
      • Optional hideable?: boolean
      • Optional id?: string
      • Optional intersectionTarget?: string | string[] | Box
      • Optional version?: string
      • Optional viewports?: string[]

    Returns HTMLElementAnchorData

Properties

Protected internalHtmlElement

internalHtmlElement: HTMLDivElement

Accessors

convertedObject

  • get convertedObject(): {}
  • set convertedObject(value: {}): void

  • The converted object of the tree node.

    Returns {}

    • [key: string]: unknown

  • The converted object of the tree node.

    Parameters

    • value: {}
      • [key: string]: unknown

    Returns void

data

  • get data(): any
  • set data(value: any): void

format

  • get format(): "custom" | "image" | "text"
  • set format(value: "custom" | "image" | "text"): void

hideable

  • get hideable(): boolean
  • set hideable(value: boolean): void

id

  • get id(): string

  • The ID of the tree node data.

    Returns string

intersectionTarget

  • get intersectionTarget(): undefined | string | string[] | Box
  • set intersectionTarget(value: undefined | string | string[] | Box): void

location

  • get location(): vec3
  • set location(value: vec3): void

updateCallback

  • get updateCallback(): null | ((newVersion: string, oldVersion: string) => void)
  • set updateCallback(value: null | ((newVersion: string, oldVersion: string) => void)): void

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Returns null | ((newVersion: string, oldVersion: string) => void)

  • The update callback for the tree node data. This callback is called when the node is updated, e.g. when the version changes.

    Parameters

    • value: null | ((newVersion: string, oldVersion: string) => void)

    Returns void

updateCallbackConvertedObject

  • get updateCallbackConvertedObject(): null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)
  • set updateCallbackConvertedObject(value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)): void

  • The update callback for the converted object of the tree node.

    Returns null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

  • The update callback for the converted object of the tree node.

    Parameters

    • value: null | ((newObj: unknown, oldObj: unknown, viewport: string) => void)

    Returns void

version

  • get version(): string

  • The version of the tree node data. If the version changes, the node data will be marked for an update. A version change can be triggered via updateVersion.

    Returns string

viewports

  • get viewports(): string[]
  • set viewports(value: string[]): void

Methods

Abstract clone

Abstract create

createViewerHtmlElement

  • createViewerHtmlElement(viewer: string): null | HTMLDivElement

getViewerHtmlElement

  • getViewerHtmlElement(viewer: string): null | HTMLDivElement

update

updateVersion

  • updateVersion(): void