Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TransformationEvent

Transformation events are generated by an editor before and after a transformation is executed. The StartTransformation event is generated before, and the EndTransformation is generated after. These events allow modes to perform additional processing before or after a transformation, or to abort a transformation while it is being processed.

Hierarchy

  • TransformationEvent

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional _abortMessage

_abortMessage: undefined | string

Private _aborted

_aborted: boolean = false

name

name: "StartTransformation" | "EndTransformation"

The name of the event.

transformation

transformation: Transformation<TransformationData>

The transformation to which the event pertains.

Accessors

aborted

  • get aborted(): boolean

Methods

abort

  • abort(message: string): void

  • Mark the transformation as aborted. Once aborted, a transformation cannot be unaborted.

    Parameters

    • message: string

    Returns void

throwIfAborted

  • throwIfAborted(): void

Generated using TypeDoc