PBText | plotboilerplate

classdesc: A simple text element: position, fontSize, fontFamily, color, textAlign, lineHeight and rotation.
requires: FontOptions
requires: FontSize
requires: FontStyle
requires: FontWeight
requires: Vertex
requires: SVGSerializale
requires: UID
requires: UIDGenerator

Hierarchy

PBText

Implements

Index

Constructors

constructor

Properties

Methods

destroy

Constructors

constructor

new PBText(text: string, anchor?: Vertex, options?: FontOptions): PBText

- Defined in src/ts/PBText.ts:117
Create a new circle with given center point and radius.

name

Circle

Parameters
- text: string
- Optional anchor: Vertex
- Optional options: FontOptions
Returns PBText

Properties

anchor

anchor: Vertex

member: {Vertex}
memberof: PBText
instance

Readonly className

className: string = "PBText"

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

color

color: string | undefined

member: {number}
memberof: PBText
instance

fontFamily

fontFamily: string | undefined

member: {number}
memberof: PBText
instance

fontSize

fontSize: number | undefined

member: {number}
memberof: PBText
instance

fontStyle

fontStyle: FontStyle | undefined

member: {FontStyle}
memberof: PBText
instance

fontWeight

fontWeight: FontWeight | undefined

member: {FontWeight}
memberof: PBText
instance

isDestroyed

isDestroyed: boolean

member: isDestroyed
memberof: PBText
instance

lineHeight

lineHeight: number | undefined

member: {number}
memberof: PBText
instance

rotation

rotation: number | undefined

member: {number}
memberof: PBText
instance

text

text: string

member: {string}
memberof: PBText
instance

textAlign

textAlign: CanvasRenderingContext2D["textAlign"] | undefined

member: {CanvasRenderingContext2D["textAlign"]}
memberof: PBText
instance

Readonly uid

uid: UID

The UID of this drawable object.

member: {UID}
memberof: PBText
instance
readonly

Methods

destroy

destroy(): void

- Defined in src/ts/PBText.ts:146
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