Group

Corner radius [top-left, top-right, bottom-right, bottom-left] (same with CSS). if positive value, it is pixels. if negative value, it is the percentage ratio of the shorter one between the width and the height.

Inherited from

Box.corners

Source

packages/core/src/shapes.ts:1366

description

description: string

Description of the shape

Inherited from

Box.description

Source

packages/core/src/shapes.ts:163

enable

enable: boolean

Enable flag

Inherited from

Box.enable

Source

packages/core/src/shapes.ts:178

fillColor

fillColor: string

Fill color

Inherited from

Box.fillColor

Source

packages/core/src/shapes.ts:263

fillStyle

fillStyle: FillStyleEnum

Fill style

Inherited from

Box.fillStyle

Source

packages/core/src/shapes.ts:268

fontColor

fontColor: string

Font color

Inherited from

Box.fontColor

Source

packages/core/src/shapes.ts:273

fontFamily

fontFamily: string

Font family

Inherited from

Box.fontFamily

Source

packages/core/src/shapes.ts:278

fontStyle

fontStyle: string

Font style

Inherited from

Box.fontStyle

Source

packages/core/src/shapes.ts:288

fontWeight

fontWeight: number

Font weight

Inherited from

Box.fontWeight

Source

packages/core/src/shapes.ts:293

height

height: number

Shape’s height

Inherited from

Box.height

Source

packages/core/src/shapes.ts:238

horzAlign

horzAlign: HorzAlignEnum

Text horizontal alignment

Inherited from

Box.horzAlign

Source

packages/core/src/shapes.ts:1441

id

id: string

Inherited from

Box.id

Source

packages/core/src/core/obj.ts:11

left

left: number

Shape’s left position

Inherited from

Box.left

Source

packages/core/src/shapes.ts:223

lineHeight

lineHeight: number

Text line height

Inherited from

Box.lineHeight

Source

packages/core/src/shapes.ts:1451

link

link: string

Link

Inherited from

Box.link

Source

packages/core/src/shapes.ts:323

movable

movable: MovableEnum

Indicate how this shape can be moved

Inherited from

Box.movable

Source

packages/core/src/shapes.ts:188

movableParentFilter

movableParentFilter: string

Movable parent filter

Inherited from

Box.movableParentFilter

Source

packages/core/src/shapes.ts:213

name

name: string

Name of the shape

Inherited from

Box.name

Source

packages/core/src/shapes.ts:158

opacity

opacity: number

Opacity

Inherited from

Box.opacity

Source

packages/core/src/shapes.ts:298

padding

padding: number[]

Padding spaces [top, right, bottom, left] (same with CSS)

Inherited from

Box.padding

Source

packages/core/src/shapes.ts:1359

paragraphSpacing

paragraphSpacing: number

Text paragraph spacing

Inherited from

Box.paragraphSpacing

Source

packages/core/src/shapes.ts:1456

parent

parent: null | Obj

Inherited from

Box.parent

Source

packages/core/src/core/obj.ts:13

properties

properties: Property[]

Shape’s properties

Inherited from

Box.properties

Source

packages/core/src/shapes.ts:338

proto

proto: boolean

The flag to indicate this shape is a prototype or not

Inherited from

Box.proto

Source

packages/core/src/shapes.ts:168

reference

reference: null | Shape

A reference to shape

Inherited from

Box.reference

Source

packages/core/src/shapes.ts:328

rotatable

rotatable: boolean

Rotatable flag

Inherited from

Box.rotatable

Source

packages/core/src/shapes.ts:198

rotate

rotate: number

Shape’s rotation angle (in degree)

Inherited from

Box.rotate

Source

packages/core/src/shapes.ts:243

roughness

roughness: number

Roughness

Inherited from

Box.roughness

Source

packages/core/src/shapes.ts:303

scripts

scripts: Script[]

Shape’s scripts

Inherited from

Box.scripts

Source

packages/core/src/shapes.ts:343

shadow

shadow: boolean

Shadow

Inherited from

Box.shadow

Source

packages/core/src/shapes.ts:308

shadowColor

