Class ShapeModel<T, P>Abstract

constructor

• new ShapeModel<T, P>(board, node, config?): ShapeModel<T, P>

• Creates a new shape

  Type Parameters

  • T extends Shape<ShapeConfig> | Group = Shape<ShapeConfig> | Group
  • P extends ShapeConfig = ShapeConfig

  Parameters

  • board: Board

    The [[Board]]
  • node: T

    The shape node
  • config: ShapeConfig = {}

    The [[ShapeConfig | Config]]

  Returns ShapeModel<T, P>

config

node

filters

• get filters(): Filters[]

• Returns a list of the shape's filters

  Returns Filters[]

group

• get group(): Nullable<string>

• Returns group id of the shape

  Returns Nullable<string>
• set group(name): void

• Adds the shape to the given group name

  Parameters

  • name: Nullable<string>

  Returns void

isActive

• get isActive(): boolean

• Returns whether the shape is active or not

  Returns boolean

isDeleted

• get isDeleted(): boolean

• Returns whether the shape is deleted or not

  Returns boolean

isInvisible

• get isInvisible(): boolean

• Returns whether the shape is invisible or not

  Returns boolean

isSelectable

• get isSelectable(): boolean

• Returns whether the shape is selectable or not

  Returns boolean
• set isSelectable(selectable): void

• Updates the selectable behavior of the shape

  Parameters

  • selectable: boolean

  Returns void

isVisible

• get isVisible(): any

• Returns whether the shape is visible or not

  Returns any

name

• get name(): string

• Returns name of the shape

  Returns string

Abstract type

• get type(): string

• Returns type of the shape

  Returns string

addFilter

• addFilter(filter): void

• Adds filter or filters to the selected shapes

  Parameters

  • filter: Filters | Filters[]

    The [[Filters]]

  Returns void

delete

• delete(): void

• Deletes the shape.

  This action can undo with [[ShapeModel.undelete]] method

  Returns void

deselect

• deselect(): void

• Deselects the shape

  Returns void

destroy

• destroy(): void

• Destroys a deleted shape

  Returns void

flipX

• flipX(): void

• Flips the shape horizontally

  Returns void

flipY

• flipY(): void

• Flips the shape vertically

  Returns void

hasGroup

• hasGroup(): boolean

• Returns whether the shape belongs to a group

  Returns boolean

height

• height(): number

• Returns height of the shape

  Returns number

hide

• hide(): Shape<ShapeConfig> | Group

• Makes the shape hidden if is visible

  Returns Shape<ShapeConfig> | Group

removeFilter

• removeFilter(filter): void

• Removes a filter or list of filters from the selected shapes

  Parameters

  • filter: FilterFunctions | FilterFunctions[]

    The filter function or functions

  Returns void

rotate

• rotate(theta): void

• Rotates the node around its center without transforming

  Parameters

  • theta: number

    The rotation angle

  Returns void

scale

• scale(): undefined | Vector2d

• Returns scale value of the shape

  Returns undefined | Vector2d

scaleX

• scaleX(): number

• Returns scaleX value of the shape

  Returns number

scaleY

• scaleY(): number

• Returns scaleY value of the shape

  Returns number

select

• select(): void

• Adds the shape to the selections

  Returns void

show

• show(): Shape<ShapeConfig> | Group

• Makes the shape visible if is hidden

  Returns Shape<ShapeConfig> | Group

to

• to(attributes): void

• Updates attributes of the shape with animation effect

  Parameters

  • attributes: Partial<P> & {
        duration: number;
    } & Partial<{
        onFinish: (() => void);
        onUpdate: (() => void);
    }>

    The list of attributes

  Returns void

undelete

• undelete(): void

• Undeletes a deleted shape

  Returns void

update

• update(attributes): void

• Updates attributes of the shape

  Parameters

  • attributes: Partial<P>

    The list of attributes

  Returns void

width

• width(): number

• Returns width of the shape

  Returns number

x

• x(): number

• Returns x position of the shape

  Returns number

y

• y(): number

• Returns y position of the shape

  Returns number