askui 0.20.1 → 0.20.3

package/dist/cjs/execution/dsl.js

@@ -1,4 +1,9 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-use-before-define */
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable max-classes-per-file */
+/* eslint-disable max-len */
+// Autogenerated from typescript.template file
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiCommands = exports.Getter = exports.FluentFiltersOrRelationsGetter = exports.FluentFiltersGetter = exports.ExecGetter = exports.FluentCommand = exports.FluentFiltersOrRelationsCondition = exports.FluentFiltersCondition = exports.FluentFiltersOrRelations = exports.FluentFilters = exports.Exec = exports.Separators = void 0;
 var Separators;
@@ -215,6 +220,7 @@ class FluentFilters extends FluentBase {
         return new FluentFiltersOrRelations(this);
     }
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelations}
      */
@@ -243,6 +249,8 @@ class FluentFilters extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelations}
      */
     text(text) {
@@ -275,9 +283,9 @@ class FluentFilters extends FluentBase {
         return new FluentFiltersOrRelations(this);
     }
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     * Filters for a 'custom element', that is a UI element that is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
      *
-     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -286,7 +294,7 @@ 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'
@@ -302,13 +310,13 @@ 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*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
      * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
-     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
+     *     - The color compare style. `'edges'` compares only edges, `'greyscale'` compares the brightness of each pixel whereas `'RGB'` compares all three colors (red, green, blue). Defaults to `'grayscale'`.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -323,7 +331,13 @@ class FluentFilters extends FluentBase {
         return new FluentFiltersOrRelations(this);
     }
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -411,12 +425,13 @@ class FluentFilters extends FluentBase {
      * 'other' === withText('text') => false
      *
      * // optional parameter: similarity_score
-     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
-     * '978-0-201-00650-6' == withText('978-0-201-00650', 90) => true with 93.75 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00", 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelations}
      */
@@ -443,7 +458,7 @@ 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)
      *
      *
      *
@@ -475,7 +490,7 @@ 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)
      *
      *
      *
@@ -523,10 +538,10 @@ 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 generalselector `element()` as shown in the examples below.
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -699,150 +714,304 @@ class FluentFiltersOrRelations extends FluentFilters {
     /**
      * Filters for an element right of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **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 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 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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    rightOf(optionalIndex = 0, intersecting = 'bbox') {
+    rightOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' right';
         this._textStr += ' of';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFilters(this);
     }
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    leftOf(optionalIndex = 0, intersecting = 'bbox') {
+    leftOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' left';
         this._textStr += ' of';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFilters(this);
     }
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    below(optionalIndex = 0, intersecting = 'bbox') {
+    below(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' below';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFilters(this);
     }
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
-     *
-     * **Examples:**
-     * ```typescript
-     * --------------
-     * |   text1    |
-     * --------------
-     * --------------
-     * |   text0    |
-     * --------------
-     * --------------
-     * |   button   |
-     * --------------
-     *
-     * // Returns text0 because text0 is the first element above button
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
+     *
+     * **Examples:**
+     * ```typescript
+     * ------------
+     * |  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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    above(optionalIndex = 0, intersecting = 'bbox') {
+    above(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' above';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFilters(this);
     }
@@ -1049,6 +1218,7 @@ class FluentFiltersCondition extends FluentBase {
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
@@ -1077,6 +1247,8 @@ class FluentFiltersCondition extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     text(text) {
@@ -1109,9 +1281,9 @@ class FluentFiltersCondition extends FluentBase {
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     * Filters for a 'custom element', that is a UI element that is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
      *
-     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -1120,7 +1292,7 @@ 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'
@@ -1136,13 +1308,13 @@ 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*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
      * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
-     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
+     *     - The color compare style. `'edges'` compares only edges, `'greyscale'` compares the brightness of each pixel whereas `'RGB'` compares all three colors (red, green, blue). Defaults to `'grayscale'`.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -1157,7 +1329,13 @@ class FluentFiltersCondition extends FluentBase {
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -1245,12 +1423,13 @@ class FluentFiltersCondition extends FluentBase {
      * 'other' === withText('text') => false
      *
      * // optional parameter: similarity_score
-     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
-     * '978-0-201-00650-6' == withText('978-0-201-00650', 90) => true with 93.75 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00", 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
@@ -1277,7 +1456,7 @@ 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)
      *
      *
      *
@@ -1309,7 +1488,7 @@ 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)
      *
      *
      *
@@ -1357,10 +1536,10 @@ 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 generalselector `element()` as shown in the examples below.
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -1533,150 +1712,304 @@ class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
     /**
      * Filters for an element right of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **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()
      *
-     * // 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_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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    rightOf(optionalIndex = 0, intersecting = 'bbox') {
+    rightOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' right';
         this._textStr += ' of';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersCondition(this);
     }
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    leftOf(optionalIndex = 0, intersecting = 'bbox') {
+    leftOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' left';
         this._textStr += ' of';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersCondition(this);
     }
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    below(optionalIndex = 0, intersecting = 'bbox') {
+    below(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' below';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersCondition(this);
     }
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
-     *
-     * **Examples:**
-     * ```typescript
-     * --------------
-     * |   text1    |
-     * --------------
-     * --------------
-     * |   text0    |
-     * --------------
-     * --------------
-     * |   button   |
-     * --------------
-     *
-     * // Returns text0 because text0 is the first element above button
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
+     *
+     * **Examples:**
+     * ```typescript
+     * ------------
+     * |  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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    above(optionalIndex = 0, intersecting = 'bbox') {
+    above(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' above';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersCondition(this);
     }
@@ -1805,7 +2138,7 @@ class FluentCommand extends FluentBase {
         super(undefined);
     }
     /**
-     * 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.
      *
@@ -1852,7 +2185,7 @@ 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)
      *
      *
      *
@@ -1900,7 +2233,7 @@ 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.
@@ -2004,7 +2337,7 @@ 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.
@@ -2083,7 +2416,7 @@ class FluentCommand extends FluentBase {
         return new Exec(this);
     }
     /**
-     * Executes a shell command on the device your UiController is connected to.
+     * Executes a shell command on the device your AskUI Controller is connected to.
      *
      * **Example:**
      * ```typescript
@@ -2185,7 +2518,7 @@ 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}
      */
@@ -2377,7 +2710,7 @@ 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
@@ -2564,6 +2897,7 @@ class FluentFiltersGetter extends FluentBase {
         return new FluentFiltersOrRelationsGetter(this);
     }
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
@@ -2592,6 +2926,8 @@ class FluentFiltersGetter extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelationsGetter}
      */
     text(text) {
@@ -2624,9 +2960,9 @@ class FluentFiltersGetter extends FluentBase {
         return new FluentFiltersOrRelationsGetter(this);
     }
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     * Filters for a 'custom element', that is a UI element that is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
      *
-     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -2635,7 +2971,7 @@ 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'
@@ -2651,13 +2987,13 @@ 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*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
      * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
-     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
+     *     - The color compare style. `'edges'` compares only edges, `'greyscale'` compares the brightness of each pixel whereas `'RGB'` compares all three colors (red, green, blue). Defaults to `'grayscale'`.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -2672,7 +3008,13 @@ class FluentFiltersGetter extends FluentBase {
         return new FluentFiltersOrRelationsGetter(this);
     }
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -2760,12 +3102,13 @@ class FluentFiltersGetter extends FluentBase {
      * 'other' === withText('text') => false
      *
      * // optional parameter: similarity_score
-     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
-     * '978-0-201-00650-6' == withText('978-0-201-00650', 90) => true with 93.75 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00", 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
@@ -2792,7 +3135,7 @@ 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)
      *
      *
      *
@@ -2824,7 +3167,7 @@ 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)
      *
      *
      *
