AnnotationsPlugin | @xeokit/xeokit-sdk

Viewer plugin that creates Annotations.

Hierarchy

Plugin
- AnnotationsPlugin

Index

Constructors

constructor

Properties

Accessors

surfaceOffset

Methods

Constructors

constructor

new AnnotationsPlugin(viewer: Viewer, cfg: AnnotationsPluginConfiguration): AnnotationsPlugin

Overrides Plugin.constructor
- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:29
Parameters
- viewer: Viewer
  
  The Viewer.
- cfg: AnnotationsPluginConfiguration
  
  Plugin configuration.
Returns AnnotationsPlugin

Properties

annotations

annotations: {}

The Annotations created by AnnotationsPlugin.createAnnotation, each mapped to its Annotation.id.

Type declaration

[key: string]: Annotation

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Accessors

surfaceOffset

get surfaceOffset(): number
set surfaceOffset(arg: number): void

- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:58
Gets the amount by which an Annotation is offset from the surface of its Entity when created by AnnotationsPlugin.createAnnotation, when we create the Annotation by supplying a PickResult to AnnotationsPlugin.createAnnotation.

This is 0.3 by default.

Returns number
The surface offset.
- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:47
Sets the amount by which each Annotation is offset from the surface of its Entity, when we create the Annotation by supplying a PickResult to AnnotationsPlugin.createAnnotation.

See the class comments for more info.

This is 0.3 by default.

Parameters
- arg: number
Returns void

Methods

clear

clear(): void

- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:114
Destroys all Annotations.

Returns void

createAnnotation

createAnnotation(params: { entity?: Entity; eye?: number[]; id: string; labelElementId?: string; labelHTML?: string; labelShown?: boolean; look?: number[]; markerElementId?: string; markerHTML?: string; markerShown?: boolean; occludable?: boolean; pickResult?: PickResult; projection?: string; up?: number[]; values?: {}; worldPos?: number[] }): Annotation

- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:85
Creates an Annotation.

The Annotation is then registered by Annotation.id in AnnotationsPlugin.annotations.

Parameters
- params: { entity?: Entity; eye?: number[]; id: string; labelElementId?: string; labelHTML?: string; labelShown?: boolean; look?: number[]; markerElementId?: string; markerHTML?: string; markerShown?: boolean; occludable?: boolean; pickResult?: PickResult; projection?: string; up?: number[]; values?: {}; worldPos?: number[] }
  
  Annotation configuration.
  - Optional entity?: Entity
  - Optional eye?: number[]
  - id: string
    
    Unique ID to assign to Annotation.id. The Annotation will be registered by this in AnnotationsPlugin.annotations and {@link Scene.components}. Must be unique among all components in the Viewer.
  - Optional labelElementId?: string
  - Optional labelHTML?: string
  - Optional labelShown?: boolean
  - Optional look?: number[]
  - Optional markerElementId?: string
  - Optional markerHTML?: string
  - Optional markerShown?: boolean
  - Optional occludable?: boolean
  - Optional pickResult?: PickResult
  - Optional projection?: string
  - Optional up?: number[]
  - Optional values?: {}
    - [key: string]: string | number
  - Optional worldPos?: number[]
Returns Annotation
The new Annotation.

destroy

destroy(): void

Inherited from Plugin.destroy
- Defined in viewer/Plugin.d.ts:68
Destroys this Plugin and removes it from its Viewer.

Returns void

destroyAnnotation

destroyAnnotation(id: string): void

- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:109
Destroys an Annotation.

Parameters
- id: string
  
  ID of Annotation to destroy.
Returns void

error

error(msg: string): void

Inherited from Plugin.error
- Defined in viewer/Plugin.d.ts:63
Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

fire

fire(event: string, value: any): void

Inherited from Plugin.fire
- Defined in viewer/Plugin.d.ts:42
Fires an event at this Plugin.

Parameters
- event: string
  
  The event type name
- value: any
  
  The event parameters
Returns void

log

log(msg: string): void

Inherited from Plugin.log
- Defined in viewer/Plugin.d.ts:49
Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

on

on(event: "annotationCreated", callback: (annotationId: string) => void): void
on(event: "annotationDestroyed", callback: (annotationId: string) => void): void
on(event: "markerMouseEnter", callback: (annotation: Annotation) => void): void
on(event: "markerMouseLeave", callback: (annotation: Annotation) => void): void
on(event: "markerClicked", callback: (annotation: Annotation) => void): void

Overrides Plugin.on
- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:121
Fires when a annotation is created.

Parameters
- event: "annotationCreated"
  
  The annotationCreated event
- callback: (annotationId: string) => void
  
  Callback fired on the event
  - - (annotationId: string): void
    - Parameters
      - annotationId: string
      Returns void
Returns void
Overrides Plugin.on
- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:128
Fires when a annotation is destroyed.

Parameters
- event: "annotationDestroyed"
  
  The annotationDestroyed event
- callback: (annotationId: string) => void
  
  Callback fired on the event
  - - (annotationId: string): void
    - Parameters
      - annotationId: string
      Returns void
Returns void
Overrides Plugin.on
- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:135
Fires when a mouse enters a annotation.

Parameters
- event: "markerMouseEnter"
  
  The markerMouseEnter event
- callback: (annotation: Annotation) => void
  
  Callback fired on the event
  - - (annotation: Annotation): void
    - Parameters
      - annotation: Annotation
      Returns void
Returns void
Overrides Plugin.on
- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:142
Fires when a mouse leave an annotation.

Parameters
- event: "markerMouseLeave"
  
  The markerMouseLeave event
- callback: (annotation: Annotation) => void
  
  Callback fired on the event
  - - (annotation: Annotation): void
    - Parameters
      - annotation: Annotation
      Returns void
Returns void
Overrides Plugin.on
- Defined in plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts:149
Fires when a mouse leave an annotation.

Parameters
- event: "markerClicked"
  
  The markerClicked event
- callback: (annotation: Annotation) => void
  
  Callback fired on the event
  - - (annotation: Annotation): void
    - Parameters
      - annotation: Annotation
      Returns void
Returns void

warn

warn(msg: string): void

Inherited from Plugin.warn
- Defined in viewer/Plugin.d.ts:56
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

viewer: Viewer

cfg: AnnotationsPluginConfiguration

Returns AnnotationsPlugin

Properties

annotations

Type declaration

[key: string]: Annotation

id

viewer

Accessors

surfaceOffset

Returns number

Parameters

arg: number

Returns void

Methods

clear

Returns void

createAnnotation

Parameters

Optional entity?: Entity

Optional eye?: number[]

id: string

Optional labelElementId?: string

Optional labelHTML?: string

Optional labelShown?: boolean

Optional look?: number[]

Optional markerElementId?: string

Optional markerHTML?: string

Optional markerShown?: boolean

Optional occludable?: boolean

Optional pickResult?: PickResult

Optional projection?: string

Optional up?: number[]

Optional values?: {}

[key: string]: string | number

Optional worldPos?: number[]

Returns Annotation

destroy

Returns void

destroyAnnotation

Parameters

id: string

Returns void

error

Parameters

msg: string

Returns void

fire

Parameters

event: string

value: any

Returns void

log

Parameters

msg: string

Returns void

on

Parameters

event: "annotationCreated"

callback: (annotationId: string) => void

Parameters

annotationId: string

Returns void

Returns void

Parameters

event: "annotationDestroyed"

callback: (annotationId: string) => void

Parameters

annotationId: string

Returns void