E

LabelEditingAction

Used by IEditLabelHelper to determine the kind of action to handle.

Members

No filters for this type

Constants

A new label is about to be created.

initialize has to provide suitable defaults for LabelEditingEventArgs's style and layoutParameter.

finish has to actually add the label to the provided LabelEditingEventArgs' owner using the LabelEditingEventArgs' properties.

static

See Also

Developer's Guide
A label should be created via Drag and Drop.

This action is used by LabelDropInputMode.

If the current owner is not a valid drop target, initialize may mark the LabelEditingEventArgs as canceled to prevent label creation.

finish has to actually add the label to the provided LabelEditingEventArgs' owner.

static

See Also

Developer's Guide
An existing label is about to be edited.

finish should at least change the label's text.

initialize may provide values for other label properties to be changed in addition to the label's text.

static

See Also

Developer's Guide
A label has been pasted using the GraphClipboard.

With this action, owner is the new owner of the label whereas label is the original label.

initialize is called for newly copied labels during paste . Implementations might, but do not need to, provide custom styles or layout parameters for the new label.

Note that pasting a label to another owner might require to provide a suitable ILabelModelParameter for the new owner.

Method cancel is called immediately after initialize, finish is never called.

static

See Also

Developer's Guide
An existing label should be removed.
This action is only used for finish which has to remove the given label. Usually, this action is used if a label's text is edited to be empty and EditLabelInputMode's autoRemoveEmptyLabels is set to true.
static

See Also

Developer's Guide

Static Methods

Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

value: LabelEditingAction
The value to convert to an enum constant.

Return Value

LabelEditingAction
The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
static

Parameters

value: LabelEditingAction
The numeric value of an enum constant.

Return Value

string
The name of the enum constant.

Throws

Exception ({ name: 'Error' })
If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.