Class Diagram

constructor

• new Diagram(type_, args?): Diagram

• Parameters

  • type_: DiagramType
  • args: {
        children?: Diagram[];
        foreignobjdata?: Partial<ForeignObjectData>;
        imgdata?: Partial<ImageData>;
        multilinedata?: Partial<MultilineTextData>;
        path?: Path;
        tags?: string[];
        textdata?: Partial<TextData>;
    } = {}

    • Optionalchildren?: Diagram[]

    • Optionalforeignobjdata?: Partial<ForeignObjectData>

    • Optionalimgdata?: Partial<ImageData>

    • Optionalmultilinedata?: Partial<MultilineTextData>

    • Optionalpath?: Path

    • Optionaltags?: string[]

    • Optionaltextdata?: Partial<TextData>

  Returns Diagram

children

foreignobjdata

imgdata

multilinedata

mutable

origin

path

style

tags

textdata

type

add_points

• add_points(points): 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

append_tags

• append_tags(tags): Diagram

• Append tags to the diagram

  Parameters

  • tags: string | string[]

  Returns Diagram

apply

• apply(func): Diagram

• Apply a function to the diagram

  Parameters

  • func: ((d: Diagram) => Diagram)

    function to apply func takes in a diagram and returns a diagram

    • • (d): Diagram

      • Parameters

        • d: Diagram

        Returns Diagram

  Returns Diagram

apply_recursive

• apply_recursive(func): 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

    • • (d): Diagram

      • Parameters

        • d: Diagram

        Returns Diagram

  Returns Diagram

apply_to_tagged_recursive

• apply_to_tagged_recursive(tags, func): 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

    • • (d): Diagram

      • Parameters

        • d: Diagram

        Returns Diagram

  Returns Diagram

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

clone_style_from

• clone_style_from(diagram): Diagram

• Parameters

  • diagram: Diagram

  Returns Diagram

combine

• combine(...diagrams): Diagram

• Combine another diagram with this diagram

  Parameters

  • Rest...diagrams: Diagram[]

    a diagram or a list of diagrams

  Returns Diagram

contain_all_tags

• contain_all_tags(tags): boolean

• Parameters

  • tags: string[]

  Returns boolean

contain_tag

• contain_tag(tag): boolean

• Check if the diagram contains a tag

  Parameters

  • tag: string

  Returns boolean

copy

• copy(): Diagram

• Copy the diagram

  Returns Diagram

copy_if_not_mutable

• copy_if_not_mutable(): Diagram

• Returns Diagram

debug

• debug(show_index?): Diagram

• Parameters

  • show_index: boolean = true

  Returns Diagram

debug_bbox

• debug_bbox(): Diagram

• Returns Diagram

fill

• fill(color): Diagram

• Parameters

  • color: string

  Returns Diagram

filter

• filter(filter): Diagram

• Parameters

  • filter: string

  Returns Diagram

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

fontfamily

• fontfamily(fontfamily): Diagram

• Parameters

  • fontfamily: string

  Returns Diagram

fontscale

• fontscale(fontscale): Diagram

• Parameters

  • fontscale: number | "auto"

  Returns Diagram

fontsize

• fontsize(fontsize): Diagram

• Parameters

  • fontsize: number

  Returns Diagram

fontstyle

• fontstyle(fontstyle): Diagram

• Parameters

  • fontstyle: string

  Returns Diagram

fontweight

• fontweight(fontweight): Diagram

• Parameters

  • fontweight:
        | number
        | "bold"
        | "normal"
        | "bolder"
        | "lighter"

  Returns Diagram

get_anchor

• get_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

get_tagged_elements

• get_tagged_elements(tags): 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

hflip

• hflip(a?): 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

immut

• immut(): Diagram

• Create a copy of the diagram that is immutable

  Returns Diagram

is_empty

• is_empty(): boolean

• Returns boolean

move_origin

• move_origin(pos): 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

move_origin_text

• move_origin_text(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

mut

• mut(): Diagram

• Turn the diagram into a mutable diagram

  Returns Diagram

mut_parent_only

• mut_parent_only(): Diagram

• Returns Diagram

opacity

• opacity(opacity): Diagram

• Parameters

  • opacity: number

  Returns Diagram

parametric_point

• parametric_point(t, segment_index?): 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

path_length

• path_length(): number

• Returns number

position

• position(v?): Diagram

• move the diagram to a position

  Parameters

  • v: Vector2 = ...

    position to move to (if left undefined, move to the origin)

  Returns Diagram

reflect

• reflect(p1?, p2?): 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

reflect_over_line

• reflect_over_line(p1, p2): 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

reflect_over_point

• reflect_over_point(p): Diagram

• Reflect the diagram over a point

  Parameters

  • p: Vector2

    point to reflect over

  Returns Diagram

remove_tags

• remove_tags(tags): Diagram

• Remove tags from the diagram

  Parameters

  • tags: string | string[]

  Returns Diagram

reset_tags

• reset_tags(): Diagram

• Reset all tags of the diagram

  Returns Diagram

reverse_path

• reverse_path(): Diagram

• Reverse the order of the points in the path

  Returns Diagram

rotate

• rotate(angle, pivot?): 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

scale

• scale(scale, origin?): 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

scaletext

• scaletext(scale): Diagram

• Scale texts contained in the diagram by a scale

  Parameters

  • scale: number

    scaling factor

  Returns Diagram

skewX

• skewX(angle, base?): 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

skewY

• skewY(angle, base?): 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

stroke

• stroke(color): Diagram

• Parameters

  • color: string

  Returns Diagram

strokedasharray

• strokedasharray(dasharray): Diagram

• Parameters

  • dasharray: number[]

  Returns Diagram

strokelinecap

• strokelinecap(linecap): Diagram

• Parameters

  • linecap: "butt" | "round" | "square"

  Returns Diagram

strokelinejoin

• strokelinejoin(linejoin): Diagram

• Parameters

  • linejoin:
        | "round"
        | "arcs"
        | "bevel"
        | "miter"
        | "miter-clip"

  Returns Diagram

strokewidth

• strokewidth(width): Diagram

• Parameters

  • width: number

  Returns Diagram

text_totext

• text_totext(): Diagram

• Returns Diagram

text_tovar

• text_tovar(): Diagram

• Returns Diagram

textanchor

• textanchor(textanchor): Diagram

• Parameters

  • textanchor: "start" | "middle" | "end"

  Returns Diagram

textangle

• textangle(angle): Diagram

• Parameters

  • angle: number

  Returns Diagram

textdy

• textdy(dy): Diagram

• Parameters

  • dy: string

  Returns Diagram

textfill

• textfill(color): Diagram

• Parameters

  • color: string

  Returns Diagram

textstroke

• textstroke(color): Diagram

• Parameters

  • color: string

  Returns Diagram

textstrokewidth

• textstrokewidth(width): Diagram

• Parameters

  • width: number

  Returns Diagram

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

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

transform

• transform(transform_function): Diagram

• Transform the diagram by a function

  Parameters

  • transform_function: ((p: Vector2) => Vector2)

    function to transform the diagram

    • • (p): Vector2

      • Parameters

        • p: Vector2

        Returns Vector2

  Returns Diagram

translate

• translate(v): Diagram

• Translate the diagram by a vector

  Parameters

  • v: Vector2

    vector to translate

  Returns Diagram

vectoreffect

• vectoreffect(vectoreffect): Diagram

• Parameters

  • vectoreffect:
        | "none"
        | "non-scaling-stroke"
        | "non-scaling-size"
        | "non-rotation"
        | "fixed-position"

  Returns Diagram

vflip

• vflip(a?): 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