Class Diagram

Diagram Class

Diagram is a tree structure Diagram can be a polygon, curve, text, image, or diagram Polygon is a closed path Curve is an open path Diagram is a tree of Diagrams

Index

Constructors

constructor

Properties

children foreignobjdata imgdata multilinedata mutable origin path style tags textdata type

Constructors

constructor

new Diagram(
    type_: DiagramType,
    args?: {
        children?: Diagram[];
        foreignobjdata?: Partial<ForeignObjectData>;
        imgdata?: Partial<ImageData>;
        multilinedata?: Partial<MultilineTextData>;
        path?: Path;
        tags?: string[];
        textdata?: Partial<TextData>;
    },
): Diagram
Parameters
- type_: DiagramType
- args: {
      children?: Diagram[];
      foreignobjdata?: Partial<ForeignObjectData>;
      imgdata?: Partial<ImageData>;
      multilinedata?: Partial<MultilineTextData>;
      path?: Path;
      tags?: string[];
      textdata?: Partial<TextData>;
  } = {}
Returns Diagram
- Defined in diagram.ts:136

Properties

children

children: Diagram[] = []

foreignobjdata

foreignobjdata: Partial<ForeignObjectData> = {}

imgdata

imgdata: Partial<ImageData> = {}

multilinedata

multilinedata: Partial<MultilineTextData> = {}

mutable

mutable: boolean = false

origin

origin: Vector2 = ...

path

path: undefined | Path = undefined

style

style: Partial<DiagramStyle> = {}

textdata

textdata: Partial<TextData> = {}

type

type: DiagramType

Methods

add_points

add_points(points: Vector2[]): Diagram
Add points to the diagram if the diagram is a polygon or curve, add points to the path if the diagram is a diagram, add points to the last polygon or curve child
Parameters
- points: Vector2[]
  points to add
Returns Diagram
- Defined in diagram.ts:403

append_tags

append_tags(tags: string | string[]): Diagram
Append tags to the diagram
Parameters
- tags: string | string[]
Returns Diagram
- Defined in diagram.ts:230

apply

apply(func: (d: Diagram) => Diagram): Diagram
Apply a function to the diagram
Parameters
- func: (d: Diagram) => Diagram
  function to apply func takes in a diagram and returns a diagram
Returns Diagram
- Defined in diagram.ts:299

apply_recursive

apply_recursive(func: (d: Diagram) => Diagram): Diagram
Apply a function to the diagram and all of its children recursively
Parameters
- func: (d: Diagram) => Diagram
  function to apply func takes in a diagram and returns a diagram
Returns Diagram
- Defined in diagram.ts:308

apply_to_tagged_recursive

apply_to_tagged_recursive(
tags: string | string[],
func: (d: Diagram) => Diagram,
): Diagram
Apply a function to the diagram and all of its children recursively The function is only applied to the diagrams that contain a specific tag
Parameters
- tags: string | string[]
  the tag to filter the diagrams
- func: (d: Diagram) => Diagram
  function to apply func takes in a diagram and returns a diagram
Returns Diagram
- Defined in diagram.ts:326

bounding_box

bounding_box(): [Vector2, Vector2]
Get the bounding box of the diagram

Returns [Vector2, Vector2]
[min, max] where min is the top left corner and max is the bottom right corner
- Defined in diagram.ts:551

clone_style_from

clone_style_from(diagram: Diagram): Diagram
Parameters
- diagram: Diagram
Returns Diagram
- Defined in diagram.ts:436

combine

combine(...diagrams: Diagram[]): Diagram
Combine another diagram with this diagram
Parameters
- ...diagrams: Diagram[]
  a diagram or a list of diagrams
Returns Diagram
- Defined in diagram.ts:359

contain_all_tags

contain_all_tags(tags: string[]): boolean
Parameters
- tags: string[]
Returns boolean
- Defined in diagram.ts:260

contain_tag

contain_tag(tag: string): boolean
Check if the diagram contains a tag
Parameters
- tag: string
Returns boolean
- Defined in diagram.ts:257

copy

copy(): Diagram
Copy the diagram

Returns Diagram
- Defined in diagram.ts:215

copy_if_not_mutable

copy_if_not_mutable(): Diagram
Returns Diagram
- Defined in diagram.ts:223

debug

debug(show_index?: boolean): Diagram
Parameters
- show_index: boolean = true
Returns Diagram
- Defined in diagram.ts:936

debug_bbox

debug_bbox(): Diagram
Returns Diagram
- Defined in diagram.ts:919

fill

fill(color: string): Diagram
Parameters
- color: string
Returns Diagram
- Defined in diagram.ts:443

filter

filter(filter: string): Diagram
Parameters
- filter: string
Returns Diagram
- Defined in diagram.ts:468

flatten

flatten(): Diagram
Flatten the children structure of the diagram so that the diagram only has one level of children * implemented for performance reason

Returns Diagram
- Defined in diagram.ts:288

fontfamily

fontfamily(fontfamily: string): Diagram
Parameters
- fontfamily: string
Returns Diagram
- Defined in diagram.ts:498

fontscale

fontscale(fontscale: number | "auto"): Diagram
Parameters
- fontscale: number | "auto"
Returns Diagram
- Defined in diagram.ts:510

fontstyle

fontstyle(fontstyle: string): Diagram
Parameters
- fontstyle: string
Returns Diagram
- Defined in diagram.ts:501

fontweight

fontweight(
fontweight: number | "bold" | "normal" | "bolder" | "lighter",
): Diagram
Parameters
- fontweight: number | "bold" | "normal" | "bolder" | "lighter"
Returns Diagram
- Defined in diagram.ts:507

get_anchor

get_anchor(anchor: Anchor): Vector2
Get the position of the anchor of the diagram
Parameters
- anchor: Anchor
  anchor to get, anchors can be 'top-left', 'top-center', 'top-right' 'center-left', 'center-center', 'center-right' 'bottom-left', 'bottom-center', 'bottom-right'
Returns Vector2
the position of the anchor
- Defined in diagram.ts:765

get_tagged_elements

get_tagged_elements(tags: string | string[]): Diagram[]
Get all the diagrams that contain a specific tag
Parameters
- tags: string | string[]
  the tag to filter the diagrams
Returns Diagram[]
a list of diagrams
- Defined in diagram.ts:344

hflip

hflip(a?: number): Diagram
Horizontal flip Reflect the diagram over a vertical line x = a
Parameters
- Optionala: number
  x value of the line if left undefined, flip over the origin
Returns Diagram
- Defined in diagram.ts:751

immut

immut(): Diagram
Create a copy of the diagram that is immutable

Returns Diagram
- Defined in diagram.ts:179

is_empty

is_empty(): boolean
Returns boolean
- Defined in diagram.ts:991

move_origin

move_origin(pos: Vector2 | Anchor): Diagram
Move the origin of the diagram to a position or anchor
Parameters
- pos: Vector2 | Anchor
  position to move the origin to (Vector2), or anchor to move the origin to. anchors can be 'top-left', 'top-center', 'top-right' 'center-left', 'center-center', 'center-right' 'bottom-left', 'bottom-center', 'bottom-right'
  
  for texts, use move_origin_text()
Returns Diagram
- Defined in diagram.ts:797

move_origin_text

move_origin_text(anchor: Anchor): Diagram
Move the origin of text diagram to a position
Parameters
- anchor: Anchor
  anchor to move the origin to. anchors can be 'top-left', 'top-center', 'top-right' 'center-left', 'center-center', 'center-right' 'bottom-left', 'bottom-center', 'bottom-right'
Returns Diagram
- Defined in diagram.ts:833

mut

mut(): Diagram
Turn the diagram into a mutable diagram

Returns Diagram
- Defined in diagram.ts:160

mut_parent_only

mut_parent_only(): Diagram
Returns Diagram
- Defined in diagram.ts:169

opacity

opacity(opacity: number): Diagram
Parameters
- opacity: number
Returns Diagram
- Defined in diagram.ts:449

parametric_point

