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

toSVGString

Constructors

constructor

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

- Defined in src/ts/PBImage.ts:68
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

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

toSVGString

toSVGString(options: { className?: string }): string

- Defined in src/ts/PBImage.ts:98
Convert this vertex to SVG code.

deprecated

DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.

method

toSVGString

instance

memberof

PBImage

Parameters
- options: { className?: string }
  
  An optional set of options, like 'className'.
  - Optional className?: string
Returns string

A string representing the SVG code for this vertex.

Generated using TypeDoc