Class Text

Hierarchy

  • ColoredShapeBase
    • Text

Constructors

constructor

Properties

beginning board ending length parent zzz

Accessors

anchor baseline content dashes decoration direction dx dy fillColor fillOpacity fontFamily fontSize fontStyle fontWeight id mask matrix opacity plumb R scale skewX skewY strokeColor strokeOpacity strokeWidth sx sy vectorEffect visibility worldMatrix X

Methods

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

Constructors

constructor

  • new Text(owner, content, options?): Text

  • Parameters

    Returns Text

Properties

beginning

beginning: number

Readonlyboard

board: Board

ending

ending: number

length

length: number

parent

parent: unknown

Readonlyzzz

zzz: ZZZ

Accessors

anchor

  • get anchor(): "start" | "middle" | "end"

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

  • set anchor(anchor): void

  • Parameters

    • anchor: "start" | "middle" | "end"

    Returns void

baseline

  • get baseline():
        | "middle"
        | "auto"
        | "text-bottom"
        | "alphabetic"
        | "ideographic"
        | "central"
        | "mathematical"
        | "hanging"
        | "text-top"

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

  • set baseline(baseline): void

  • Parameters

    • baseline:
          | "middle"
          | "auto"
          | "text-bottom"
          | "alphabetic"
          | "ideographic"
          | "central"
          | "mathematical"
          | "hanging"
          | "text-top"

    Returns void

content

  • get content(): string

  • Returns string

  • set content(value): void

  • Parameters

    • value: string

    Returns void

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.

  • set dashes(dashes): void

  • Parameters

    • dashes: number[]

    Returns void

decoration

direction

  • get direction(): "ltr" | "rtl"

  • Returns "ltr" | "rtl"

  • set direction(direction): void

  • Parameters

    • direction: "ltr" | "rtl"

    Returns void

dx

  • get dx(): string | number

  • Returns string | number

  • set dx(dx): void

  • Parameters

    • dx: string | number

    Returns void

dy

  • get dy(): string | number

  • Returns string | number

  • set dy(dy): void

  • Parameters

    • dy: string | number

    Returns void

fillColor

  • get fillColor(): Color

  • Returns Color

  • set fillColor(fill): void

  • Parameters

    Returns void

fillOpacity

  • get fillOpacity(): number

  • Returns number

  • set fillOpacity(fillOpacity): void

  • Parameters

    • fillOpacity: number

    Returns void

fontFamily

  • get fontFamily(): string

  • Returns string

  • set fontFamily(family): void

  • Parameters

    • family: string

    Returns void

fontSize

  • get fontSize(): number

  • Returns number

  • set fontSize(size): void

  • Parameters

    • size: number

    Returns void

fontStyle

  • get fontStyle(): "normal" | "italic" | "oblique"

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

  • set fontStyle(fontStyle): void

  • Parameters

    • fontStyle: "normal" | "italic" | "oblique"

    Returns void

fontWeight

  • get fontWeight():
        | number
        | "normal"
        | "bold"
        | "bolder"
        | "lighter"

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

  • set fontWeight(fontWeight): void

  • Parameters

    • fontWeight:
          | number
          | "normal"
          | "bold"
          | "bolder"
          | "lighter"

    Returns void

id

  • get id(): string

  • Returns string

  • set id(id): void

  • Parameters

    • id: string

    Returns void

mask

  • get mask(): Shape

  • Returns Shape

  • set mask(mask): void

  • Parameters

    Returns void

matrix

  • get matrix(): Matrix

  • Returns Matrix

opacity

  • get opacity(): number

  • Returns number

  • set opacity(opacity): void

  • Parameters

    • opacity: number

    Returns void

plumb

  • get plumb(): boolean

  • Returns boolean

  • set plumb(plumb): void

  • Parameters

    • plumb: boolean

    Returns void

R

  • get R(): G20

  • Returns G20

  • set R(R): void

  • Parameters

    Returns void

scale

  • get scale(): number

  • Returns number

  • set scale(scale): void

  • Parameters

    • scale: number | [sx: number, sy: number]

    Returns void

skewX

  • get skewX(): number

  • Returns number

  • set skewX(skewX): void

  • Parameters

    • skewX: number

    Returns void

skewY

  • get skewY(): number

  • Returns number

  • set skewY(skewY): void

  • Parameters

    • skewY: number

    Returns void

strokeColor

  • get strokeColor(): Color

  • Returns Color

  • set strokeColor(stroke): void

  • Parameters

    Returns void

strokeOpacity

  • get strokeOpacity(): number

  • Returns number

  • set strokeOpacity(strokeOpacity): void

  • Parameters

    • strokeOpacity: number

    Returns void

strokeWidth

  • get strokeWidth(): number

  • Returns number

  • set strokeWidth(strokeWidth): void

  • Parameters

    • strokeWidth: number

    Returns void

sx

  • get sx(): number

  • Returns number

  • set sx(sx): void

  • Parameters

    • sx: number

    Returns void

sy

  • get sy(): number

  • Returns number

  • set sy(sy): void

  • Parameters

    • sy: number

    Returns void

vectorEffect

  • get vectorEffect():
        | "non-scaling-stroke"
        | "non-scaling-size"
        | "non-rotation"
        | "fixed-position"
        | "none"

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

  • set vectorEffect(vectorEffect): void

  • Parameters

    • vectorEffect:
          | "non-scaling-stroke"
          | "non-scaling-size"
          | "non-rotation"
          | "fixed-position"
          | "none"

    Returns void

visibility

  • get visibility(): "hidden" | "visible" | "collapse"

  • Returns "hidden" | "visible" | "collapse"

  • set visibility(visible): void

  • Parameters

    • visible: "hidden" | "visible" | "collapse"

    Returns void

worldMatrix

  • get worldMatrix(): Matrix

  • Returns Matrix

  • set worldMatrix(worldMatrix): void

  • Parameters

    Returns void

X

  • get X(): G20

  • Returns G20

  • set X(X): void

  • Parameters

    • X: G20 | [x: number, y: number] | {
          x: number;
          y: number;
      }

    Returns void

Methods

collapse

  • collapse(): this

  • Returns this

dispose

  • dispose(): void

  • Returns void

flagReset

  • flagReset(dirtyFlag?): this

  • Parameters

    • OptionaldirtyFlag: boolean

    Returns this

getBoundingBox

  • getBoundingBox(shallow?): {
        bottom: number;
        left: number;
        right: number;
        top: number;
    }

  • Parameters

    • Optionalshallow: boolean

    Returns {
        bottom: number;
        left: number;
        right: number;
        top: number;
    }

    • bottom: number
    • left: number
    • right: number
    • top: number

hasBoundingBox

  • hasBoundingBox(): boolean

  • Returns boolean

hide

  • hide(): this

  • Returns this

noFill

  • noFill(): this

  • A convenience method for setting the fill attribute to "none".

    Returns this

noStroke

  • noStroke(): this

  • A convenience method for setting the stroke attribute to "none".

    Returns this

render

  • render<T>(viewDOM, parentElement, svgElement): void

  • Type Parameters

    • T

    Parameters

    Returns void

show

  • show(): this

  • Returns this

subdivide

  • subdivide(limit): this

  • Parameters

    • limit: number

    Returns this

update

  • update(): this

  • Returns this

viewee

  • viewee(): unknown

  • Returns unknown

StaticMeasure

  • Measure(text): {
        height: number;
        width: number;
    }

  • Parameters

    Returns {
        height: number;
        width: number;
    }

    • height: number
    • width: number

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods