TouchEvent extension type

The TouchEvent interface represents an UIEvent which is sent when the state of contacts with a touch-sensitive surface changes. This surface can be a touch screen or trackpad, for example. The event can describe one or more points of contact with the screen and includes support for detecting movement, addition and removal of contact points, and so forth.

Touches are represented by the Touch object; each touch is described by a position, size and shape, amount of pressure, and target element. Lists of touches are represented by TouchList objects.

---

API documentation sourced from MDN Web Docs.

on

• JSObject

Implemented types

• UIEvent
• JSObject

Available extensions

• JSAnyOperatorExtension
• JSAnyUtilityExtension
• JSObjectUnsafeUtilExtension
• NullableUndefineableJSAnyExtension

Constructors

TouchEvent(String type, [TouchEventInit eventInitDict])

factory

Properties

altKey → bool

The read-only altKey property of the TouchEvent interface returns a boolean value indicating whether or not the alt (Alternate) key is enabled when the touch event is created. If the alt key is enabled, the attribute's value is true. Otherwise, it is false.

no setter

bubbles → bool

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

no setter, inherited

cancelable → bool

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

no setter, inherited

cancelBubble ↔ bool

The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

getter/setter pair, inherited

changedTouches → TouchList

The changedTouches read-only property is a TouchList whose touch points (Touch objects) varies depending on the event type, as follows:

no setter

composed → bool

The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

no setter, inherited

ctrlKey → bool

The read-only ctrlKey property of the TouchEvent interface returns a boolean value indicating whether the control (Control) key is enabled when the touch event is created. If this key is enabled, the attribute's value is true. Otherwise, it is false.

no setter

currentTarget → EventTarget?

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

no setter, inherited

defaultPrevented → bool

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault canceled the event.

no setter, inherited

detail → int

The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count.

no setter, inherited

eventPhase → int

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isDefinedAndNotNull → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

no setter

isNull → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

Whether this value corresponds to JavaScript null.

no setter

isTrusted → bool

The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus), and false when the event was dispatched via EventTarget.dispatchEvent. The only exception is the click event, which initializes the isTrusted property to false in user agents.

no setter, inherited

isTruthy → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of !!this in JavaScript.

no setter

isUndefined → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

Whether this value corresponds to JavaScript undefined.

no setter

isUndefinedOrNull → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

no setter

metaKey → bool

The read-only metaKey property of the TouchEvent interface returns a boolean value indicating whether or not the Meta key is enabled when the touch event is created. If this key is enabled, the attribute's value is true. Otherwise, it is false.

no setter

not → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of !this in JavaScript.

no setter

returnValue ↔ bool

The Event property returnValue indicates whether the default action for this event has been prevented or not.

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shiftKey → bool

The read-only shiftKey property of the TouchEvent interface returns a boolean value indicating whether or not the shift key is enabled when the touch event is created. If this key is enabled, the attribute's value is true. Otherwise, it is false.

no setter

srcElement → EventTarget?

The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.

no setter, inherited

target → EventTarget?

The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

no setter, inherited

targetTouches → TouchList

The targetTouches read-only property is a TouchList listing all the Touch objects for touch points that are still in contact with the touch surface and whose Element.touchstart_event event occurred inside the same target element as the current target element.

no setter

timeStamp → double

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

no setter, inherited

touches → TouchList

touches is a read-only TouchList listing all the Touch objects for touch points that are currently in contact with the touch surface, regardless of whether or not they've changed or what their target element was at Element.touchstart_event time.

no setter

type → String

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

no setter, inherited

view → Window?

The UIEvent.view read-only property returns the object from which the event was generated. In browsers, this is the Window object the event happened in.

no setter, inherited

which → int

The UIEvent.which read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numeric keyCode or the character code (charCode) of the key pressed on the keyboard.

no setter, inherited

Methods

add(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this + any in JavaScript.

and(JSAny? any) → JSAny?

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this && any in JavaScript.

callMethod<R extends JSAny?>(JSAny method, [JSAny? arg1, JSAny? arg2, JSAny? arg3, JSAny? arg4]) → R

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Calls method on this JSObject with up to four arguments.

callMethodVarArgs<R extends JSAny?>(JSAny method, [List<JSAny?>? arguments]) → R

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Calls method on this JSObject with a variable number of arguments.

composedPath() → JSArray<EventTarget>

The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

inherited

dartify() → Object?

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Converts a JavaScript value to the Dart equivalent if possible.

delete(JSAny property) → JSBoolean

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Deletes the property with key property from this JSObject.

divide(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this / any in JavaScript.

equals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this == any in JavaScript.

exponentiate(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this ** any in JavaScript.

getProperty<R extends JSAny?>(JSAny property) → R

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

The value of the property key property of this JSObject.

greaterThan(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this > any in JavaScript.

greaterThanOrEqualTo(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this >= any in JavaScript.

has(String property) → bool

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Shorthand helper for hasProperty to check whether this JSObject contains the property key property, but takes and returns a Dart value.

hasProperty(JSAny property) → JSBoolean

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Whether or not this JSObject contains the property key property.

initEvent(String type, [bool bubbles, bool cancelable]) → void

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent.

inherited

initUIEvent(String typeArg, [bool bubblesArg, bool cancelableArg, Window? viewArg, int detailArg]) → void

The UIEvent.initUIEvent() method initializes a UI event once it's been created.

inherited

instanceof(JSFunction constructor) → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether this JSAny? is an instanceof constructor.

instanceOfString(String constructorName) → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether this JSAny? is an instanceof the constructor that is defined by constructorName, which is looked up in the globalContext.

isA<T extends JSAny?>() → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether this JSAny? is an instance of the JavaScript type that is declared by T.

lessThan(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this < any in JavaScript.

lessThanOrEqualTo(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this <= any in JavaScript.

modulo(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this % any in JavaScript.

multiply(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this * any in JavaScript.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notEquals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this != any in JavaScript.

or(JSAny? any) → JSAny?

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this || any in JavaScript.

preventDefault() → void

The preventDefault() method of the Event interface tells the that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

inherited

setProperty(JSAny property, JSAny? value) → void

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Write the value of property key property of this JSObject.

stopImmediatePropagation() → void

The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

inherited

stopPropagation() → void

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the Event.preventDefault method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see Event.stopImmediatePropagation.

inherited

strictEquals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this === any in JavaScript.

strictNotEquals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this !== any in JavaScript.

subtract(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this - any in JavaScript.

toString() → String

A string representation of this object.

inherited

typeofEquals(String typeString) → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether the result of typeof on this JSAny? is typeString.

unsignedRightShift(JSAny? any) → JSNumber

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this >>> any in JavaScript.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](String property) → JSAny?

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Shorthand helper for getProperty to get the value of the property key property of this JSObject, but takes and returns a Dart value.

operator []=(String property, JSAny? value) → void

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Shorthand helper for setProperty to write the value of the property key property of this JSObject, but takes a Dart value.