accessibilityRegions method

Class: CheckSettingsPlatform: NightwatchLanguage: JavaScript SDK:

Define multiple accessibility regions and their types.

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

Syntax

eyes.check(Target.window().accessibilityRegions(regions_arr1));

eyes.check(Target.window().accessibilityRegions(type, regions_arr2));

Parameters

regions_arr1

Type:

(
  | {
      region: RegionPlain | Element | Selector;
      type?:
        | AccessibilityRegionType
        | "BoldText"
        | "GraphicalObject"
        | "IgnoreContrast"
        | "LargeText"
        | "RegularText";
    }
  | RegionPlain
  | Element
  | Selector
)[];

An array of literal objects that specify the accessibility regionions to be analyzed, and their accessibility types.

Type definitions

RegionPlain: Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
Element: Used to identify an HTML element defined as |{ELEMENT:string}|{'element-6066-11e4-a52e-4f735466cecf':string}|import('nightwatch').NightwatchTypedCallbackResult.
Selector: Used to identify an HTML element defined as |{locateStrategy:import('nightwatch').LocateStrategy;selector:'string'}|string|{selector:string;type:string}.

type

Type:AccessibilityRegionType

The accessibility type of the region to apply to all of the regions.

regions_arr2

Type:

(RegionPlain|Element|Selector)[]

One or more objects that define accessibility regions to be analyzed. The regions can be defined in various ways depending on the type passed.

Type definitions

RegionPlain: Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
Element: Used to identify an HTML element defined as |{ELEMENT:string}|{'element-6066-11e4-a52e-4f735466cecf':string}|import('nightwatch').NightwatchTypedCallbackResult.
Selector: Used to identify an HTML element defined as |{locateStrategy:import('nightwatch').LocateStrategy;selector:'string'}|string|{selector:string;type:string}.

Return value

Type: CheckSettings