parametric_point(t: number, segment_index?: number): Vector2
Get the point on the path at t Path can be described parametrically in the form of (x(t), y(t)) Path starts at t=0 and ends at t=1
Parameters
- t: number
  parameter
- Optionalsegment_index: number
  (only works for polygon and curves) If segment_index (n) is defined, get the point at the nth segment If segment_index (n) is defined, t can be outside of [0, 1] and will return the extrapolated point
Returns Vector2
the position of the point
- Defined in diagram.ts:883

path_length

path_length(): number
Returns number
- Defined in diagram.ts:847

position

position(v?: Vector2): Diagram
move the diagram to a position
Parameters
- v: Vector2 = ...
  position to move to (if left undefined, move to the origin)
Returns Diagram
- Defined in diagram.ts:628

reflect

reflect(p1?: Vector2, p2?: Vector2): Diagram
Reflect the diagram if given 0 arguments, reflect over the origin if given 1 argument, reflect over a point p1 if given 2 arguments, reflect over a line defined by two points p1 and p2
Parameters
- Optionalp1: Vector2
  point
- Optionalp2: Vector2
  point
Returns Diagram
- Defined in diagram.ts:722

reflect_over_line

reflect_over_line(p1: Vector2, p2: Vector2): Diagram
Reflect the diagram over a line defined by two points
Parameters
- p1: Vector2
  point on the line
- p2: Vector2
  point on the line
Returns Diagram
- Defined in diagram.ts:710

reflect_over_point

reflect_over_point(p: Vector2): Diagram
Reflect the diagram over a point
Parameters
- p: Vector2
  point to reflect over
Returns Diagram
- Defined in diagram.ts:701

remove_tags

remove_tags(tags: string | string[]): Diagram
Remove tags from the diagram
Parameters
- tags: string | string[]
Returns Diagram
- Defined in diagram.ts:241

reset_tags

reset_tags(): Diagram
Reset all tags of the diagram

Returns Diagram
- Defined in diagram.ts:249

reverse_path

reverse_path(): Diagram
Reverse the order of the points in the path

Returns Diagram
- Defined in diagram.ts:865

rotate

rotate(angle: number, pivot?: undefined | Vector2): Diagram
Rotate the diagram by an angle around a pivot
Parameters
- angle: number
  angle to rotate
- pivot: undefined | Vector2 = undefined
  pivot point, if left undefined, rotate around the origin
Returns Diagram
- Defined in diagram.ts:638

scale

scale(scale: number | Vector2, origin?: Vector2): Diagram
Scale the diagram by a scale around a origin
Parameters
- scale: number | Vector2
  scale to scale (x, y)
- Optionalorigin: Vector2
  origin point, if left undefined, scale around the origin
Returns Diagram
- Defined in diagram.ts:648

scaletext

scaletext(scale: number): Diagram
Scale texts contained in the diagram by a scale
Parameters
- scale: number
  scaling factor
Returns Diagram
- Defined in diagram.ts:658

skewX

skewX(angle: number, base?: Vector2): Diagram
Skew the diagram in the x direction by an angle around a base
Parameters
- angle: number
  angle to skew
- Optionalbase: Vector2
  base point, if left undefined, skew around the origin
Returns Diagram
- Defined in diagram.ts:682

skewY

skewY(angle: number, base?: Vector2): Diagram
Skew the diagram in the y direction by an angle around a base
Parameters
- angle: number
  angle to skew
- Optionalbase: Vector2
  base point, if left undefined, skew around the origin
Returns Diagram
- Defined in diagram.ts:692

stroke

stroke(color: string): Diagram
Parameters
- color: string
Returns Diagram
- Defined in diagram.ts:446

strokedasharray

strokedasharray(dasharray: number[]): Diagram
Parameters
- dasharray: number[]
Returns Diagram
- Defined in diagram.ts:461

strokelinecap

strokelinecap(linecap: "butt" | "round" | "square"): Diagram
Parameters
- linecap: "butt" | "round" | "square"
Returns Diagram
- Defined in diagram.ts:455

strokelinejoin

