Class Group

Hierarchy (view full)

Constructors

constructor

Properties

board parent zzz

Accessors

children id mask matrix opacity plumb R scale skewX skewY sx sy visibility worldMatrix X

Methods

add center collapse dispose flagReset getBoundingBox getById getByType hasBoundingBox hide remove render show update viewee

Constructors

constructor

Properties

Readonlyboard

board: Board

parent

parent: unknown

Readonlyzzz

zzz: ZZZ

Accessors

children

  • get children(): Shape[]

  • A list of all the children in the scenegraph.

    Returns Shape[]

  • set children(children): void

  • Parameters

    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

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

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

add

  • add(...shapes): this

  • Parameters

    Returns this

center

  • center(): this

  • Orient the children of the group to the center of that group.

    Returns this

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

getById

  • getById(id): Shape

  • Parameters

    • id: string

    Returns Shape

getByType

  • getByType(type): Shape[]

  • Parameters

    • type: any

    Returns Shape[]

hasBoundingBox

hide

  • hide(): this

  • Returns this

remove

  • remove(...shapes): this

  • Parameters

    Returns this

render

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

  • Type Parameters

    • T

    Parameters

    Returns void

show

  • show(): this

  • Returns this

update

  • update(): this

  • Returns this

viewee

  • viewee(): unknown

  • Returns unknown

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods