E

HandleType

Show Usages
Describes the type of IHandle.

Remarks

This type can be used by the rendering engine to render different types of handles differently and with different CSS classes.

See Also

An overview of the different CSS styling options is presented in detail in the section CSS Styling of Handles .

Developer's Guide

API

type, HandleInputMode

Members

No filters for this type

Constants

CUSTOM1

static
A handle using a visualization type that differs from the more specific handle types.
The default visualization is a circle using the yfiles-handle-custom1-template CSS class, with colors swapped compared to MOVE.
static

See Also

Developer's Guide

CUSTOM2

static
A handle using a visualization type that differs from the more specific handle types.
The default visualization is a square using the yfiles-handle-custom2-template CSS class, with colors swapped compared to RESIZE.
static

See Also

Developer's Guide

CUSTOM3

static
A handle using a visualization type that differs from the more specific handle types.
The default visualization is a double-circle using the yfiles-handle-custom3-template CSS class, with colors like MOVE.
static

See Also

Developer's Guide

CUSTOM4

static
A handle using a visualization type that differs from the more specific handle types.
The default visualization is a double-square using the yfiles-handle-custom4-template CSS class, with colors like RESIZE.
static

See Also

Developer's Guide

CUSTOM5

static
A handle using a visualization type that differs from the more specific handle types.
The default visualization is a double-circle using the yfiles-handle-custom5-template CSS class, with colors swapped compared to MOVE.
static

See Also

Developer's Guide

CUSTOM6

static
A handle using a visualization type that differs from the more specific handle types.
The default visualization is a double-square using the yfiles-handle-custom6-template CSS class, with colors swapped compared to RESIZE.
static

See Also

Developer's Guide

INVISIBLE

static
An invisible handle that can still be clicked, tapped, and dragged.
static

See Also

Developer's Guide

MOVE

static
A handle which can be used to move something.
The default visualization is a circle using the yfiles-handle-move-template CSS class.
static

See Also

Developer's Guide

MOVE2

static
A handle which can be used to move something using a different visualization than MOVE.
The default visualization is a circle using the yfiles-handle-move-variant2-template CSS class, with colors swapped compared to MOVE.
static

See Also

Developer's Guide

MOVE3

static
A handle which can be used to move something using a different visualization than MOVE.
The default visualization is a square using the yfiles-handle-move-variant3-template CSS class, with colors swapped compared to RESIZE.
static

See Also

Developer's Guide

RESIZE

static
A handle which can be used to resize something.
The default visualization is a square using the yfiles-handle-resize-template CSS class.
static

See Also

Developer's Guide

RESIZE_BOTTOM

static
A handle which can be used to resize something and should be rendered with an offset to the bottom.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-bottom CSS class.
static

See Also

Developer's Guide

RESIZE_BOTTOM_LEFT

static
A handle which can be used to resize something and should be rendered with an offset to the bottom left.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-bottom and yfiles-handle-left CSS classes.
static

See Also

Developer's Guide

RESIZE_BOTTOM_RIGHT

static
A handle which can be used to resize something and should be rendered with an offset to the bottom right.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-bottom and yfiles-handle-right CSS classes.
static

See Also

Developer's Guide

RESIZE_LEFT

static
A handle which can be used to resize something and should be rendered with an offset to the left.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-left CSS class.
static

See Also

Developer's Guide

RESIZE_RIGHT

static
A handle which can be used to resize something and should be rendered with an offset to the right.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-right CSS class.
static

See Also

Developer's Guide

RESIZE_TOP

static
A handle which can be used to resize something and should be rendered with an offset to the top.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-top CSS class.
static

See Also

Developer's Guide

RESIZE_TOP_LEFT

static
A handle which can be used to resize something and should be rendered with an offset to the top left.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-top and yfiles-handle-left CSS classes.
static

See Also

Developer's Guide

RESIZE_TOP_RIGHT

static
A handle which can be used to resize something and should be rendered with an offset to the top right.
The default visualization is a square using the yfiles-handle-resize-template CSS class wrapped in a <use>-element using the yfiles-handle-top and yfiles-handle-right CSS classes.
static

See Also

Developer's Guide

VOID

static
An invisible handle that cannot be clicked, tapped, or dragged.
static

See Also

Developer's Guide

Static Methods

from

(value: HandleType): HandleType
static
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: HandleType
The value to convert to an enum constant.

Return Value

HandleType
The enum constant that corresponds to the given argument.

getName

(value: HandleType): string
static
Returns the name of the given enum constant.
static

Parameters

value: HandleType
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.