Skip to content

Page

Page

Extends

Constructors

new Page()

new Page(): Page

Returns

Page

Overrides

Shape.constructor

Source

shapes.ts:1021

Properties

children

children: Obj[]

Inherited from

Shape.children

Source

core/obj.ts:14


connectable

connectable: boolean

Connectable flag

Inherited from

Shape.connectable

Source

shapes.ts:198


constraints

constraints: Constraint[]

Shape’s constraints

Inherited from

Shape.constraints

Source

shapes.ts:298


containable

containable: boolean

Containable flag

Inherited from

Shape.containable

Source

shapes.ts:188


containableFilter

containableFilter: string

Containable filter

Inherited from

Shape.containableFilter

Source

shapes.ts:193


description

description: string

Description of the shape

Inherited from

Shape.description

Source

shapes.ts:148


enable

enable: boolean

Enable flag

Inherited from

Shape.enable

Source

shapes.ts:163


fillColor

fillColor: string

Fill color

Inherited from

Shape.fillColor

Source

shapes.ts:243


fillStyle

fillStyle: string

Fill style

Inherited from

Shape.fillStyle

Source

shapes.ts:248


fontColor

fontColor: string

Font color

Inherited from

Shape.fontColor

Source

shapes.ts:253


fontFamily

fontFamily: string

Font family

Inherited from

Shape.fontFamily

Source

shapes.ts:258


fontSize

fontSize: number

Font size

Inherited from

Shape.fontSize

Source

shapes.ts:263


fontStyle

fontStyle: string

Font style

Inherited from

Shape.fontStyle

Source

shapes.ts:268


fontWeight

fontWeight: number

Font weight

Inherited from

Shape.fontWeight

Source

shapes.ts:273


height

height: number

Shape’s height

Inherited from

Shape.height

Source

shapes.ts:218


id

id: string

Inherited from

Shape.id

Source

core/obj.ts:11


left

left: number

Shape’s left position

Inherited from

Shape.left

Source

shapes.ts:203


link: string

Link

Inherited from

Shape.link

Source

shapes.ts:288


movable

movable: MovableEnum

Indicate how this shape can be moved

Inherited from

Shape.movable

Source

shapes.ts:173


name

name: string

Name of the shape

Inherited from

Shape.name

Source

shapes.ts:143


opacity

opacity: number

Opacity

Inherited from

Shape.opacity

Source

shapes.ts:278


pageOrigin

pageOrigin: null | number[]

Page’s scroll transient state

Source

shapes.ts:1014


pageScale

pageScale: number

Page’s zoom transient state

Source

shapes.ts:1019


parent

parent: null | Obj

Inherited from

Shape.parent

Source

core/obj.ts:13


properties

properties: Property[]

Shape’s properties

Inherited from

Shape.properties

Source

shapes.ts:303


proto

proto: boolean

The flag to indicate this shape is a prototype or not

Inherited from

Shape.proto

Source

shapes.ts:153


reference

reference: null | Shape

A reference to shape

Inherited from

Shape.reference

Source

shapes.ts:293


rotatable

rotatable: boolean

Rotatable flag

Inherited from

Shape.rotatable

Source

shapes.ts:183


rotate

rotate: number

Shape’s rotation angle (in degree)

Inherited from

Shape.rotate

Source

shapes.ts:223


roughness

roughness: number

Roughness

Inherited from

Shape.roughness

Source

shapes.ts:283


scripts

scripts: Script[]

Shape’s scripts

Inherited from

Shape.scripts

Source

shapes.ts:308


sizable

sizable: SizableEnum

Indicate how this shape can be resized

Inherited from

Shape.sizable

Source

shapes.ts:178


size

size: PageSize

Source

shapes.ts:1009


strokeColor

strokeColor: string

Stroke color

Inherited from

Shape.strokeColor

Source

shapes.ts:228


strokePattern

strokePattern: number[]

Stroke pattern

Inherited from

Shape.strokePattern

Source

shapes.ts:238


strokeWidth

strokeWidth: number

Stroke width

Inherited from

Shape.strokeWidth

Source

shapes.ts:233


tags

tags: string[]

Tags

Inherited from

Shape.tags

Source

shapes.ts:158


top

top: number

Shape’s top position

Inherited from

Shape.top

