PBImage | plotboilerplate

classdesc: A wrapper for image objects. Has an upper left and a lower right corner point.
requires: Vertex
requires: SVGSerializable
requires: UID
requires: UIDGenerator

Hierarchy

PBImage

Implements

SVGSerializable

Index

Constructors

constructor

Properties

Methods

destroy

Constructors

constructor

new PBImage(image: HTMLImageElement, upperLeft: Vertex, lowerRight: Vertex): PBImage

- Defined in src/ts/PBImage.ts:72
The constructor.

name

PBImage

Parameters
- image: HTMLImageElement
  
  The actual image.
- upperLeft: Vertex
  
  The upper left corner.
- lowerRight: Vertex
  
  The lower right corner.
Returns PBImage

Properties

Readonly className

className: string = "PBImage"

Required to generate proper CSS classes and other class related IDs.

image

image: HTMLImageElement

member: {Vertex}
memberof: PBImage
instance

isDestroyed

isDestroyed: boolean

member: isDestroyed
memberof: PBImage
instance

lowerRight

lowerRight: Vertex

member: {Vertex}
memberof: PBImage
instance

Readonly uid

uid: UID

The UID of this drawable object.

member: {UID}
memberof: PBImage
instance
readonly

upperLeft

upperLeft: Vertex

member: {Vertex}
memberof: PBImage
instance

Methods

destroy

destroy(): void

- Defined in src/ts/PBImage.ts:95
This function should invalidate any installed listeners and invalidate this object. After calling this function the object might not hold valid data any more and should not be used.

Returns void

Generated using TypeDoc