DocumentQuery class

A query object of document.

  • See also $document.
Inheritance

Constructors

DocumentQuery()

Properties

context → dynamic
The DOM node context originally passed to Query; if none was passed [...]
read-only, inherited
cookies Map<String, String>
Returns all cookies.
read-only
data Data
The interface to access custom element data.
read-only, inherited
first HtmlDocument
Returns the first element. [...]
read / write, inherited
firstIfAny HtmlDocument
Return the first matched element, or null if empty.
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
height int
Retrieve the height of the first element of this collection.
read-only, inherited
isEmpty bool
Returns true if there are no elements in this collection. [...]
read-only, inherited
isNotEmpty bool
Returns true if there is at least one element in this collection. [...]
read-only, inherited
iterator Iterator<HtmlDocument>
Returns a new Iterator that allows iterating the elements of this Iterable. [...]
read-only, inherited
last HtmlDocument
Returns the last element. [...]
read / write, inherited
length int
The number of objects in this list. [...]
read / write, inherited
reversed Iterable<HtmlDocument>
Returns an Iterable of the objects in this list in reverse order.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
scrollLeft int
Get the current horizontal position of the scroll bar for the first element [...]
read / write, inherited
scrollTop int
Get the current vertical position of the scroll bar for the first element [...]
read / write, inherited
selector String
read-only, inherited
single HtmlDocument
Checks that this iterable has only one element, and returns that element. [...]
read-only, inherited
width int
Retrieve the width of the first element of this collection.
read-only, inherited

Methods