shadowColor: string

Shadow color

Inherited from

Box.shadowColor

Source

packages/core/src/shapes.ts:313

shadowOffset

shadowOffset: number[]

Shadow offset

Inherited from

Box.shadowOffset

Source

packages/core/src/shapes.ts:318

sizable

sizable: SizableEnum

Indicate how this shape can be resized

Inherited from

Box.sizable

Source

packages/core/src/shapes.ts:193

strokeColor

strokeColor: string

Stroke color

Inherited from

Box.strokeColor

Source

packages/core/src/shapes.ts:248

strokePattern

strokePattern: number[]

Stroke pattern

Inherited from

Box.strokePattern

Source

packages/core/src/shapes.ts:258

strokeWidth

strokeWidth: number

Stroke width

Inherited from

Box.strokeWidth

Source

packages/core/src/shapes.ts:253

text

text: any

Text could a string or document object

Rich text document content grammar (BNF): doc = (paragraph | bulletList | orderedList)* bulletList = listItem* orderedList = listItem* paragraph = (text | hardBreak)* listItem = paragraph text = hardBreak =

Rich text document content (this.text) look like: { “type”: “doc”, “content”: [ { “type”: “paragraph”, “content”: [ { “type”: “text”, “text”: “asdf asdf” }, { “type”: “text”, “marks”: [{ “type”: “strong” }], “text”: “sadflkj” }, … ] } … ] }

Inherited from

Box.text

Source

packages/core/src/shapes.ts:1431

textEditable

textEditable: boolean

Text editable

Inherited from

Box.textEditable

Source

packages/core/src/shapes.ts:1401

top

top: number

Shape’s top position

Inherited from

Box.top

Source

packages/core/src/shapes.ts:228

type

type: string

Inherited from

Box.type

Source

packages/core/src/core/obj.ts:12

vertAlign

vertAlign: VertAlignEnum

Text vertical alignment

Inherited from

Box.vertAlign

Source

packages/core/src/shapes.ts:1446

visible

visible: boolean

Visible flag

Inherited from

Box.visible

Source

packages/core/src/shapes.ts:183

width

width: number

Shape’s width

Inherited from

Box.width

Source

packages/core/src/shapes.ts:233

wordWrap

wordWrap: boolean

Word wrap

Inherited from

Box.wordWrap

Source

packages/core/src/shapes.ts:1436

Accessors

bottom

get bottom(): number

Returns

number

Source

packages/core/src/shapes.ts:576

innerBottom

get innerBottom(): number

Returns

number

Source

packages/core/src/shapes.ts:1592

innerHeight

get innerHeight(): number

Returns

number

Source

packages/core/src/shapes.ts:1600

innerLeft

get innerLeft(): number

Returns

number

Source

packages/core/src/shapes.ts:1580

innerRight

get innerRight(): number

Returns

number

Source

packages/core/src/shapes.ts:1584

innerTop

get innerTop(): number

Returns

number

Source

packages/core/src/shapes.ts:1588

innerWidth

get innerWidth(): number

Returns

number

Source

packages/core/src/shapes.ts:1596

right

get right(): number

Returns

number

Source

packages/core/src/shapes.ts:572

Methods

assignStyles()

assignStyles(canvas): void

Assign styles to memoization canvas.

Parameters

• canvas: MemoizationCanvas

Returns

void

Inherited from

Box.assignStyles

Source

packages/core/src/shapes.ts:686

canContain()

canContain(shape): boolean

Determine a given shape can be contained in this shape

Parameters

• shape: Shape

Returns

boolean

Inherited from

Box.canContain

Source

packages/core/src/shapes.ts:1144

computeCorners()

computeCorners(): number[]

Returns

number[]

Inherited from

Box.computeCorners

Source

packages/core/src/shapes.ts:1604

computeOpacity()

computeOpacity(): number

Returns

number

Inherited from

Box.computeOpacity

Source

packages/core/src/shapes.ts:676

containsPoint()

containsPoint(canvas, point, regardFillStyle): boolean

Determines whether this shape contains a point in GCS

