Line

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

Path.getViewport

Source

shapes.ts:860

initialze()

initialze(canvas): void

Initialize shape

Parameters

• canvas: Canvas

Returns

void

Inherited from

Path.initialze

Source

shapes.ts:533

isClosed()

isClosed(): boolean

Return is the path is closed

Returns

boolean

Inherited from

Path.isClosed

Source

shapes.ts:1665

isDescendant()

isDescendant(obj): boolean

Test whether the given shape is a descendant

Parameters

• obj: Obj

Returns

boolean

Inherited from

Path.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

Path.localCoordTransform

Source

shapes.ts:644

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

Path.localCoordTransformRev

Source

shapes.ts:664

localTransform()

localTransform(canvas, recursive): void

Transform local context to parent’s context

Parameters

• canvas: Canvas

• recursive: boolean= false

Returns

void

Inherited from

Path.localTransform

Source

shapes.ts:628

match()

match(query): boolean

Returns true if query matches this shape

Parameters

• query: object[]

Returns

boolean

Inherited from

Path.match

Source

shapes.ts:1009

overlapClippingArea()

overlapClippingArea(canvas, rect): boolean

Determines whether the given rect overlaps this shape’s clipping area. If the shape don’t have clipping area, return true. If the shape has clipping area, return true if the rect overlaps the clipping area. (e.g. Frame)

Parameters

• canvas: Canvas

• rect: number[][]

Returns

boolean

Inherited from

Path.overlapClippingArea

Source

shapes.ts:940

overlapRect()

overlapRect(canvas, rect): boolean

Determines whether this shape overlaps a given rect

Parameters

• canvas: Canvas

• rect: number[][]

Returns

boolean

Inherited from

Path.overlapRect

Source

shapes.ts:1706

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

Path.parseQueryString

Source

shapes.ts:984

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

Path.render

Source

shapes.ts:687

renderDefault()

renderDefault(canvas): void

Draw this shape

Parameters

• canvas: MemoizationCanvas

Returns

void

Overrides

Path.renderDefault

Source

shapes.ts:2086

renderLineEnd()

renderLineEnd(canvas, edgeEndType, isHead): number[]

Draw line end types. All line-ends are drawn based on the point grid as below:

    0 1 2 3 4 5 6 7 8 9 10

0 • • • • • • • • • • • 1 • • • • • • • • • • • 2 • • • • • • • • • • • 3 HEAD •-•-•-•-•-•-•-•-•-•-•---------- TAIL 4 • • • • • • • • • • • 5 • • • • • • • • • • • 6 • • • • • • • • • • •

Parameters

• canvas: MemoizationCanvas

• edgeEndType: string

• isHead: boolean

Returns

number[]

an end point the path should be drawn to

Source

shapes.ts:2132

renderOutline()

renderOutline(canvas): void

Render this shape’s outline

Parameters

• canvas: MemoizationCanvas

Returns

void

Inherited from

Path.renderOutline

Source

shapes.ts:712

renderOutlineDefault()

renderOutlineDefault(canvas): number[][]

Return default outline

Parameters

• canvas: MemoizationCanvas

Returns

number[][]

Overrides

Path.renderOutlineDefault

Source

shapes.ts:2313

renderShadow()

renderShadow(canvas): void

Render shadow

Parameters

• canvas: MemoizationCanvas

Returns

void

Overrides

Path.renderShadow

Source

shapes.ts:2340

renderViewport()

renderViewport(canvas): void

Return this shape’s viewport

Parameters

• canvas: MemoizationCanvas

Returns

void

Inherited from

Path.renderViewport

Source

shapes.ts:822

renderViewportDefault()

renderViewportDefault(canvas): number[][]

Render default viewport

Parameters

• canvas: MemoizationCanvas

Returns

number[][]

Overrides

Path.renderViewportDefault

Source

shapes.ts:2326

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

Path.resolveRefs

Source

shapes.ts:496

toJSON()

toJSON(recursive, keepRefs): any

Export shape to JSON

Parameters

• recursive: boolean= false

• keepRefs: boolean= false

Returns

any

Overrides

Path.toJSON

Source

shapes.ts:2068

traverse()

traverse(fun, parent): void

Traverse all objects in breath-first order

Parameters

• fun

• parent: null | Obj= null

Returns

void

Inherited from

Path.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

Path.traverseDepthFirst

Source

core/obj.ts:74

traverseDepthFirstSequence()

traverseDepthFirstSequence(): Obj[]

Returns an array of shapes in order of traverse sequence.

Returns

Obj[]

Inherited from

Path.traverseDepthFirstSequence

Source

core/obj.ts:97

traverseSequence()

traverseSequence(): Obj[]

Returns an array of shapes in order of traverse sequence.

Returns

Obj[]

Inherited from

Path.traverseSequence

Source

core/obj.ts:88

update()

update(canvas): void

Update shape

Parameters

• canvas: Canvas

Returns

void

Inherited from

Path.update

Source

shapes.ts:548

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

Path.visit

Source

shapes.ts:587

Line

Extends

Constructors

new Line()

Returns

Overrides

Source

Properties

children

Inherited from

Source

connectable

Inherited from

Source

constraints

Inherited from

Source

containable

Inherited from

Source

containableFilter

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

headEndType

Source

height

Inherited from

Source

id

Inherited from

Source

left

Inherited from

Source

lineType

Source

link

Inherited from

Source

movable

Inherited from

Source

name

Inherited from

Source

opacity

Inherited from

Source

parent

Inherited from

Source

path

Inherited from