add(HtmlDocument value) → void
Adds value to the end of this list, extending the length by one. [...]
inherited
addAll(Iterable<HtmlDocument> iterable) → void
Appends all objects of iterable to the end of this list. [...]
inherited
any(bool test(HtmlDocument element)) bool
Checks whether any element of this iterable satisfies test. [...]
inherited
asMap() Map<int, HtmlDocument>
Returns an unmodifiable Map view of this. [...]
inherited
cast<R>() List<R>
Returns a view of this list as a list of R instances. [...]
inherited
clear() → void
Removes all objects from this list; the length of the list becomes zero. [...]
inherited
contains(Object element) bool
Returns true if the collection contains an element equal to element. [...]
inherited
Accesses the cookie. [...]
elementAt(int index) HtmlDocument
Returns the indexth element. [...]
inherited
end() Query
Pops out the top Query object in the stack and retrieve the previous one. [...]
inherited
every(bool test(HtmlDocument element)) bool
Checks whether every element of this iterable satisfies test. [...]
inherited
expand<T>(Iterable<T> f(HtmlDocument element)) Iterable<T>
Expands each element of this Iterable into zero or more elements. [...]
inherited
fillRange(int start, int end, [HtmlDocument fillValue]) → void
Sets the objects in the range start inclusive to end exclusive to the given fillValue. [...]
inherited
find(String selector) ElementQuery
Retrieve an ElementQuery containing descendants of this element collection [...]
inherited
firstWhere(bool test(HtmlDocument element), {HtmlDocument orElse()}) HtmlDocument
Returns the first element that satisfies the given predicate test. [...]
inherited
fold<T>(T initialValue, T combine(T previousValue, HtmlDocument element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value [...]
inherited
followedBy(Iterable<HtmlDocument> other) Iterable<HtmlDocument>
Returns the lazy concatenation of this iterable and other. [...]
inherited
forEach(void f(HtmlDocument element)) → void
Applies the function f to each element of this collection in iteration order.
inherited
getRange(int start, int end) Iterable<HtmlDocument>
Returns an Iterable that iterates over the objects in the range start inclusive to end exclusive. [...]
inherited
indexOf(HtmlDocument element, [int start = 0]) int
Returns the first index of element in this list. [...]
inherited
indexWhere(bool test(HtmlDocument element), [int start = 0]) int
Returns the first index in the list that satisfies the provided test. [...]
inherited
insert(int index, HtmlDocument element) → void
Inserts element at position index in this list. [...]
inherited
insertAll(int index, Iterable<HtmlDocument> iterable) → void
Inserts all objects of iterable at position index in this list. [...]
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings. [...]
inherited
lastIndexOf(HtmlDocument element, [int start]) int
Returns the last index of element in this list. [...]
inherited
lastIndexWhere(bool test(HtmlDocument element), [int start]) int
Returns the last index in the list that satisfies the provided test. [...]
inherited
lastWhere(bool test(HtmlDocument element), {HtmlDocument orElse()}) HtmlDocument
Returns the last element that satisfies the given predicate test. [...]
inherited
map<T>(T f(HtmlDocument e)) Iterable<T>
Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
off(String types, {String selector, QueryEventListener handler}) → void
Unregister a handler for events of given types. [...]
inherited
on(String types, QueryEventListener handler, {String selector}) → void
Register a handler for events of given types on selected elements. [...]
inherited
one(String types, QueryEventListener handler, {String selector}) → void
Register a one-time handler for events of given types. Once called, [...]
inherited
pushStack(List<Element> elems) ElementQuery
Add a collection of DOM elements onto the Query stack.
inherited
reduce(HtmlDocument combine(HtmlDocument value, HtmlDocument element)) HtmlDocument
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function. [...]
inherited
remove(Object value) bool
Removes the first occurrence of value from this list. [...]
inherited
removeAt(int index) HtmlDocument
Removes the object at position index from this list. [...]
inherited
removeCookie(String name) → void
Removes the cookie.
removeLast() HtmlDocument
Pops and returns the last object in this list. [...]
inherited
removeRange(int start, int end) → void
Removes the objects in the range start inclusive to end exclusive. [...]
inherited
removeWhere(bool test(HtmlDocument element)) → void
Removes all objects from this list that satisfy test. [...]
inherited
replaceRange(int start, int end, Iterable<HtmlDocument> replacement) → void
Removes the objects in the range start inclusive to end exclusive and inserts the contents of replacement in its place. [...]
inherited
retainWhere(bool test(HtmlDocument element)) → void
Removes all objects from this list that fail to satisfy test. [...]
inherited
setAll(int index, Iterable<HtmlDocument> iterable) → void
Overwrites objects of this with the objects of iterable, starting at position index in this list. [...]
inherited
setRange(int start, int end, Iterable<HtmlDocument> iterable, [int skipCount = 0]) → void
Copies the objects of iterable, skipping skipCount objects first, into the range start, inclusive, to end, exclusive, of the list. [...]
inherited
shuffle([Random random]) → void
Shuffles the elements of this list randomly.
inherited
singleWhere(bool test(HtmlDocument element), {HtmlDocument orElse()}) HtmlDocument
Returns the single element that satisfies test. [...]
inherited
skip(int count) Iterable<HtmlDocument>
Returns an Iterable that provides all but the first count elements. [...]
inherited
skipWhile(bool test(HtmlDocument value)) Iterable<HtmlDocument>
Returns an Iterable that skips leading elements while test is satisfied. [...]
inherited
sort([int compare(HtmlDocument a, HtmlDocument b)]) → void
Sorts this list according to the order specified by the compare function. [...]
inherited
sublist(int start, [int end]) List<HtmlDocument>
Returns a new list containing the elements between start and end. [...]
inherited
take(int count) Iterable<HtmlDocument>
Returns a lazy iterable of the count first elements of this iterable. [...]
inherited
takeWhile(bool test(HtmlDocument value)) Iterable<HtmlDocument>
Returns a lazy iterable of the leading elements satisfying test. [...]
inherited
toList({bool growable: true}) List<HtmlDocument>
Creates a List containing the elements of this Iterable. [...]
inherited
toSet() Set<HtmlDocument>
Creates a Set containing the same elements as this iterable. [...]
inherited
toString() String
Returns a string representation of this object.
inherited
trigger(String type, {dynamic data}) → void
Trigger an event of given type on all matched elements, with given [...]
inherited
triggerEvent(QueryEvent event) → void
Trigger the given event on all matched elements, with given data if [...]
inherited
triggerHandler(String type, {dynamic data}) → void
Trigger an event of given type on the first (if any) matched element, [...]
inherited
where(bool test(HtmlDocument element)) Iterable<HtmlDocument>
Returns a new lazy Iterable with all elements that satisfy the predicate test. [...]
inherited
whereType<T>() Iterable<T>
Returns a new lazy Iterable with all elements that have type T. [...]
inherited

Operators

operator +(List<HtmlDocument> other) List<HtmlDocument>
Returns the concatenation of this list and other. [...]
inherited
operator ==(Object other) bool
The equality operator. [...]
inherited
operator [](int index) HtmlDocument
Returns the object at the given index in the list or throws a RangeError if index is out of bounds.
inherited
operator []=(int index, HtmlDocument value) → void
Sets the value at the given index in the list to value or throws a RangeError if index is out of bounds.
inherited