Parameters

• canvas: Canvas

• point: number[]

• regardFillStyle: boolean= true

Returns

boolean

Inherited from

Box.containsPoint

Source

packages/core/src/shapes.ts:1001

draw()

draw(canvas, showDOM): void

Draw this shape

Render vs Draw

Render: computing geometries how to draw the shape
Draw: actual drawing the computed geometries of the shape on the canvas

Parameters

• canvas: Canvas

• showDOM: boolean= false

Returns

void

Inherited from

Box.draw

Source

packages/core/src/shapes.ts:832

drawLink()

drawLink(canvas, showDOM): void

Draw link

Parameters

• canvas: Canvas

• showDOM: boolean= false

Returns

void

Inherited from

Box.drawLink

Source

packages/core/src/shapes.ts:846

finalize()

finalize(canvas): void

Finalize shape

Parameters

• canvas: Canvas

Returns

void

Inherited from

Box.finalize

Source

packages/core/src/shapes.ts:596

find()

find(pred): null | Obj

Find an shape in breath-first order

Parameters

• pred

Returns

null | Obj

Inherited from

Box.find

Source

packages/core/src/core/obj.ts:363

findAllByQuery()

findAllByQuery(queryString): Shape[]

Find all shapes matched with the query string

Parameters

• queryString: string

Returns

Shape[]

Inherited from

Box.findAllByQuery

Source

packages/core/src/shapes.ts:1134

findByQuery()

findByQuery(queryString): null | Shape

Find a shape first matched with the query string

Parameters

• queryString: any

Returns

null | Shape

Inherited from

Box.findByQuery

Source

packages/core/src/shapes.ts:1121

findDepthFirst()

findDepthFirst(pred): null | Obj

Find an shape in depth-first order

Parameters

• pred

Returns

null | Obj

Inherited from

Box.findDepthFirst

Source

packages/core/src/core/obj.ts:376

findParent()

findParent(pred): null | Obj

Find a shape along with the parent-chain

Parameters

• pred

Returns

null | Obj

Inherited from

Box.findParent

Source

packages/core/src/core/obj.ts:389

fromJSON()

fromJSON(json): void

Import shape from JSON

Parameters

• json: any

Returns

void

Inherited from

Box.fromJSON

Source

packages/core/src/shapes.ts:1537

getAnchorVector()

getAnchorVector(canvas): number[][]

Return the anchor vector based on this.anchorPosition. The anchor vector provides the start point and end point to derive the base angle. The shape will be rotated as the angle of (base angle + anchor angle) at start point.

(shape)
\ <— anchorLength
o --------------------> o | (anchor vector) | | | vector[0] vector[1]

Parameters

• canvas: Canvas

Returns

number[][]

Inherited from

Box.getAnchorVector

Source

packages/core/src/shapes.ts:1953

getBoundingRect()

getBoundingRect(includeAnchorPoints): number[][]

Return a bounding rect.

Parameters

• includeAnchorPoints: boolean= false

Returns

number[][]

Inherited from

Box.getBoundingRect

Source

packages/core/src/shapes.ts:893

getCenter()

getCenter(): number[]

Returns the center point

Returns

number[]

Inherited from

Box.getCenter

Source

packages/core/src/shapes.ts:886

getChildrenBoundingRect()

getChildrenBoundingRect(): number[][]

Return a bounding box embracing children shapes

Returns

number[][]

Inherited from

Box.getChildrenBoundingRect

Source

packages/core/src/shapes.ts:954

getContainerAt()

getContainerAt(canvas, point, exceptions): null | Shape

Pick a container shape at specific position (x, y)

Parameters

• canvas: Canvas

• point: number[]

• exceptions: Shape[]= []

Returns

null | Shape

Inherited from

Box.getContainerAt

Source

packages/core/src/shapes.ts:643

getEnclosure()

getEnclosure(): number[][]

Return a enclosure

Returns

number[][]

Inherited from

Box.getEnclosure

Source

packages/core/src/shapes.ts:988

getOutline()

getOutline(): number[][]

Return outline polygon.

Returns

