Class Text

Hierarchy

ColoredShapeBase
- Text

Index

Constructors

Properties

beginning board ending length parent zzz

Methods

collapse dispose flagReset getBoundingBox hasBoundingBox hide noFill noStroke render show subdivide update viewee Measure

Constructors

constructor

new Text(owner, content, options?): Text
Parameters
- owner: Board
- content: string
- options: TextOptions = {}
Returns Text
Overrides ColoredShapeBase.constructor
- Defined in Text.ts:75

Properties

beginning

beginning: number

`Readonly`board

board: Board

ending

ending: number

length

length: number

parent

parent: unknown

`Readonly`zzz

zzz: ZZZ = ...

Accessors

anchor

get anchor(): "middle" | "start" | "end"
Returns "middle" | "start" | "end"
- Defined in Text.ts:470
set anchor(anchor): void
Parameters
- anchor: "middle" | "start" | "end"
Returns void
- Defined in Text.ts:473

baseline

get baseline():
    | "auto"
    | "text-bottom"
    | "alphabetic"
    | "ideographic"
    | "middle"
    | "central"
    | "mathematical"
    | "hanging"
    | "text-top"
Returns
    | "auto"
    | "text-bottom"
    | "alphabetic"
    | "ideographic"
    | "middle"
    | "central"
    | "mathematical"
    | "hanging"
    | "text-top"
- Defined in Text.ts:485
set baseline(baseline): void
Parameters
- baseline:
      | "auto"
      | "text-bottom"
      | "alphabetic"
      | "ideographic"
      | "middle"
      | "central"
      | "mathematical"
      | "hanging"
      | "text-top"
Returns void
- Defined in Text.ts:488

content

get content(): string
Returns string
- Defined in Text.ts:505
set content(value): void
Parameters
- value: string
Returns void
- Defined in Text.ts:508

dashes

get dashes(): number[]
Array of numbers. Odd indices represent dash length. Even indices represent dash space. A list of numbers that represent the repeated dash length and dash space applied to the stroke of the text.

Returns number[]
See
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray for more information on the SVG stroke-dasharray attribute.
Inherited from ColoredShapeBase.dashes
- Defined in ColoredShapeBase.ts:86
set dashes(dashes): void
Parameters
- dashes: number[]
Returns void
Inherited from ColoredShapeBase.dashes
- Defined in ColoredShapeBase.ts:89

decoration

get decoration(): TextDecoration[]
Returns TextDecoration[]
- Defined in Text.ts:515
set decoration(v): void
Parameters
- v: TextDecoration[]
Returns void
- Defined in Text.ts:518

direction

get direction(): "ltr" | "rtl"
Returns "ltr" | "rtl"
- Defined in Text.ts:521
set direction(direction): void
Parameters
- direction: "ltr" | "rtl"
Returns void
- Defined in Text.ts:524

dx

get dx(): string | number
Returns string | number
- Defined in Text.ts:533
set dx(dx): void
Parameters
- dx: string | number
Returns void
- Defined in Text.ts:536

dy

get dy(): string | number
Returns string | number
- Defined in Text.ts:543
set dy(dy): void
Parameters
- dy: string | number
Returns void
- Defined in Text.ts:546

fillColor

get fillColor(): Color
Returns Color
Inherited from ColoredShapeBase.fillColor
- Defined in ColoredShapeBase.ts:94
set fillColor(fill): void
Parameters
- fill: Color
Returns void
Inherited from ColoredShapeBase.fillColor
- Defined in ColoredShapeBase.ts:97

fillOpacity

get fillOpacity(): number
Returns number
Inherited from ColoredShapeBase.fillOpacity
- Defined in ColoredShapeBase.ts:101
set fillOpacity(fillOpacity): void
Parameters
- fillOpacity: number
Returns void
Inherited from ColoredShapeBase.fillOpacity
- Defined in ColoredShapeBase.ts:104

fontFamily

get fontFamily(): string
Returns string
- Defined in Text.ts:553
set fontFamily(family): void
Parameters
- family: string
Returns void
- Defined in Text.ts:556

fontStyle

get fontStyle(): "normal" | "italic" | "oblique"
Returns "normal" | "italic" | "oblique"
- Defined in Text.ts:571
set fontStyle(fontStyle): void
Parameters
- fontStyle: "normal" | "italic" | "oblique"
Returns void
- Defined in Text.ts:574

fontWeight

get fontWeight():
    | number
    | "normal"
    | "bold"
    | "bolder"
    | "lighter"
Returns
    | number
    | "normal"
    | "bold"
    | "bolder"
    | "lighter"
- Defined in Text.ts:579
set fontWeight(fontWeight): void
Parameters
- fontWeight:
      | number
      | "normal"
      | "bold"
      | "bolder"
      | "lighter"
Returns void
- Defined in Text.ts:582

id

get id(): string
Returns string
Inherited from ColoredShapeBase.id
- Defined in element.ts:25
set id(id): void
Parameters
- id: string
Returns void
Inherited from ColoredShapeBase.id
- Defined in element.ts:28

mask

get mask(): Shape
Returns Shape
Inherited from ColoredShapeBase.mask
- Defined in ShapeBase.ts:326
set mask(mask): void
Parameters
- mask: Shape
Returns void
Inherited from ColoredShapeBase.mask
- Defined in ShapeBase.ts:329

matrix

get matrix(): Matrix
Returns Matrix
Inherited from ColoredShapeBase.matrix
- Defined in ShapeBase.ts:336

opacity

get opacity(): number
Returns number
Inherited from ColoredShapeBase.opacity
- Defined in ShapeBase.ts:340
set opacity(opacity): void
Parameters
- opacity: number
Returns void
Inherited from ColoredShapeBase.opacity
- Defined in ShapeBase.ts:343

plumb

get plumb(): boolean
Returns boolean
Inherited from ColoredShapeBase.plumb
- Defined in ShapeBase.ts:273
set plumb(plumb): void
Parameters
- plumb: boolean
Returns void
Inherited from ColoredShapeBase.plumb
- Defined in ShapeBase.ts:276

R

get R(): G20
Returns G20
Inherited from ColoredShapeBase.R
- Defined in ShapeBase.ts:279
set R(R): void
Parameters
- R: G20
Returns void
Inherited from ColoredShapeBase.R
- Defined in ShapeBase.ts:282

scale

get scale(): number
Returns number
Inherited from ColoredShapeBase.scale
- Defined in ShapeBase.ts:287
set scale(scale): void
Parameters
- scale: number | [sx: number, sy: number]
Returns void
Inherited from ColoredShapeBase.scale
- Defined in ShapeBase.ts:295

skewX

get skewX(): number
Returns number
Inherited from ColoredShapeBase.skewX
- Defined in ShapeBase.ts:314
set skewX(skewX): void
Parameters
- skewX: number
Returns void
Inherited from ColoredShapeBase.skewX
- Defined in ShapeBase.ts:317

skewY

get skewY(): number
Returns number
Inherited from ColoredShapeBase.skewY
- Defined in ShapeBase.ts:320
set skewY(skewY): void
Parameters
- skewY: number
Returns void
Inherited from ColoredShapeBase.skewY
- Defined in ShapeBase.ts:323

strokeColor

get strokeColor(): Color
Returns Color
Inherited from ColoredShapeBase.strokeColor
- Defined in ColoredShapeBase.ts:107
set strokeColor(stroke): void
Parameters
- stroke: Color
Returns void
Inherited from ColoredShapeBase.strokeColor
- Defined in ColoredShapeBase.ts:110

strokeOpacity

get strokeOpacity(): number
Returns number
Inherited from ColoredShapeBase.strokeOpacity
- Defined in ColoredShapeBase.ts:114
set strokeOpacity(strokeOpacity): void
Parameters
- strokeOpacity: number
Returns void
Inherited from ColoredShapeBase.strokeOpacity
- Defined in ColoredShapeBase.ts:117

strokeWidth

get strokeWidth(): number
Returns number
Inherited from ColoredShapeBase.strokeWidth
- Defined in ColoredShapeBase.ts:120
set strokeWidth(strokeWidth): void
Parameters
- strokeWidth: number
Returns void
Inherited from ColoredShapeBase.strokeWidth
- Defined in ColoredShapeBase.ts:123

sx

get sx(): number
Returns number
Inherited from ColoredShapeBase.sx
- Defined in ShapeBase.ts:302
set sx(sx): void
Parameters
- sx: number
Returns void
Inherited from ColoredShapeBase.sx
- Defined in ShapeBase.ts:305

sy

get sy(): number
Returns number
Inherited from ColoredShapeBase.sy
- Defined in ShapeBase.ts:308
set sy(sy): void
Parameters
- sy: number
Returns void
Inherited from ColoredShapeBase.sy
- Defined in ShapeBase.ts:311

vectorEffect

get vectorEffect():
    | "none"
    | "non-scaling-stroke"
    | "non-scaling-size"
    | "non-rotation"
    | "fixed-position"
Returns
    | "none"
    | "non-scaling-stroke"
    | "non-scaling-size"
    | "non-rotation"
    | "fixed-position"
Inherited from ColoredShapeBase.vectorEffect
- Defined in ColoredShapeBase.ts:132
set vectorEffect(vectorEffect): void
Parameters
- vectorEffect:
      | "none"
      | "non-scaling-stroke"
      | "non-scaling-size"
      | "non-rotation"
      | "fixed-position"
Returns void
Inherited from ColoredShapeBase.vectorEffect
- Defined in ColoredShapeBase.ts:135

visibility

get visibility(): "visible" | "hidden" | "collapse"
Returns "visible" | "hidden" | "collapse"
Inherited from ColoredShapeBase.visibility
- Defined in ShapeBase.ts:352
set visibility(visible): void
Parameters
- visible: "visible" | "hidden" | "collapse"
Returns void
Inherited from ColoredShapeBase.visibility
- Defined in ShapeBase.ts:355