Source

shapes.ts:208


type

type: string

Inherited from

Shape.type

Source

core/obj.ts:12


visible

visible: boolean

Visible flag

Inherited from

Shape.visible

Source

shapes.ts:168


width

width: number

Shape’s width

Inherited from

Shape.width

Source

shapes.ts:213

Accessors

bottom

get bottom(): number

Returns

number

Source

shapes.ts:472


get right(): number

Returns

number

Source

shapes.ts:468

Methods

assignStyles()

assignStyles(canvas): void

Assign styles to memoization canvas.

Parameters

canvas: MemoizationCanvas

Returns

void

Inherited from

Shape.assignStyles

Source

shapes.ts:550


canContain()

canContain(shape): boolean

Determine a given shape can be contained in this shape

Parameters

shape: Shape

Returns

boolean

Inherited from

Shape.canContain

Source

shapes.ts:942


computeOpacity()

computeOpacity(): number

Returns

number

Inherited from

Shape.computeOpacity

Source

shapes.ts:540


containsPoint()

containsPoint(canvas, point): boolean

Page do not contain a point

Parameters

canvas: Canvas

point: number[]

Returns

boolean

Overrides

Shape.containsPoint

Source

shapes.ts:1101


draw()

draw(canvas, showDOM): void

Render this shape

Parameters

canvas: Canvas

showDOM: boolean= false

Returns

void

Overrides

Shape.draw

Source

shapes.ts:1059


drawLink(canvas, showDOM): void

Draw link

Parameters

canvas: Canvas

showDOM: boolean= false

Returns

void

Inherited from

Shape.drawLink

Source

shapes.ts:699


finalize()

finalize(canvas): void

Finalize shape

Parameters

canvas: Canvas

Returns

void

Overrides

Shape.finalize

Source

shapes.ts:1043


find()

find(pred): null | Obj

Find an shape in breath-first order

Parameters

pred

Returns

null | Obj

Inherited from

Shape.find

Source

core/obj.ts:106


findAllByQuery()

findAllByQuery(queryString): Shape[]

Find all shapes matched with the query string

Parameters

queryString: string

Returns

Shape[]

Inherited from

Shape.findAllByQuery

Source

shapes.ts:932


findByQuery()

findByQuery(queryString): null | Shape

Find a shape first matched with the query string

Parameters

queryString: any

Returns

null | Shape

Inherited from

Shape.findByQuery

Source

shapes.ts:919


findDepthFirst()

findDepthFirst(pred): null | Obj

Find an shape in depth-first order

Parameters

pred

Returns

null | Obj

Inherited from

Shape.findDepthFirst

Source

core/obj.ts:119


findParent()

findParent(pred): null | Obj

Find a shape along with the parent-chain

Parameters

pred

Returns

null | Obj

Inherited from

Shape.findParent

Source

core/obj.ts:132


fromJSON()

fromJSON(json): void

Import shape from JSON

Parameters

json: any

Returns

void

Overrides

Shape.fromJSON

Source

shapes.ts:1038


geViewRect()

geViewRect(canvas): number[][]

Return the page’s view rect in GCS

Parameters

canvas: Canvas

Returns

number[][]

Source

shapes.ts:1086


getBoundingRect()

getBoundingRect(): number[][]

Returns a bounding box containing all shapes in the doc

Returns

number[][]

Overrides

Shape.getBoundingRect

Source

shapes.ts:1071


getCenter()

getCenter(): number[]

Returns the center point

Returns

number[]

Inherited from

Shape.getCenter

Source

shapes.ts:739


getChildrenBoundingRect()

getChildrenBoundingRect(): number[][]

Return a bounding box embracing children shapes

Returns

number[][]

Inherited from

Shape.getChildrenBoundingRect

Source

shapes.ts:772


getEnclosure()

getEnclosure(): number[][]

Return a enclosure

Returns

number[][]

Inherited from

Shape.getEnclosure

Source

shapes.ts:806


getOutline()

getOutline(): number[][]

Return outline polygon.

Returns

number[][]

Inherited from

Shape.getOutline

Source

shapes.ts:674


getProperty()

getProperty(name): any

Get a property object

Parameters

name: string

Returns

any

Inherited from

Shape.getProperty

Source

shapes.ts:954