strokelinejoin(
linejoin: "round" | "arcs" | "bevel" | "miter" | "miter-clip",
): Diagram
Parameters
- linejoin: "round" | "arcs" | "bevel" | "miter" | "miter-clip"
Returns Diagram
- Defined in diagram.ts:458

strokewidth

strokewidth(width: number): Diagram
Parameters
- width: number
Returns Diagram
- Defined in diagram.ts:452

text_totext

text_totext(): Diagram
Returns Diagram
- Defined in diagram.ts:533

text_tovar

text_tovar(): Diagram
Returns Diagram
- Defined in diagram.ts:522

textanchor

textanchor(textanchor: "start" | "middle" | "end"): Diagram
Parameters
- textanchor: "start" | "middle" | "end"
Returns Diagram
- Defined in diagram.ts:513

textangle

textangle(angle: number): Diagram
Parameters
- angle: number
Returns Diagram
- Defined in diagram.ts:519

textdy

textdy(dy: string): Diagram
Parameters
- dy: string
Returns Diagram
- Defined in diagram.ts:516

textfill

textfill(color: string): Diagram
Parameters
- color: string
Returns Diagram
- Defined in diagram.ts:472

textstroke

textstroke(color: string): Diagram
Parameters
- color: string
Returns Diagram
- Defined in diagram.ts:475

textstrokewidth

textstrokewidth(width: number): Diagram
Parameters
- width: number
Returns Diagram
- Defined in diagram.ts:478

to_curve

to_curve(): Diagram
Convert the diagram to a curve If the diagram is a polygon, convert it to a curve If the diagram is a Diagram, convert all of the children to curves

Returns Diagram
- Defined in diagram.ts:368

to_polygon

to_polygon(): Diagram
Convert the diagram to a polygon If the diagram is a curve, convert it to a polygon If the diagram is a Diagram, convert all of the children to polygons

Returns Diagram
- Defined in diagram.ts:385

transform

transform(transform_function: (p: Vector2) => Vector2): Diagram
Transform the diagram by a function
Parameters
- transform_function: (p: Vector2) => Vector2
  function to transform the diagram
Returns Diagram
- Defined in diagram.ts:596

translate

translate(v: Vector2): Diagram
Translate the diagram by a vector
Parameters
- v: Vector2
  vector to translate
Returns Diagram
- Defined in diagram.ts:614

vectoreffect

vectoreffect(
    vectoreffect:
        | "none"
        | "non-scaling-stroke"
        | "non-scaling-size"
        | "non-rotation"
        | "fixed-position",
): Diagram
Parameters
- vectoreffect:
      | "none"
      | "non-scaling-stroke"
      | "non-scaling-size"
      | "non-rotation"
      | "fixed-position"
Returns Diagram
- Defined in diagram.ts:464

vflip

vflip(a?: number): Diagram
Vertical flip Reflect the diagram over a horizontal line y = a
Parameters
- Optionala: number
  y value of the line if left undefined, flip over the origin
Returns Diagram
- Defined in diagram.ts:740

Class Diagram

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Diagram

Properties

children

foreignobjdata

imgdata

multilinedata

mutable

origin

path

style

tags

textdata

type

Methods

add_points

Parameters

Returns Diagram

append_tags

Parameters

Returns Diagram

apply

Parameters

Returns Diagram

apply_recursive

Parameters

Returns Diagram

apply_to_tagged_recursive

Parameters

Returns Diagram

bounding_box

Returns [Vector2, Vector2]

clone_style_from

Parameters

Returns Diagram

combine

Parameters

Returns Diagram

contain_all_tags

Parameters

Returns boolean

contain_tag

Parameters

Returns boolean

copy

Returns Diagram

copy_if_not_mutable

Returns Diagram

debug

Parameters

Returns Diagram

debug_bbox

Returns Diagram

fill

Parameters

Returns Diagram

filter

Parameters

Returns Diagram

flatten

Returns Diagram

fontfamily

Parameters

Returns Diagram

fontscale

Parameters

Returns Diagram

fontsize

Parameters

Returns Diagram

fontstyle

Parameters

Returns Diagram