E

PointerButtons
flags

Enumeration for the various button states a pointer event uses.

Remarks

The enumeration can be used to create a bitwise combination of the types.

See Also

API

buttons, changedButtons

Members

No filters for this type

Constants

The left mouse button.
static

See Also

Developer's Guide
The middle mouse button.
The right mouse button.
static

See Also

Developer's Guide
Extra mouse button 1.
Extra mouse button 2.
No mouse button.
Stylus has the barrel button pressed.
static

See Also

Developer's Guide
The PEN device has contact with the input device.
A stylus can hover depending on the hardware used. This "virtual button" state indicates what state the stylus is in.
static

See Also

Developer's Guide
Stylus has the eraser button pressed, or it is used upside-down with the end pointing at the surface.
The touch device (finger) has contact with the input device.
This "virtual button" state is assigned when a TOUCH device is down on the surface. Touch devices cannot "hover" like some stylus devices. So this state will always be set when the touch pointer is active.
static

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: PointerButtons
The value to convert to an enum constant.

Return Value

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

Parameters

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