DWVv0.37.0

RunFilterCommand

Source: runFilterCommand.js:10

Run filter command.


Constructor

new RunFilterCommand( filter: object, dataId: string, app: App, ): RunFilterCommand

Parameters

  • filter (object) — The filter to run.
  • dataId (string) — The data to filter.
  • app (App) — The associated application.

Instance Methods

getName(): string

Get the command name.

Returns

  • string — The command name.

execute()

Execute the command.

Fires

  • RunFilterCommand#event:filterrun

undo()

Undo the command.

Fires

  • RunFilterCommand#event:filterundo

onExecute(_event: object)

Handle an execute event.

Parameters

  • _event (object) — The execute event with type and id.

onUndo(_event: object)

Handle an undo event.

Parameters

  • _event (object) — The undo event with type and id.

Events

filterrun: object

Filter run event.

Properties

  • type (string) — The event type: filterrun.
  • id (number) — The id of the run command.

filterundo: object

Filter undo event.

Properties

  • type (string) — The event type: filterundo.
  • id (number) — The id of the undone run command.