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
- Implemented types
- Available extensions
Constructors
- TouchEvent(String type, [TouchEventInit eventInitDict])
-
factory
Properties
- altKey → bool
-
The read-only
altKeyproperty 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 istrue. Otherwise, it isfalse.no setter - asString → String
-
Available on JSAny, provided by the JSAnyExtension extension
no setter - asString → String?
-
Available on JSAny?, provided by the JSAnyNullableExtension extension
no setter - bubbles → bool
-
The
bubblesread-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.no setterinherited - cancelable → bool
-
The
cancelableread-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.no setterinherited - cancelBubble ↔ bool
-
The
cancelBubbleproperty of the Event interface is deprecated. Use Event.stopPropagation instead. Setting its value totruebefore returning from an event handler prevents propagation of the event. In later implementations, setting this tofalsedoes nothing. See Browser compatibility for details.getter/setter pairinherited - changedTouches → TouchList
-
The
changedTouchesread-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
composedproperty 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 setterinherited - ctrlKey → bool
-
The read-only
ctrlKeyproperty 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 istrue. Otherwise, it isfalse.no setter - currentTarget → EventTarget?
-
The
currentTargetread-only property of the Event interface identifies the element to which the event handler has been attached.no setterinherited - defaultPrevented → bool
-
The
defaultPreventedread-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault canceled the event.no setterinherited - detail → int
-
The
UIEvent.detailread-only property, when non-zero, provides the current (or next, depending on the event) click count.no setterinherited -
entries
→ Iterable<
MapEntry< String, dynamic> > -
Available on JSObject, provided by the JSObjectExtension extension
no setter - eventPhase → int
-
The
eventPhaseread-only property of the Event interface indicates which phase of the event flow is currently being evaluated.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- isDefinedAndNotNull → bool
-
Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension
no setter - isElement → bool
-
Available on JSObject?, provided by the JSObjectWebExtension extension
no setter - isHTMLElement → bool
-
Available on JSObject?, provided by the JSObjectWebExtension extension
no setter - isNode → bool
-
Available on JSObject?, provided by the JSObjectWebExtension extension
no setter - isNull → bool
-
Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension
Whether this value corresponds to JavaScriptnull.no setter - isTrusted → bool
-
The
isTrustedread-only property of the Event interface is a boolean value that istruewhen the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus), andfalsewhen the event was dispatched via EventTarget.dispatchEvent. The only exception is theclickevent, which initializes theisTrustedproperty tofalsein user agents.no setterinherited - isTruthy → JSBoolean
-
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of!!in JavaScript.thisno setter - isUndefined → bool
-
Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension
Whether this value corresponds to JavaScriptundefined.no setter - isUndefinedOrNull → bool
-
Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension
no setter -
keys
→ Iterable<
String> -
Available on JSObject, provided by the JSObjectExtension extension
no setter - metaKey → bool
-
The read-only
metaKeyproperty 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 istrue. Otherwise, it isfalse.no setter - not → JSBoolean
-
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result of!in JavaScript.thisno setter - returnValue ↔ bool
-
The Event property
returnValueindicates whether the default action for this event has been prevented or not.getter/setter pairinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shiftKey → bool
-
The read-only
shiftKeyproperty of theTouchEventinterface 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 istrue. Otherwise, it isfalse.no setter - srcElement → EventTarget?
-
The deprecated
Event.srcElementis an alias for the Event.target property. Use Event.target instead.no setterinherited - target → EventTarget?
-
The read-only
targetproperty 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 setterinherited - targetTouches → TouchList
-
The
targetTouchesread-only property is a TouchList listing all the Touch objects for touch points that are still in contact with the touch surface and whoseElement.touchstart_eventevent occurred inside the same targetelementas the current target element.no setter - timeStamp → double
-
The
timeStampread-only property of the Event interface returns the time (in milliseconds) at which the event was created.no setterinherited - touches → TouchList
-
touchesis 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 atElement.touchstart_eventtime.no setter - type → String
-
The
typeread-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 asclick,load, orerror.no setterinherited - view → Window?
-
The
UIEvent.viewread-only property returns the object from which the event was generated. In browsers, this is the Window object the event happened in.no setterinherited - which → int
-
The
UIEvent.whichread-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numerickeyCodeor the character code (charCode) of the key pressed on the keyboard.no setterinherited
Methods
-
add(
JSAny? any) → JSAny -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this+any -
and(
JSAny? any) → JSAny? -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this&&any -
as<
T extends JSObject> () → T? -
Available on JSObject, provided by the JSObjectExtension extension
-
callMethod<
R extends JSAny?> (JSAny method, [JSAny? arg1, JSAny? arg2, JSAny? arg3, JSAny? arg4]) → R -
Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Callsmethodon 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
Callsmethodon this JSObject with a variable number ofarguments. -
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 JSON-like value to the Dart equivalent if possible. -
delete(
JSAny property) → JSBoolean -
Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Deletes the property with keypropertyfrom this JSObject. -
divide(
JSAny? any) → JSAny -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this/any -
equals(
JSAny? any) → JSBoolean -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this==any -
exponentiate(
JSAny? any) → JSAny -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this**any -
get(
String key) → Object? -
Available on JSObject, provided by the JSObjectExtension extension
-
getProperty<
R extends JSAny?> (JSAny property) → R -
Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
The value of the property keypropertyof this JSObject. -
greaterThan(
JSAny? any) → JSBoolean -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this>any -
greaterThanOrEqualTo(
JSAny? any) → JSBoolean -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this>=any -
has(
String property) → bool -
Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Shorthand helper for hasProperty to check whether this JSObject contains the property keyproperty, 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 keyproperty. -
initEvent(
String type, [bool bubbles, bool cancelable]) → void -
The
Event.initEvent()method is used to initialize the value of aneventcreated 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 thisJSAny?is aninstanceofconstructor. -
instanceOfString(
String constructorName) → bool -
Available on JSAny?, provided by the JSAnyUtilityExtension extension
Whether thisJSAny?is aninstanceofthe constructor that is defined byconstructorName, which is looked up in the globalContext. -
isA<
T extends JSAny?> () → bool -
Available on JSAny?, provided by the JSAnyUtilityExtension extension
Whether thisJSAny?is an instance of the JavaScript type that is declared byT. -
lessThan(
JSAny? any) → JSBoolean -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this<any -
lessThanOrEqualTo(
JSAny? any) → JSBoolean -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this<=any -
modulo(
JSAny? any) → JSAny -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this%any -
multiply(
JSAny? any) → JSAny -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this*any -
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 ofin JavaScript.this!=any -
or(
JSAny? any) → JSAny? -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this||any -
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 -
put(
Object key, Object? value) → void -
Available on JSObject, provided by the JSObjectExtension extension
-
setProperty(
JSAny property, JSAny? value) → void -
Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Write thevalueof property keypropertyof 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 ofin JavaScript.this===any -
strictNotEquals(
JSAny? any) → JSBoolean -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this!==any -
subtract(
JSAny? any) → JSAny -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this-any -
toMap(
) → Map< String, dynamic> -
Available on JSObject, provided by the JSObjectExtension extension
-
toString(
) → String -
A string representation of this object.
inherited
-
typeofEquals(
String typeString) → bool -
Available on JSAny?, provided by the JSAnyUtilityExtension extension
Whether the result oftypeofon thisJSAny?istypeString. -
unsignedRightShift(
JSAny? any) → JSNumber -
Available on JSAny?, provided by the JSAnyOperatorExtension extension
The result ofin JavaScript.this>>>any
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 keypropertyof this JSObject, but takes a Dart value. -
operator []=(
String property, JSAny? value) → void -
Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension
Shorthand helper for setProperty to write thevalueof the property keypropertyof this JSObject, but takes a Dart value.