Class ImageAnnotation

Raster Image based Annotation

Hierarchy (View Summary)

Annotation
- ImageAnnotation

Index

Constructors

Accessors

backgroundColor backgroundHoverColor borderColor borderHoverColor click image maxDistanceMm

Constructors

constructor

new ImageAnnotation(): ImageAnnotation
Returns ImageAnnotation
Overrides Annotation.constructor
- Defined in ViewerCommon/viewercommon.d.ts:641

Accessors

backgroundColor

get backgroundColor(): TinyColor
Get the background color

Returns TinyColor
- Defined in ViewerCommon/viewercommon.d.ts:681
set backgroundColor(color: TinyColor): void
Set the background color
Parameters
- color: TinyColor
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:676

backgroundHoverColor

get backgroundHoverColor(): TinyColor
Get the background hover color

Returns TinyColor
- Defined in ViewerCommon/viewercommon.d.ts:691
set backgroundHoverColor(color: TinyColor): void
Set the background hover color
Parameters
- color: TinyColor
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:686

borderColor

get borderColor(): TinyColor
Get the border color

Returns TinyColor
- Defined in ViewerCommon/viewercommon.d.ts:661
set borderColor(color: TinyColor): void
Set the border color
Parameters
- color: TinyColor
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:656

borderHoverColor

get borderHoverColor(): TinyColor
Get the border hover color

Returns TinyColor
- Defined in ViewerCommon/viewercommon.d.ts:671
set borderHoverColor(color: TinyColor): void
Set the border hover color
Parameters
- color: TinyColor
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:666

click

get click(): Function
Returns Function
The currently set click listener
Inherited from Annotation.click
- Defined in ViewerCommon/viewercommon.d.ts:547
set click(fn: Function): void
Attach a click listener, only one click listener can be attached, previous one will be overwritten
Parameters
- fn: Function
  The method to call whenever this annotation is clicked
Returns void
Inherited from Annotation.click
- Defined in ViewerCommon/viewercommon.d.ts:542

image

get image(): string
Returns string
The currently set URL for the image
- Defined in ViewerCommon/viewercommon.d.ts:651
set image(image: string): void
Set the URL of the image. This can be a local URL or a full remote URL
Parameters
- image: string
Returns void
- Defined in ViewerCommon/viewercommon.d.ts:646

maxDistanceMm

get maxDistanceMm(): number
Returns number
The currently set max distance in mm
Inherited from Annotation.maxDistanceMm
- Defined in ViewerCommon/viewercommon.d.ts:559
set maxDistanceMm(distance: number): void
Set the maximum distance from the annotation to the camera at which it will still be displayed. The default value of this is 0, which means that at any distance the annotation will be displayed
Parameters
- distance: number
  The max distance in mm
Returns void
Inherited from Annotation.maxDistanceMm
- Defined in ViewerCommon/viewercommon.d.ts:554