worldMatrix

get worldMatrix(): Matrix
Returns Matrix
Inherited from ColoredShapeBase.worldMatrix
- Defined in ShapeBase.ts:374
set worldMatrix(worldMatrix): void
Parameters
- worldMatrix: Matrix
Returns void
Inherited from ColoredShapeBase.worldMatrix
- Defined in ShapeBase.ts:379

X

get X(): G20
Returns G20
Inherited from ColoredShapeBase.X
- Defined in ShapeBase.ts:254
set X(X): void
Parameters
- X: G20 | [x: number, y: number] | {
  x: number;
  y: number;
  }
Returns void
Inherited from ColoredShapeBase.X
- Defined in ShapeBase.ts:257

Methods

collapse

collapse(): this
Returns this
Inherited from ColoredShapeBase.collapse
- Defined in ShapeBase.ts:370

dispose

dispose(): void
Returns void
Inherited from ColoredShapeBase.dispose
- Defined in ShapeBase.ts:158

flagReset

flagReset(dirtyFlag?): Text
Parameters
- dirtyFlag: boolean = false
Returns Text
- Defined in Text.ts:465

getBoundingBox

getBoundingBox(shallow?): {
    bottom: number;
    left: number;
    right: number;
    top: number;
}
Parameters
- shallow: boolean = false
Returns {
    bottom: number;
    left: number;
    right: number;
    top: number;
}
- bottom: number
- left: number
- right: number
- top: number
Overrides ColoredShapeBase.getBoundingBox
- Defined in Text.ts:397

hasBoundingBox

hasBoundingBox(): boolean
Returns boolean
Overrides ColoredShapeBase.hasBoundingBox
- Defined in Text.ts:456

hide

hide(): this
Returns this
Inherited from ColoredShapeBase.hide
- Defined in ShapeBase.ts:366

noFill

noFill(): this
A convenience method for setting the fill attribute to "none".

Returns this
Inherited from ColoredShapeBase.noFill
- Defined in ColoredShapeBase.ts:141

noStroke

noStroke(): this
A convenience method for setting the stroke attribute to "none".

Returns this
Inherited from ColoredShapeBase.noStroke
- Defined in ColoredShapeBase.ts:149

render

render<T>(viewDOM, parentElement, svgElement): void
Type Parameters
- T
Parameters
- viewDOM: ViewDOM<T>
- parentElement: T
- svgElement: T
Returns void
Overrides ColoredShapeBase.render
- Defined in Text.ts:127

show

show(): this
Returns this
Inherited from ColoredShapeBase.show
- Defined in ShapeBase.ts:362

subdivide

subdivide(limit): this
Parameters
- limit: number
Returns this
- Defined in Text.ts:461

update

update(): this
Returns this
Inherited from ColoredShapeBase.update
- Defined in ShapeBase.ts:245

viewee

viewee(): unknown
Returns unknown
Inherited from ColoredShapeBase.viewee
- Defined in ShapeBase.ts:250

`Static`Measure

Measure(text): {
height: number;
width: number;
}
Parameters
- text: Text
Returns {
height: number;
width: number;
}
- height: number
- width: number
- Defined in Text.ts:390

Class Text

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Text

Properties

beginning

Readonlyboard

ending

length

parent

Readonlyzzz

Accessors

anchor

Returns "middle" | "start" | "end"

Parameters

Returns void

baseline

Returns | "auto" | "text-bottom" | "alphabetic" | "ideographic" | "middle" | "central" | "mathematical" | "hanging" | "text-top"

Parameters

Returns void

content

Returns string

Parameters

Returns void

dashes

Returns number[]

See

Parameters

Returns void

decoration

Returns TextDecoration[]

Parameters

Returns void

direction

Returns "ltr" | "rtl"

Parameters

Returns void

dx

Returns string | number

Parameters

Returns void

dy

Returns string | number

Parameters

Returns void

fillColor

Returns Color

Parameters

Returns void

fillOpacity

Returns number

Parameters

Returns void

fontFamily

Returns string

Parameters

Returns void

fontSize

Returns number

Parameters

Returns void

fontStyle

Returns "normal" | "italic" | "oblique"

Parameters

Returns void

fontWeight

Returns | number | "normal" | "bold" | "bolder" | "lighter"

Parameters

Returns void

id

Returns string

Parameters

Returns void

`Readonly`board

`Readonly`zzz

Returns
| "auto"
| "text-bottom"
| "alphabetic"
| "ideographic"
| "middle"
| "central"
| "mathematical"
| "hanging"
| "text-top"

Returns
| number
| "normal"
| "bold"
| "bolder"
| "lighter"

Returns
| "none"
| "non-scaling-stroke"
| "non-scaling-size"
| "non-rotation"
| "fixed-position"