number[][]

Inherited from

Box.getOutline

Source

packages/core/src/shapes.ts:821

getPage()

getPage(): null | Page

Return the page that contains this shape

Returns

null | Page

Inherited from

Box.getPage

Source

packages/core/src/shapes.ts:568

getProperty()

getProperty(name): any

Get a property object

Parameters

• name: string

Returns

any

Inherited from

Box.getProperty

Source

packages/core/src/shapes.ts:1156

getPropertyValue()

getPropertyValue(name): any

Get a property value

Parameters

• name: string

Returns

any

Inherited from

Box.getPropertyValue

Source

packages/core/src/shapes.ts:1166

getRectInDCS()

getRectInDCS(canvas, includeAnchorPoints): number[][]

Return a bounding box in DOM coord.

[Note] If you want to place DOM elements over the canvas, use this method. and don’t forget to apply transform scale to the DOM element.

Parameters

• canvas: Canvas

• includeAnchorPoints: boolean= false

Returns

number[][]

Inherited from

Box.getRectInDCS

Source

packages/core/src/shapes.ts:967

getScript()

getScript(id): undefined | string

Get a property object

Parameters

• id: string

Returns

undefined | string

Inherited from

Box.getScript

Source

packages/core/src/shapes.ts:1174

getSeed()

getSeed(): number

Return the seed number

Returns

number

Inherited from

Box.getSeed

Source

packages/core/src/shapes.ts:583

getShapeAt()

getShapeAt(canvas, point, exceptions, allowDisabledAndInvisible): null | Shape

Pick a shape at specific position (x, y)

Parameters

• canvas: Canvas

• point: number[]

• exceptions: Shape[]= []

• allowDisabledAndInvisible: boolean= false

Returns

null | Shape

Overrides

Box.getShapeAt

Source

packages/core/src/shapes.ts:2318

getViewport()

getViewport(canvas): number[][]

Return a viewport in GCS. Viewport is a rect that includes actually drawn area which includes stroke width, arrowheads, etc. So viewport is mostly larger than bounding rect.

Parameters

• canvas: Canvas

Returns

number[][]

Inherited from

Box.getViewport

Source

packages/core/src/shapes.ts:944

initialze()

initialze(canvas): void

Initialize shape

Parameters

• canvas: Canvas

Returns

void

Inherited from

Box.initialze

Source

packages/core/src/shapes.ts:591

isDescendant()

isDescendant(obj): boolean

Test whether the given shape is a descendant

Parameters

• obj: Obj

Returns

boolean

Inherited from

Box.isDescendant

Source

packages/core/src/core/obj.ts:399

localCoordTransform()

localCoordTransform(canvas, point, recursive): number[]

Transform local coord to parent’s coord (LCS —> parent’s LCS) if recursive=true, transform to GCS (Global coord-system).

Parameters

• canvas: Canvas

• point: number[]

• recursive: boolean= false

Returns

number[]

Inherited from

Box.localCoordTransform

Source

packages/core/src/shapes.ts:722

localCoordTransformRev()

localCoordTransformRev(canvas, point, recursive): number[]

Transform parent’s coord to local coord (parent’s LCS —> LCS) if recursive=true, transform GCS (Global coord-system) —> LCS.

Parameters

• canvas: Canvas

• point: number[]

• recursive: boolean= false

Returns

number[]

Inherited from

Box.localCoordTransformRev

Source

packages/core/src/shapes.ts:742

localTransform()

localTransform(canvas, recursive): void

Transform local context to parent’s context

Parameters

• canvas: Canvas

• recursive: boolean= false

Returns

void

Inherited from

Box.localTransform

Source

packages/core/src/shapes.ts:706

match()

match(query): boolean

Returns true if query matches this shape

Parameters

• query: object[]

Returns

boolean

Inherited from

Box.match

Source

packages/core/src/shapes.ts:1097

overlapClippingArea()

overlapClippingArea(canvas, rect): boolean

Determines whether the given rect overlaps this shape’s clipping area. Group do not allow to overlap with children shapes.

Parameters

• canvas: Canvas

