Class ShapeDrawer<T, P>Abstract

This is an abstract class that Shapes have to extend that to insert or draw their own

Example

editor.board.shapes.circle.insert({
 x: 100,
 y: 100,
 radius: 10,
 fill: 'red'
})

Example

editor.board.shapes.circle.draw()

Example

editor.board.shapes.circle.stopDrawing()

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

config node startPoint

Accessors

isDrawing

Methods

draw getShapePosition insert stopDrawing

Constructors

constructor

  • new ShapeDrawer<T, P>(board, drawType, options?): ShapeDrawer<T, P>

  • Creates a Shape Drawer instance to build and draw different shapes

    Type Parameters

    • T extends Shape<ShapeConfig>
    • P extends ShapeConfig

    Parameters

    • board: Board

      The [[Board]]

    • drawType: string

      The type of [[string | Drawing]]

    • Optional options: DrawingOptions

      The drawing possible options

    Returns ShapeDrawer<T, P>

Properties

config

config: Partial<P>

Reperesents the configuration of the shape that is drawing that

Abstract node

node: null | T

Reperesents the node which is drawing or has been drawn

startPoint

startPoint: Point

Reperesents the start point of the drawing shape

Accessors

isDrawing

  • get isDrawing(): boolean

  • Checks wheather the current shape is drawing or not

    Returns boolean

Methods

draw

  • draw(config): void

  • Enables the drawing mode

    Parameters

    • config: Partial<P>

      The initial [[ShapeModel]] config

    Returns void

getShapePosition

  • getShapePosition(): {
        x: number;
        y: number;
    }

  • Returns current position of the shape

    Returns {
        x: number;
        y: number;
    }

    the current position of the shape as a [[Point]]

    • x: number
    • y: number

insert

  • insert(config): ShapeModel<T, ShapeConfig>

  • Creates a new shape and insert that into the [[Board]]

    Parameters

    • config: ShapeConfig

      The [[ShapeModel]] configuration

    Returns ShapeModel<T, ShapeConfig>

    The created [[ShapeModel]]

stopDrawing

Settings

Member Visibility

Theme

On This Page

constructorconfignodestartPointisDrawingdrawgetShapePositioninsertstopDrawing