Interface Events

Events for IMovable events.

interface Events {
    onAnchorCoordsChange?(source: IAnchored, prev: Coords): void;
    onAnchorTypeChange?(source: IMovable): void;
    onAnyChange?(source: IMovable): void;
    onBoundsChange?(source: IMovable): void;
    onClose?(source: IAnchored): void;
    onDelete?(source: IAnchored): void;
    onInvalidated?(source: IAnchored): void;
    onProtectedChange?(source: IAnchored): void;
    onRequestFocus?(source: IMovable): Promise<boolean>;
    onSelectionChange?(source: IMovable): void;
}

Hierarchy (View Summary)

IAnchored.Events
- Events

Index

Methods

onAnchorCoordsChange? onAnchorTypeChange? onAnyChange? onBoundsChange? onClose? onDelete? onInvalidated? onProtectedChange? onRequestFocus? onSelectionChange?

Methods

`Optional`onAnchorCoordsChange

onAnchorCoordsChange?(source: IAnchored, prev: Coords): void
Called when the anchor bounds are updated.
Parameters
- source: IAnchored
- prev: Coords
Returns void

Inherited from Events.onAnchorCoordsChange

`Optional`onAnchorTypeChange

onAnchorTypeChange?(source: IMovable): void
Called when the anchor type is updated.
Parameters
- source: IMovable
Returns void

`Optional`onAnyChange

onAnyChange?(source: IMovable): void
Called when any property has changed.
Parameters
- source: IMovable
Returns void

Overrides Events.onAnyChange

`Optional`onBoundsChange

onBoundsChange?(source: IMovable): void
Called when the bounds have changed, or, for a member of a group, when where it is drawn has: a movable above it moved, turned, mirrored or resized.
Parameters
- source: IMovable
Returns void

`Optional`onClose

onClose?(source: IAnchored): void
Called when the anchor transaction is closed.
Parameters
- source: IAnchored
Returns void

Inherited from Events.onClose

`Optional`onDelete

onDelete?(source: IAnchored): void
Called when the anchor is removed.
Parameters
- source: IAnchored
Returns void

Inherited from Events.onDelete

`Optional`onInvalidated

onInvalidated?(source: IAnchored): void
Called when the state has been updated due to a undo/redo and a rerender is required.
Parameters
- source: IAnchored
Returns void

Inherited from Events.onInvalidated

`Optional`onProtectedChange

onProtectedChange?(source: IAnchored): void
Called when the anchor protection is updated.
Parameters
- source: IAnchored
Returns void

Inherited from Events.onProtectedChange

`Optional`onRequestFocus

onRequestFocus?(source: IMovable): Promise<boolean>
Request that the movable become focused.
Parameters
- source: IMovable
Returns Promise<boolean>
A promise indicating if the focus was honored.

Remarks
This should only be handled by one consumer.

`Optional`onSelectionChange

onSelectionChange?(source: IMovable): void
Called when the isSelect status has changed.
Parameters
- source: IMovable
Returns void