Enumeration for the various button states a pointer event uses.
Remarks
The enumeration can be used to create a bitwise combination of the types.
Type Details
- yFiles module
- view
See Also
Constants
The PEN device has contact with the input device.
Remarks
A stylus can hover depending on the hardware used. This "virtual button" state indicates what state the stylus is in.
The touch device (finger) has contact with the input device.
Remarks
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 Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - PointerButtons
- The value to convert to an enum constant.
Returns
- ↪PointerButtons
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - PointerButtons
- The numeric value of an enum constant.
Returns
- ↪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.