Skip to main content

Class: ProcedureParameterDelete

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_delete.ts:14

Notifies listeners that a parameter has been removed from a procedure.

Extends​

Properties index​

PropertyDescription
groupAn ID for the group of events this block is associated with.
indexThe index the parameter was at before it was removed.
isBlankWhether or not the event was constructed without necessary parameters (to be populated by fromJson).
isUiEventWhether or not the event is a UI event.
parameterThe parameter model associated with this event.
procedureThe procedure model associated with this event.
recordUndoWhether this event is undoable or not.
typeA string used to check the type of the event.
workspaceIdThe workspace identifier for this event.
TYPE-

Methods index​

MethodDescription
getEventWorkspace_Get workspace the event belongs to.
isNullDoes this event record any change of state?
runReplays the event in the workspace.
toJsonEncode the event as JSON.

Constructors​

Constructor​

new ProcedureParameterDelete(
workspace,
procedure,
parameter,
index
): ProcedureParameterDelete;

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_delete.ts:29

Constructs the procedure parameter delete event.

Parameters​

ParameterTypeDescription
workspaceWorkspaceThe workspace this event is associated with.
procedureIProcedureModelThe procedure model this event is associated with.
parameterIParameterModelThe parameter model that was just removed from the procedure.
indexnumberThe index the parameter was at before it was removed.

Returns​

ProcedureParameterDelete

Overrides​

ProcedureParameterBase.constructor

Properties​

group​

group: string;

An ID for the group of events this block is associated with.

Groups define events that should be treated as an single action from the user's perspective, and should be undone together.

Inherited from​

ProcedureParameterBase.group


index​

readonly index: number;

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_delete.ts:33

The index the parameter was at before it was removed.


isBlank​

isBlank: boolean = false;

Defined in: plugins/block-shareable-procedures/src/events_procedure_base.ts:18

Whether or not the event was constructed without necessary parameters (to be populated by fromJson).

Inherited from​

ProcedureParameterBase.isBlank


isUiEvent​

isUiEvent: boolean;

Whether or not the event is a UI event.

Inherited from​

ProcedureParameterBase.isUiEvent


parameter​

readonly parameter: IParameterModel;

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:30

The parameter model associated with this event.

Inherited from​

ProcedureParameterBase.parameter


procedure​

readonly procedure: IProcedureModel;

Defined in: plugins/block-shareable-procedures/src/events_procedure_base.ts:28

The procedure model associated with this event.

Inherited from​

ProcedureParameterBase.procedure


recordUndo​

recordUndo: boolean;

Whether this event is undoable or not.

Inherited from​

ProcedureParameterBase.recordUndo


type​

type: string = ProcedureParameterDelete.TYPE;

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_delete.ts:18

A string used to check the type of the event.

Overrides​

ProcedureParameterBase.type


workspaceId?​

workspaceId?: string;

The workspace identifier for this event.

Inherited from​

ProcedureParameterBase.workspaceId


TYPE​

readonly static TYPE: "procedure_parameter_delete" = 'procedure_parameter_delete';

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_delete.ts:15

Overrides​

ProcedureParameterBase.TYPE

Methods​

getEventWorkspace_()​

getEventWorkspace_(): Workspace;

Get workspace the event belongs to.

Returns​

Workspace

The workspace the event belongs to.

Throws​

if workspace is null.

Inherited from​

ProcedureParameterBase.getEventWorkspace_


isNull()​

isNull(): boolean;

Does this event record any change of state?

Returns​

boolean

True if null, false if something changed.

Inherited from​

ProcedureParameterBase.isNull


run()​

run(forward): void;

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_delete.ts:44

Replays the event in the workspace.

Parameters​

ParameterTypeDescription
forwardbooleanif true, play the event forward (redo), otherwise play it backward (undo).

Returns​

void

Overrides​

ProcedureParameterBase.run


toJson()​

toJson(): ProcedureParameterDeleteJson;

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_delete.ts:66

Encode the event as JSON.

Returns​

ProcedureParameterDeleteJson

JSON representation.

Overrides​

ProcedureParameterBase.toJson