@@ -2872,10 +3215,10 @@ 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 generalselector `element()` as shown in the examples below.
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -3048,150 +3391,304 @@ class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
     /**
      * Filters for an element right of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    rightOf(optionalIndex = 0, intersecting = 'bbox') {
+    rightOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' right';
         this._textStr += ' of';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersGetter(this);
     }
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    leftOf(optionalIndex = 0, intersecting = 'bbox') {
+    leftOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' left';
         this._textStr += ' of';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersGetter(this);
     }
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    below(optionalIndex = 0, intersecting = 'bbox') {
+    below(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' below';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersGetter(this);
     }
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
-     *
-     * **Examples:**
-     * ```typescript
-     * --------------
-     * |   text1    |
-     * --------------
-     * --------------
-     * |   text0    |
-     * --------------
-     * --------------
-     * |   button   |
-     * --------------
-     *
-     * // Returns text0 because text0 is the first element above button
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
+     *
+     * **Examples:**
+     * ```typescript
+     * ------------
+     * |  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)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    above(optionalIndex = 0, intersecting = 'bbox') {
+    above(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' above';
-        if (intersecting !== undefined) {
-            this._textStr += ` intersecting ${intersecting}`;
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
         }
         return new FluentFiltersGetter(this);
     }
@@ -3295,6 +3792,7 @@ class Getter extends FluentCommand {
      * ]
      * ```
      *
+     * ```typescript
      * // *************************************************** //
      * // Examples on how to work with the returned elements  //
      * // *************************************************** //
@@ -3378,6 +3876,7 @@ class Getter extends FluentCommand {
      *         xmax: 1178.8204241071428,
      *         ymax: 180.83512834821428
      *      },
+     *   },
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'search',
@@ -3387,8 +3886,8 @@ class Getter extends FluentCommand {
      *         xmax: 450.6304241071428,
      *         ymax: 950.47812834821428
      *      },
-     *      ... 381 more items
-     *    }
+     *    },
+     *   ... 381 more items
      *  ]
      * ```
      *