• rect: number[][]

Returns

boolean

Overrides

Box.overlapClippingArea

Source

packages/core/src/shapes.ts:2334

overlapRect()

overlapRect(canvas, rect): boolean

Determines whether this shape overlaps a given rect

Parameters

• canvas: Canvas

• rect: number[][]

Returns

boolean

Inherited from

Box.overlapRect

Source

packages/core/src/shapes.ts:1035

parseQueryString()

parseQueryString(queryString): any[]

Parse the query-string and returns a query object (JSON)

Query syntax: = [”|” ]* = [”&” ]* = | = e.g.) OuterBox, NameText, … = ”@” e.g.) @Box, @Text, @Line, … = ”#” e.g.) #label, #compartment, …

e.g.) parseQuery(“@Box|NameText|@Text&#compartment”) —> [{_type: “Box”},{name: “NameText”},{_type: “Text”, tag:“compartment”}]

Parameters

• queryString: string

Returns

any[]

query object

Inherited from

Box.parseQueryString

Source

packages/core/src/shapes.ts:1072

preprocess()

preprocess(doc, wordWrap, width, listIndent): void

Preprocess document (handle wordWrap and hardBreak) options: wordWrap: boolean width: number listIndent: number

Preprocessed document content grammar (BNF): doc = (paragraph | bulletList | orderedList)* orderedList [width, height] = listItem* bulletList [width, height] = listItem* listItem [width, height] = paragraph paragraph [width, height] = line* line [width, height] = text* text [width, height] =

Parameters

• doc: any

• wordWrap: boolean

• width: number

• listIndent: number

Returns

void

Inherited from

Box.preprocess

Source

packages/core/src/shapes.ts:1847

readAny()

readAny(json, field, defaultValue): any

Read an any value from the JSON object, return defaultValue if the field is undefined.

Parameters

• json: any

• field: string

• defaultValue: any

Returns

any

Inherited from

Box.readAny

Source

packages/core/src/core/obj.ts:54

readArrayAny()

readArrayAny(json, field, defaultValue): any[]

Read an array of any value from the JSON object, return defaultValue if the field is not an array.

Parameters

• json: any

• field: string

• defaultValue: any[]

Returns

any[]

Inherited from

Box.readArrayAny

Source

packages/core/src/core/obj.ts:65

readArrayBoolean()

readArrayBoolean(json, field, defaultValue, length?): boolean[]

Read an array of boolean from the JSON object, return defaultValue if the field is not an array of boolean.

Parameters

• json: any

• field: string

• defaultValue: boolean[]

• length?: number

Returns

boolean[]

Inherited from

Box.readArrayBoolean

Source

packages/core/src/core/obj.ts:148

readArrayNumber()

readArrayNumber(json, field, defaultValue, length?): number[]

Read a number field from the JSON object, return defaultValue if the field is not a number.

Parameters

• json: any

• field: string

• defaultValue: number[]

• length?: number

Returns

number[]

Inherited from

Box.readArrayNumber

Source

packages/core/src/core/obj.ts:87

readArrayPoint()

readArrayPoint(json, field, defaultValue): [number, number][]

Read a, array of point value from the JSON object, return defaultValue if the field is not an array of point.

Parameters

• json: any

• field: string

• defaultValue: [number, number][]

Returns

[number, number][]

Inherited from

Box.readArrayPoint

Source

packages/core/src/core/obj.ts:256

readArrayString()

readArrayString(json, field, defaultValue): string[]

Read an array of string from the JSON object, return defaultValue if the field is not an array of string.

Parameters

• json: any

• field: string

• defaultValue: string[]

Returns

string[]

Inherited from

Box.readArrayString

Source

packages/core/src/core/obj.ts:123

readBoolean()

readBoolean(json, field, defaultValue): boolean

Read a boolean field from the JSON object, return defaultValue if the field is not a boolean.

Parameters

• json: any

• field: string

• defaultValue: boolean

Returns

boolean

Inherited from

Box.readBoolean

Source

packages/core/src/core/obj.ts:137

readColor()

readColor(json, field, defaultValue): string

Read a color field from the JSON object, return defaultValue if the field is not a string or not a valid color.

Parameters

• json: any

• field: string

• defaultValue: string

Returns

string

Inherited from

Box.readColor

Source

packages/core/src/core/obj.ts:170

readEnum()

readEnum(json, field, enumType, defaultValue): string

Read an enum value from the JSON object, return defaultValue if the field is not a valid enum value.

Parameters

• json: any

• field: string

• enumType: any

• defaultValue: string

Returns

string

Inherited from

Box.readEnum

Source

packages/core/src/core/obj.ts:185

readNumber()

readNumber(json, field, defaultValue): number

Read a number field from the JSON object, return defaultValue if the field is not a number.

Parameters

• json: any

• field: string

• defaultValue: number

Returns

number

Inherited from

Box.readNumber

Source

packages/core/src/core/obj.ts:76

readPoint()

readPoint(json, field, defaultValue): [number, number]

Read a point value from the JSON object, return defaultValue if the field is not a point.

Parameters

• json: any

• field: string

• defaultValue: [number, number]

Returns

[number, number]

Inherited from

Box.readPoint

Source

packages/core/src/core/obj.ts:213

readPointOrNull()

readPointOrNull(json, field, defaultValue): null | [number, number]

Read a point or null value from the JSON object, return defaultValue if the field is not a point or null.

Parameters

• json: any

• field: string

• defaultValue: null | [number, number]

Returns

null | [number, number]

Inherited from

Box.readPointOrNull

Source

packages/core/src/core/obj.ts:233

readRef()

readRef(json, field): null | string

Read a reference to object from the JSON object, return defaultValue if the field is not string (obj’s id) or null.

Parameters

• json: any

• field: string

Returns

null | string

Inherited from

Box.readRef

Source

packages/core/src/core/obj.ts:202

readString()

readString(json, field, defaultValue): string

Read a string field from the JSON object, return defaultValue if the field is not a string.

Parameters

• json: any

• field: string

• defaultValue: string

Returns

string

Inherited from

Box.readString

Source

packages/core/src/core/obj.ts:112

render()

render(canvas): void

Render this shape

Render vs Draw

Render: computing geometries how to draw the shape
Draw: actual drawing the computed geometries of the shape on the canvas

Parameters

• canvas: MemoizationCanvas

Returns

void

Inherited from

Box.render

Source

packages/core/src/shapes.ts:765

renderBorders()

renderBorders(canvas, x1, y1, x2, y2): void

Parameters

• canvas: MemoizationCanvas

• x1: number

• y1: number

• x2: number

• y2: number

Returns

void

Inherited from

Box.renderBorders

Source

packages/core/src/shapes.ts:1617

renderDefault()

renderDefault(canvas): void

Default render this shape

Parameters

• canvas: MemoizationCanvas

Returns

void

Overrides

Box.renderDefault

Source

packages/core/src/shapes.ts:2350

renderOutline()

renderOutline(canvas): void

Render this shape’s outline

Parameters

• canvas: MemoizationCanvas

Returns

void

Inherited from

Box.renderOutline

Source

packages/core/src/shapes.ts:790

renderOutlineDefault()

renderOutlineDefault(canvas): number[][]

Return outline polygon

Parameters

• canvas: MemoizationCanvas

Returns

number[][]

Inherited from

Box.renderOutlineDefault

Source

packages/core/src/shapes.ts:1928

renderShadow()

renderShadow(canvas): void

Render shadow

Parameters

• canvas: MemoizationCanvas

Returns

void

Overrides

Box.renderShadow

Source

packages/core/src/shapes.ts:2352

renderText()

renderText(canvas): void

Render text

Parameters

• canvas: MemoizationCanvas

Returns

void

Inherited from

Box.renderText

Source

packages/core/src/shapes.ts:1801

renderViewport()

renderViewport(canvas): void

Return this shape’s viewport

Parameters

• canvas: MemoizationCanvas

Returns

void

Inherited from

Box.renderViewport

Source

packages/core/src/shapes.ts:903

renderViewportDefault()

renderViewportDefault(canvas): number[][]

Render default viewport

Parameters

• canvas: MemoizationCanvas

Returns

number[][]

Inherited from

Box.renderViewportDefault

Source

packages/core/src/shapes.ts:922

resolveRefs()

resolveRefs(idMap, nullIfNotFound): void

Resolve references

Parameters

• idMap: Record<string, Shape>

id to object map

• nullIfNotFound: boolean= false

assign null if not found

Returns

void

Inherited from

Box.resolveRefs

Source

packages/core/src/shapes.ts:554

setJson()

setJson(json, field, value, defaultValue, enforce): void

Set a field in the JSON object only if the value is defined and not equal to the default value.

Parameters

• json: any

The JSON object to set the field in.

• field: string

The field name to set.

• value: any

The value to set.

• defaultValue: any

The default value to compare against.

• enforce: boolean= false

If true, the field will be set even if it is equal to the default value.

Returns

void

Inherited from

Box.setJson

Source

packages/core/src/core/obj.ts:31

toJSON()

toJSON(recursive, keepRefs, enforce): any

Export shape to JSON

Parameters

• recursive: boolean= false

• keepRefs: boolean= false

• enforce: boolean= false

Returns

any

Inherited from

Box.toJSON

Source

packages/core/src/shapes.ts:1489

traverse()

traverse(fun, parent): void

Traverse all objects in breath-first order

Parameters

• fun

• parent: null | Obj= null

Returns

void

Inherited from

Box.traverse

Source

packages/core/src/core/obj.ts:317

traverseDepthFirst()

traverseDepthFirst(fun, parent): void

Traverse all shapes in depth-first order

Parameters

• fun

• parent: null | Obj= null

Returns

void

Inherited from

Box.traverseDepthFirst

Source

packages/core/src/core/obj.ts:331

traverseDepthFirstSequence()

traverseDepthFirstSequence(): Obj[]

Returns an array of shapes in order of traverse sequence.

Returns

Obj[]

Inherited from

Box.traverseDepthFirstSequence

Source

packages/core/src/core/obj.ts:354

traverseSequence()

traverseSequence(): Obj[]

Returns an array of shapes in order of traverse sequence.

Returns

Obj[]

Inherited from

Box.traverseSequence

Source

packages/core/src/core/obj.ts:345

update()

update(canvas): void

Update shape

Parameters

• canvas: Canvas

Returns

void

Inherited from

Box.update

Source

packages/core/src/shapes.ts:606

visit()

visit(fun, parent): void

Visit all shapes in breath-first order. The difference from traverse() is that each shape determine visit into children or not. (e.g. Group and Frame doens’t visit into children)

Parameters

• fun

• parent: null | Shape= null

Returns

void

Overrides

Box.visit

Source

packages/core/src/shapes.ts:2343

wordWrapTextSize()

wordWrapTextSize(canvas, wordWrap, width): number[]

Compute size of text with word-wrap and new line chars

Parameters

• canvas: Canvas

• wordWrap: boolean

• width: number

Returns

number[]

Inherited from

Box.wordWrapTextSize

Source

packages/core/src/shapes.ts:1852

Group

Extends

Constructors

new Group()

Returns

Overrides

Source

Properties

anchorAngle

Inherited from

Source

anchorLength

Inherited from

Source

anchorPosition

Inherited from

Source

anchored

Inherited from

Source

borderPosition

Inherited from

Source

borders

Inherited from

Source

children

Inherited from

Source

connectable

Inherited from

Source

constraints

Inherited from

Source

containable

Inherited from

Source

containableFilter

Inherited from

Source

corners

Inherited from

Source

description

Inherited from

Source

enable

Inherited from

Source

fillColor

Inherited from

Source

fillStyle

Inherited from

Source

fontColor

Inherited from

Source

fontFamily

Inherited from

Source

fontSize

Inherited from

Source

fontStyle

Inherited from

Source

fontWeight

Inherited from

Source

height

Inherited from

Source

horzAlign

Inherited from

Source

id

Inherited from

Source