The information in this topic may be out of date. The current SDK reference guide has moved here.

accessibilityRegions property

Class: CheckSettingsPlainPlatform: Selenium 4Language: JavaScript SDK:

Define multiple accessibility regions and their types.

For more information about the Contrast advisor feature see Contrast advisor.

Syntax

eyes.check({ accessibilityRegions: value });

Type:

(
  | {
      region: RegionPlain | WebElement | Selector;
      type?: AccessibilityRegionTypePlain;
    }
  | RegionPlain
  | WebElement
  | Selector
)[];

Type definitions

RegionPlain: Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
Selector: Used to identify an HTML element defined as |import('selenium-webdriver').Locator|{using:string;value:string}|string|{selector:string;type:string}.
AccessibilityRegionTypePlain: This type allows passing strings instead of enumerated values, for the list of enum values see AccessibilityRegionType.
RegionPlain: Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
Selector: Used to identify an HTML element defined as |import('selenium-webdriver').Locator|{using:string;value:string}|string|{selector:string;type:string}.