askui 0.20.2 → 0.20.4

package/dist/esm/execution/dsl.d.ts

@@ -180,7 +180,7 @@ export declare class FluentFilters extends FluentBase {
      *     .customElement({
      *         customImage: './logo.png', // required
      *         name: 'myLogo', // optional
-     *         threshold: 0.9, // optional, defaults to 0.9
+     *         threshold: 0.5, // optional, defaults to 0.5
      *         stopThreshold: 0.9, // optional, defaults to 0.9
      *         rotationDegreePerStep: 0, // optional, defaults to 0
      *         imageCompareFormat: 'grayscale', // optional, defaults to 'grayscale'
@@ -196,7 +196,7 @@ export declare class FluentFilters extends FluentBase {
      * - **name** (*`string`, optional*):
      *     - A unique name that can be used for filtering for the custom element. If not given, any text inside the custom image will be detected via OCR.
      * - **threshold** (*`number`, optional*):
-     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.5`.
      * - **stopThreshold** (*`number`, optional*):
      *     - A threshold for when to stop searching for UI elements similar to the custom element. As soon as UI elements have been found that are at least as similar as the `stopThreshold`, the search is going to stop. After that elements are filtered using the `threshold`. Because of that the `stopThreshold` should be greater than or equal to `threshold`. It is primarily to be used as a speed improvement (by lowering the value). Takes values between `0.0` and `1.0`. Defaults to `0.9`.
      * - **rotationDegreePerStep** (*`number`, optional*):
@@ -312,7 +312,7 @@ export declare class FluentFilters extends FluentBase {
      * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/withtextregex.gif)
+     * ![](https://docs.askui.com/img/gif/withTextRegex.gif)
      *
      *
      *
@@ -337,7 +337,7 @@ export declare class FluentFilters extends FluentBase {
      * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/withexacttext.gif)
+     * ![](https://docs.askui.com/img/gif/withExactText.gif)
      *
      *
      *
@@ -373,7 +373,7 @@ export declare class FluentFilters extends FluentBase {
      * **Important: _Matching only returns the best matching element when you use it with `get()`_**
      *
      * A bit of playing around to find a matching description is sometimes needed:
-     * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
+     * For example, `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally, the more detail the better.
      *
      * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
@@ -539,17 +539,46 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * **Examples:**
      * ```typescript
-     * --------------  --------------  --------------
-     * |  leftEl    |  |  rightEl0  |  |  rightEl1  |
-     * --------------  --------------  --------------
+     * ---------- ---------                     ---------
+     * | button | | text0 |                     | text3 |
+     * ---------- --------- ---------           ---------
+     *                      | text1 | ---------
+     *                      --------- | text2 |
+     *                                ---------
      *
-     * // Returns rightEl0 because rightEl0 is the first element right of leftEl
-     * ...rightEl().rightOf().leftEl()
-     * ...rightEl().rightOf(0).leftEl()
-     * // Returns rightEl1 because rightEl1 is the second element right of leftEl
-     * ...rightEl().rightOf(1).leftEl()
-     * // Returns no element because leftEl is left of rightEl
-     * ...leftEl().rightOf().rightEl()
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().rightOf(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().rightOf(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().rightOf(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element rightOf button
+     * ...text().rightOf().button()
+     * ...text().rightOf(0).button()
+     * ...text().rightOf(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // horizontal line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().rightOf(1, 'element_center_line').button()
+     *
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area rightOf the y-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().rightOf(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element rightOf button
+     * ...text().rightOf(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is rightOf the texts
+     * ...button().rightOf().text()
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
@@ -571,17 +600,46 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * **Examples:**
      * ```typescript
-     * --------------  --------------  --------------
-     * |  leftEl1   |  |  leftEl0   |  |  rightEl   |
-     * --------------  --------------  --------------
+     * ---------                   --------- ----------
+     * | text3 |                   | text0 | | button |
+     * ---------         --------- --------- ----------
+     *         --------- | text1 |
+     *         | text2 | ---------
+     *         ---------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().leftOf(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().leftOf(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().leftOf(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element leftOf button
+     * ...text().leftOf().button()
+     * ...text().leftOf(0).button()
+     * ...text().leftOf(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // horizontal line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().leftOf(1, 'element_center_line').button()
+     *
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area leftOf the y-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().leftOf(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element leftOf button
+     * ...text().leftOf(2, 'display_edge_area').button()
      *
-     * // Returns leftEl0 because leftEl0 is the first element left of rightEl
-     * ...leftEl().leftOf().rightEl()
-     * ...leftEl().leftOf(0).rightEl()
-     * // Returns leftEl1 because leftEl1 is the second element left of rightEl
-     * ...leftEl().leftOf(1).rightEl()
-     * // Returns no element because rightEl is left of leftEl
-     * ...rightEl().leftOf().leftEl()
+     * // Returns no element because button is rightOf the texts
+     * ...button().leftOf().text()
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
@@ -603,22 +661,54 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * **Examples:**
      * ```typescript
-     * --------------
-     * |    text    |
-     * --------------
-     * --------------
-     * |   button0  |
-     * --------------
-     * --------------
-     * |   button1  |
-     * --------------
-     *
+     * ------------
+     * |   text   |
+     * ------------
+     * ------------
+     * |  button0 |
+     * ------------
+     *          -----------
+     *          | button1 |
+     *          -----------
+     *             -----------
+     *             | button2 |
+     *             -----------
+     * ------------
+     * |  button3 |
+     * ------------
+     *
+     * // General explanation for element_center_line
+     * // This will find button0 and button3
+     * ...button().below(..., 'element_center_line').text()
+     *
+     * // General explanation for element_edge_area
+     * // This will find button0, button1 and button3
+     * ...button().below(..., 'element_edge_area').text()
+     *
+     * // General explanation and display_edge_area
+     * // This will find button0, button1, button2 and button3
+     * ...button().below(..., 'display_edge_area').text()
+     *
+     * // More examples:
      * // Returns button0 because button0 is the first button below text
      * ...button().below().text()
      * ...button().below(0).text()
-     * // Returns button1 because button1  is the second button below text
-     * ...button().below(1).text()
-     * // Returns no element because text is above button
+     * ...button().below(0, 'element_edge_area').text()
+     *
+     * // Returns button3 because it is the second button touched by the
+     * // vertical line from the center of text
+     * // Notice: button1 is not touched
+     * ...button().below(1, 'element_center_line').text()
+     *
+     * // Returns button3 because it is the third button touched by the
+     * // vertical area below the x-axis of text
+     * // Notice: button2 is not touched!
+     * ...button().below(2, 'element_edge_area').text()
+     *
+     * // Returns button2 because it is the third element below text
+     * ...button().below(2, 'display_edge_area').text()
+     *
+     * // Returns no element because text is above the buttons
      * ...text().below().button()
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
@@ -641,22 +731,54 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * **Examples:**
      * ```typescript
-     * --------------
-     * |   text1    |
-     * --------------
-     * --------------
-     * |   text0    |
-     * --------------
-     * --------------
-     * |   button   |
-     * --------------
-     *
-     * // Returns text0 because text0 is the first element above button
+     * ------------
+     * |  text3   |
+     * ------------
+     *             ------------
+     *             |  text2   |
+     *             ------------
+     *     ------------
+     *     |  text1   |
+     *     ------------
+     * ------------
+     * |  text0   |
+     * ------------
+     * ------------
+     * |  button  |
+     * ------------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().above(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().above(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().above(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element above button
      * ...text().above().button()
      * ...text().above(0).button()
-     * // Returns text1 because text1 is the second element above button
-     * ...text().above(1).button()
-     * // Returns no element because button is below text
+     * ...text().above(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // vertical line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().above(1, 'element_center_line').button()
+     *
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area above the x-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().above(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element above button
+     * ...text().above(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is below the texts
      * ...button().above().text()
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
@@ -868,7 +990,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      *     .customElement({
      *         customImage: './logo.png', // required
      *         name: 'myLogo', // optional
-     *         threshold: 0.9, // optional, defaults to 0.9
+     *         threshold: 0.5, // optional, defaults to 0.5
      *         stopThreshold: 0.9, // optional, defaults to 0.9
      *         rotationDegreePerStep: 0, // optional, defaults to 0
      *         imageCompareFormat: 'grayscale', // optional, defaults to 'grayscale'
@@ -884,7 +1006,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      * - **name** (*`string`, optional*):
      *     - A unique name that can be used for filtering for the custom element. If not given, any text inside the custom image will be detected via OCR.
      * - **threshold** (*`number`, optional*):
-     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.5`.
      * - **stopThreshold** (*`number`, optional*):
      *     - A threshold for when to stop searching for UI elements similar to the custom element. As soon as UI elements have been found that are at least as similar as the `stopThreshold`, the search is going to stop. After that elements are filtered using the `threshold`. Because of that the `stopThreshold` should be greater than or equal to `threshold`. It is primarily to be used as a speed improvement (by lowering the value). Takes values between `0.0` and `1.0`. Defaults to `0.9`.
      * - **rotationDegreePerStep** (*`number`, optional*):
@@ -1000,7 +1122,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/withtextregex.gif)
+     * ![](https://docs.askui.com/img/gif/withTextRegex.gif)
      *
      *
      *
@@ -1025,7 +1147,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/withexacttext.gif)
+     * ![](https://docs.askui.com/img/gif/withExactText.gif)
      *
      *
      *
@@ -1061,7 +1183,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      * **Important: _Matching only returns the best matching element when you use it with `get()`_**
      *
      * A bit of playing around to find a matching description is sometimes needed:
-     * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
+     * For example, `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally, the more detail the better.
      *
      * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
@@ -1227,17 +1349,46 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * **Examples:**
      * ```typescript
-     * --------------  --------------  --------------
-     * |  leftEl    |  |  rightEl0  |  |  rightEl1  |
-     * --------------  --------------  --------------
+     * ---------- ---------                     ---------
+     * | button | | text0 |                     | text3 |
+     * ---------- --------- ---------           ---------
+     *                      | text1 | ---------
+     *                      --------- | text2 |
+     *                                ---------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().rightOf(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().rightOf(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().rightOf(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element rightOf button
+     * ...text().rightOf().button()
+     * ...text().rightOf(0).button()
+     * ...text().rightOf(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // horizontal line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().rightOf(1, 'element_center_line').button()
      *
-     * // Returns rightEl0 because rightEl0 is the first element right of leftEl
-     * ...rightEl().rightOf().leftEl()
-     * ...rightEl().rightOf(0).leftEl()
-     * // Returns rightEl1 because rightEl1 is the second element right of leftEl
-     * ...rightEl().rightOf(1).leftEl()
-     * // Returns no element because leftEl is left of rightEl
-     * ...leftEl().rightOf().rightEl()
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area rightOf the y-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().rightOf(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element rightOf button
+     * ...text().rightOf(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is rightOf the texts
+     * ...button().rightOf().text()
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
@@ -1259,17 +1410,46 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * **Examples:**
      * ```typescript
-     * --------------  --------------  --------------
-     * |  leftEl1   |  |  leftEl0   |  |  rightEl   |
-     * --------------  --------------  --------------
+     * ---------                   --------- ----------
+     * | text3 |                   | text0 | | button |
+     * ---------         --------- --------- ----------
+     *         --------- | text1 |
+     *         | text2 | ---------
+     *         ---------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().leftOf(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().leftOf(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().leftOf(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element leftOf button
+     * ...text().leftOf().button()
+     * ...text().leftOf(0).button()
+     * ...text().leftOf(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // horizontal line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().leftOf(1, 'element_center_line').button()
      *
-     * // Returns leftEl0 because leftEl0 is the first element left of rightEl
-     * ...leftEl().leftOf().rightEl()
-     * ...leftEl().leftOf(0).rightEl()
-     * // Returns leftEl1 because leftEl1 is the second element left of rightEl
-     * ...leftEl().leftOf(1).rightEl()
-     * // Returns no element because rightEl is left of leftEl
-     * ...rightEl().leftOf().leftEl()
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area leftOf the y-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().leftOf(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element leftOf button
+     * ...text().leftOf(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is rightOf the texts
+     * ...button().leftOf().text()
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
@@ -1291,22 +1471,54 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * **Examples:**
      * ```typescript
-     * --------------
-     * |    text    |
-     * --------------
-     * --------------
-     * |   button0  |
-     * --------------
-     * --------------
-     * |   button1  |
-     * --------------
-     *
+     * ------------
+     * |   text   |
+     * ------------
+     * ------------
+     * |  button0 |
+     * ------------
+     *          -----------
+     *          | button1 |
+     *          -----------
+     *             -----------
+     *             | button2 |
+     *             -----------
+     * ------------
+     * |  button3 |
+     * ------------
+     *
+     * // General explanation for element_center_line
+     * // This will find button0 and button3
+     * ...button().below(..., 'element_center_line').text()
+     *
+     * // General explanation for element_edge_area
+     * // This will find button0, button1 and button3
+     * ...button().below(..., 'element_edge_area').text()
+     *
+     * // General explanation and display_edge_area
+     * // This will find button0, button1, button2 and button3
+     * ...button().below(..., 'display_edge_area').text()
+     *
+     * // More examples:
      * // Returns button0 because button0 is the first button below text
      * ...button().below().text()
      * ...button().below(0).text()
-     * // Returns button1 because button1  is the second button below text
-     * ...button().below(1).text()
-     * // Returns no element because text is above button
+     * ...button().below(0, 'element_edge_area').text()
+     *
+     * // Returns button3 because it is the second button touched by the
+     * // vertical line from the center of text
+     * // Notice: button1 is not touched
+     * ...button().below(1, 'element_center_line').text()
+     *
+     * // Returns button3 because it is the third button touched by the
+     * // vertical area below the x-axis of text
+     * // Notice: button2 is not touched!
+     * ...button().below(2, 'element_edge_area').text()
+     *
+     * // Returns button2 because it is the third element below text
+     * ...button().below(2, 'display_edge_area').text()
+     *
+     * // Returns no element because text is above the buttons
      * ...text().below().button()
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
@@ -1329,22 +1541,54 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * **Examples:**
      * ```typescript
-     * --------------
-     * |   text1    |
-     * --------------
-     * --------------
-     * |   text0    |
-     * --------------
-     * --------------
-     * |   button   |
-     * --------------
-     *
-     * // Returns text0 because text0 is the first element above button
+     * ------------
+     * |  text3   |
+     * ------------
+     *             ------------
+     *             |  text2   |
+     *             ------------
+     *     ------------
+     *     |  text1   |
+     *     ------------
+     * ------------
+     * |  text0   |
+     * ------------
+     * ------------
+     * |  button  |
+     * ------------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().above(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().above(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().above(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element above button
      * ...text().above().button()
      * ...text().above(0).button()
-     * // Returns text1 because text1 is the second element above button
-     * ...text().above(1).button()
-     * // Returns no element because button is below text
+     * ...text().above(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // vertical line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().above(1, 'element_center_line').button()
+     *
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area above the x-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().above(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element above button
+     * ...text().above(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is below the texts
      * ...button().above().text()
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
@@ -1458,7 +1702,7 @@ declare class ExecCondition extends Exec {
 export declare abstract class FluentCommand extends FluentBase {
     constructor();
     /**
-     * Expects a condition, e.g., `exists()` or `notExits()`.
+     * Expects a condition, for example, `exists()` or `notExits()`.
      *
      * Use the structure `expect().<your filter>.(exists()|notExists())` as shown in the examples below.
      *
@@ -1496,7 +1740,7 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.moveMouseTo().text().withText('Grinning_Face').exec()
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/movemouseto.gif)
+     * ![](https://docs.askui.com/img/gif/moveMouseTo.gif)
      *
      *
      *
@@ -1532,7 +1776,7 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.scrollInside(0,-500).text().withText('Bottom sheet').exec();
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/scrollinside.gif)
+     * ![](https://docs.askui.com/img/gif/scrollInside.gif)
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
@@ -1604,7 +1848,7 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.moveMouseRelatively(0, 50).exec();
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/movemouserelatively.gif)
+     * ![](https://docs.askui.com/img/gif/moveMouseRelatively.gif)
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
@@ -1669,11 +1913,12 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.execOnShell("chrome").exec();
      * ```
      *
-     * @param {string} shell_command - A shell command which is executed.
+     * @param {string} shellCommand - A shell command which is executed.
+     * @param {number} [timeoutInMilliseconds=1] - A timeout in milliseconds.
      *
      * @return {Exec}
      */
-    execOnShell(shell_command: string): Exec;
+    execOnShell(shellCommand: string, timeoutInMilliseconds?: number): Exec;
     /**
      * Clicks with left mouse key.
      *
@@ -1735,7 +1980,7 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.mouseDoubleLeftClick().exec();
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/mousedoubleleftclick.gif)
+     * ![](https://docs.askui.com/img/gif/mouseDoubleLeftClick.gif)
      *
      * @return {Exec}
      */
@@ -1877,7 +2122,7 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.pressAndroidTwoKey('volume_down', 'power').exec();
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/pressAndroidTwoKey.gif)
+     * ![](https://docs.askui.com/img/gif/pressAndroidTwoKeys.gif)
      *
      * @param {ANDROID_KEY} first_key - A Android key
      * @param {ANDROID_KEY} second_key - A Android key
@@ -2059,7 +2304,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      *     .customElement({
      *         customImage: './logo.png', // required
      *         name: 'myLogo', // optional
-     *         threshold: 0.9, // optional, defaults to 0.9
+     *         threshold: 0.5, // optional, defaults to 0.5
      *         stopThreshold: 0.9, // optional, defaults to 0.9
      *         rotationDegreePerStep: 0, // optional, defaults to 0
      *         imageCompareFormat: 'grayscale', // optional, defaults to 'grayscale'
@@ -2075,7 +2320,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      * - **name** (*`string`, optional*):
      *     - A unique name that can be used for filtering for the custom element. If not given, any text inside the custom image will be detected via OCR.
      * - **threshold** (*`number`, optional*):
-     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.5`.
      * - **stopThreshold** (*`number`, optional*):
      *     - A threshold for when to stop searching for UI elements similar to the custom element. As soon as UI elements have been found that are at least as similar as the `stopThreshold`, the search is going to stop. After that elements are filtered using the `threshold`. Because of that the `stopThreshold` should be greater than or equal to `threshold`. It is primarily to be used as a speed improvement (by lowering the value). Takes values between `0.0` and `1.0`. Defaults to `0.9`.
      * - **rotationDegreePerStep** (*`number`, optional*):
@@ -2191,7 +2436,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/withtextregex.gif)
+     * ![](https://docs.askui.com/img/gif/withTextRegex.gif)
      *
      *
      *
@@ -2216,7 +2461,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
-     * ![](https://docs.askui.com/img/gif/withexacttext.gif)
+     * ![](https://docs.askui.com/img/gif/withExactText.gif)
      *
      *
      *
@@ -2252,7 +2497,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      * **Important: _Matching only returns the best matching element when you use it with `get()`_**
      *
      * A bit of playing around to find a matching description is sometimes needed:
-     * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
+     * For example, `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally, the more detail the better.
      *
      * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
@@ -2418,17 +2663,46 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * **Examples:**
      * ```typescript
-     * --------------  --------------  --------------
-     * |  leftEl    |  |  rightEl0  |  |  rightEl1  |
-     * --------------  --------------  --------------
+     * ---------- ---------                     ---------
+     * | button | | text0 |                     | text3 |
+     * ---------- --------- ---------           ---------
+     *                      | text1 | ---------
+     *                      --------- | text2 |
+     *                                ---------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().rightOf(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().rightOf(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().rightOf(..., 'display_edge_area').button()
      *
-     * // Returns rightEl0 because rightEl0 is the first element right of leftEl
-     * ...rightEl().rightOf().leftEl()
-     * ...rightEl().rightOf(0).leftEl()
-     * // Returns rightEl1 because rightEl1 is the second element right of leftEl
-     * ...rightEl().rightOf(1).leftEl()
-     * // Returns no element because leftEl is left of rightEl
-     * ...leftEl().rightOf().rightEl()
+     * // More examples:
+     * // Returns text0 because it is the first element rightOf button
+     * ...text().rightOf().button()
+     * ...text().rightOf(0).button()
+     * ...text().rightOf(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // horizontal line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().rightOf(1, 'element_center_line').button()
+     *
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area rightOf the y-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().rightOf(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element rightOf button
+     * ...text().rightOf(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is rightOf the texts
+     * ...button().rightOf().text()
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
@@ -2450,17 +2724,46 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * **Examples:**
      * ```typescript
-     * --------------  --------------  --------------
-     * |  leftEl1   |  |  leftEl0   |  |  rightEl   |
-     * --------------  --------------  --------------
+     * ---------                   --------- ----------
+     * | text3 |                   | text0 | | button |
+     * ---------         --------- --------- ----------
+     *         --------- | text1 |
+     *         | text2 | ---------
+     *         ---------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().leftOf(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().leftOf(..., 'element_edge_area').button()
      *
-     * // Returns leftEl0 because leftEl0 is the first element left of rightEl
-     * ...leftEl().leftOf().rightEl()
-     * ...leftEl().leftOf(0).rightEl()
-     * // Returns leftEl1 because leftEl1 is the second element left of rightEl
-     * ...leftEl().leftOf(1).rightEl()
-     * // Returns no element because rightEl is left of leftEl
-     * ...rightEl().leftOf().leftEl()
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().leftOf(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element leftOf button
+     * ...text().leftOf().button()
+     * ...text().leftOf(0).button()
+     * ...text().leftOf(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // horizontal line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().leftOf(1, 'element_center_line').button()
+     *
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area leftOf the y-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().leftOf(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element leftOf button
+     * ...text().leftOf(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is rightOf the texts
+     * ...button().leftOf().text()
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
@@ -2482,22 +2785,54 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * **Examples:**
      * ```typescript
-     * --------------
-     * |    text    |
-     * --------------
-     * --------------
-     * |   button0  |
-     * --------------
-     * --------------
-     * |   button1  |
-     * --------------
-     *
+     * ------------
+     * |   text   |
+     * ------------
+     * ------------
+     * |  button0 |
+     * ------------
+     *          -----------
+     *          | button1 |
+     *          -----------
+     *             -----------
+     *             | button2 |
+     *             -----------
+     * ------------
+     * |  button3 |
+     * ------------
+     *
+     * // General explanation for element_center_line
+     * // This will find button0 and button3
+     * ...button().below(..., 'element_center_line').text()
+     *
+     * // General explanation for element_edge_area
+     * // This will find button0, button1 and button3
+     * ...button().below(..., 'element_edge_area').text()
+     *
+     * // General explanation and display_edge_area
+     * // This will find button0, button1, button2 and button3
+     * ...button().below(..., 'display_edge_area').text()
+     *
+     * // More examples:
      * // Returns button0 because button0 is the first button below text
      * ...button().below().text()
      * ...button().below(0).text()
-     * // Returns button1 because button1  is the second button below text
-     * ...button().below(1).text()
-     * // Returns no element because text is above button
+     * ...button().below(0, 'element_edge_area').text()
+     *
+     * // Returns button3 because it is the second button touched by the
+     * // vertical line from the center of text
+     * // Notice: button1 is not touched
+     * ...button().below(1, 'element_center_line').text()
+     *
+     * // Returns button3 because it is the third button touched by the
+     * // vertical area below the x-axis of text
+     * // Notice: button2 is not touched!
+     * ...button().below(2, 'element_edge_area').text()
+     *
+     * // Returns button2 because it is the third element below text
+     * ...button().below(2, 'display_edge_area').text()
+     *
+     * // Returns no element because text is above the buttons
      * ...text().below().button()
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
@@ -2520,22 +2855,54 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * **Examples:**
      * ```typescript
-     * --------------
-     * |   text1    |
-     * --------------
-     * --------------
-     * |   text0    |
-     * --------------
-     * --------------
-     * |   button   |
-     * --------------
-     *
-     * // Returns text0 because text0 is the first element above button
+     * ------------
+     * |  text3   |
+     * ------------
+     *             ------------
+     *             |  text2   |
+     *             ------------
+     *     ------------
+     *     |  text1   |
+     *     ------------
+     * ------------
+     * |  text0   |
+     * ------------
+     * ------------
+     * |  button  |
+     * ------------
+     *
+     * // General explanation for element_center_line
+     * // This will find text0 and text3
+     * ...text().above(..., 'element_center_line').button()
+     *
+     * // General explanation for element_edge_area
+     * // This will find text0, text1 and text3
+     * ...text().above(..., 'element_edge_area').button()
+     *
+     * // General explanation and display_edge_area
+     * // This will find text0, text1, text2 and text3
+     * ...text().above(..., 'display_edge_area').button()
+     *
+     * // More examples:
+     * // Returns text0 because it is the first element above button
      * ...text().above().button()
      * ...text().above(0).button()
-     * // Returns text1 because text1 is the second element above button
-     * ...text().above(1).button()
-     * // Returns no element because button is below text
+     * ...text().above(0, 'element_edge_area').button()
+     *
+     * // Returns text3 because it is the second text touched by the
+     * // vertical line from the center of button
+     * // Notice: text1 is not touched!
+     * ...text().above(1, 'element_center_line').button()
+     *
+     * // Returns text3 because it is the third text touched by the
+     * // vertical area above the x-axis of button
+     * // Notice: text2 is not touched!
+     * ...text().above(2, 'element_edge_area').button()
+     *
+     * // Returns text2 because it is the third element above button
+     * ...text().above(2, 'display_edge_area').button()
+     *
+     * // Returns no element because button is below the texts
      * ...button().above().text()
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)