getPropertyValue()

getPropertyValue(name): any

Get a property value

Parameters

name: string

Returns

any

Inherited from

Shape.getPropertyValue

Source

shapes.ts:964


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

Shape.getRectInDCS

Source

shapes.ts:785


getScript()

getScript(id): undefined | string

Get a property object

Parameters

id: string

Returns

undefined | string

Inherited from

Shape.getScript

Source

shapes.ts:972


getSeed()

getSeed(): number

Returns

number

Inherited from

Shape.getSeed

Source

shapes.ts:476


getShapeAt()

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

Pick a shape at specific position (x, y)

Parameters

canvas: Canvas

point: number[]

exceptions: Shape[]= []

Returns

null | Shape

Inherited from

Shape.getShapeAt

Source

shapes.ts:509


getViewRect()

getViewRect(canvas): number[][]

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

Parameters

canvas: Canvas

Returns

number[][]

Inherited from

Shape.getViewRect

Source

shapes.ts:759


initialze()

initialze(canvas): void

Initialize shape

Parameters

canvas: Canvas

Returns

void

Inherited from

Shape.initialze

Source

shapes.ts:484


isDescendant()

isDescendant(obj): boolean

Test whether the given shape is a descendant

Parameters

obj: Obj

Returns

boolean

Inherited from

Shape.isDescendant

Source

core/obj.ts:142


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

Shape.localCoordTransform

Source

shapes.ts:586


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

Shape.localCoordTransformRev

Source

shapes.ts:606


localTransform()

localTransform(canvas, recursive): void

Transform local context to parent’s context

Parameters

canvas: Canvas

recursive: boolean= false

Returns

void

Inherited from

Shape.localTransform

Source

shapes.ts:570


match()

match(query): boolean

Returns true if query matches this shape

Parameters

query: object[]

Returns

boolean

Inherited from

Shape.match

Source

shapes.ts:894


overlapRect()

overlapRect(canvas, rect): boolean

Page do not overlap with anything

Parameters

canvas: Canvas

rect: number[][]

Returns

boolean

Overrides

Shape.overlapRect

Source

shapes.ts:1108


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

Shape.parseQueryString

Source

shapes.ts:869


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

Shape.render

Source

shapes.ts:629


renderDefault()

renderDefault(canvas): void

Default render this shape

Parameters

canvas: MemoizationCanvas

Returns

void

Inherited from

Shape.renderDefault

Source

shapes.ts:647


renderOutline()

renderOutline(canvas): void

Render this shape’s outline

Parameters

canvas: MemoizationCanvas

Returns

void

Inherited from

Shape.renderOutline

Source

shapes.ts:652


renderOutlineDefault()

renderOutlineDefault(): number[][]

Render default outline

Returns

number[][]

Inherited from

Shape.renderOutlineDefault

Source

shapes.ts:667


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

Shape.resolveRefs

Source

shapes.ts:457


toJSON()

toJSON(recursive, keepRefs): any

Export shape to JSON

Parameters

recursive: boolean= false

keepRefs: boolean= false

Returns

any

Overrides

Shape.toJSON

Source

shapes.ts:1032


traverse()

traverse(fun, parent): void

Traverse all objects in breath-first order

Parameters

fun

parent: null | Obj= null

Returns

void

Inherited from

Shape.traverse

Source

core/obj.ts:60


traverseDepthFirst()

traverseDepthFirst(fun, parent): void

Traverse all shapes in depth-first order

Parameters

fun

parent: null | Obj= null

Returns

void

Inherited from

Shape.traverseDepthFirst

Source

core/obj.ts:74


traverseDepthFirstSequence()

traverseDepthFirstSequence(): Obj[]

Returns an array of shapes in order of traverse sequence.

Returns

Obj[]

Inherited from

Shape.traverseDepthFirstSequence

Source

core/obj.ts:97


traverseSequence()

traverseSequence(): Obj[]

Returns an array of shapes in order of traverse sequence.

Returns

Obj[]

Inherited from

Shape.traverseSequence

Source

core/obj.ts:88


update()

update(canvas): void

Update all shapes in this page

Parameters

canvas: Canvas

Returns

void

Overrides

Shape.update

Source

shapes.ts:1052


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

Inherited from

Shape.visit

Source

shapes.ts:529