Class ScreenClass

ScreenClass class provides methods to access screen content of a systems main display

Hierarchy

ScreenClass

Index

Constructors

constructor

new ScreenClass(providerRegistry: ProviderRegistry, findHooks?: Map<FindInput, FindHookCallback[]>): ScreenClass
ScreenClass class constructor
Parameters
- providerRegistry: ProviderRegistry
  
  A ProviderRegistry used to access underlying implementations
- findHooks: Map<FindInput, FindHookCallback[]> = ...
  
  A Map of FindHookCallback methods assigned to a template image
Returns ScreenClass
- Defined in screen.class.ts:150

Properties

config

config: ScreenConfig = ...

Methods

capture

capture(fileName: string, fileFormat?: FileType, filePath?: string, fileNamePrefix?: string, fileNamePostfix?: string): Promise<string>
capture captures a screenshot of a systems main display
Parameters
- fileName: string
  
  Basename for the generated screenshot
- fileFormat: FileType = FileType.PNG
  
  The FileType for the generated screenshot
- filePath: string = ...
  
  The output path for the generated screenshot (Default: cwd)
- fileNamePrefix: string = ""
  
  Filename prefix for the generated screenshot (Default: empty)
- fileNamePostfix: string = ""
  
  Filename postfix for the generated screenshot (Default: empty)
Returns Promise<string>
- Defined in screen.class.ts:620

captureRegion

captureRegion(fileName: string, regionToCapture: Region | Promise<Region>, fileFormat?: FileType, filePath?: string, fileNamePrefix?: string, fileNamePostfix?: string): Promise<string>
captureRegion captures a screenshot of a region on the systems main display
Parameters
- fileName: string
  
  Basename for the generated screenshot
- regionToCapture: Region | Promise<Region>
  
  The region of the screen to capture in the screenshot
- fileFormat: FileType = FileType.PNG
  
  The FileType for the generated screenshot
- filePath: string = ...
  
  The output path for the generated screenshot (Default: cwd)
- fileNamePrefix: string = ""
  
  Filename prefix for the generated screenshot (Default: empty)
- fileNamePostfix: string = ""
  
  Filename postfix for the generated screenshot (Default: empty)
Returns Promise<string>
- Defined in screen.class.ts:674

colorAt

colorAt(point: Point | Promise<Point>): Promise<RGBA>
colorAt returns RGBA color values for a certain pixel at Point p
Parameters
- point: Point | Promise<Point>
  
  Location to query color information from
Returns Promise<RGBA>
- Defined in screen.class.ts:747

find

find<PROVIDER_DATA_TYPE>(searchInput: RegionResultFindInput | Promise<RegionResultFindInput>, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Region>
find will search for a single occurrence of a given search input on a systems main screen
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: RegionResultFindInput | Promise<RegionResultFindInput>
  
  A FindInput instance
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
  
  OptionalSearchParameters which are used to fine tune search region and / or match confidence
Returns Promise<Region>
- Defined in screen.class.ts:183
find<PROVIDER_DATA_TYPE>(searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Point>
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<Point>
- Defined in screen.class.ts:187
find<PROVIDER_DATA_TYPE>(searchInput: { by: { title: string | RegExp }; id: string; type: "window" } | Promise<{ by: { title: string | RegExp }; id: string; type: "window" }>, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Window>
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: { by: { title: string | RegExp }; id: string; type: "window" } | Promise<{ by: { title: string | RegExp }; id: string; type: "window" }>
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<Window>
- Defined in screen.class.ts:191
find<PROVIDER_DATA_TYPE>(searchInput: FindInput | Promise<FindInput>, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<FindResult>
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: FindInput | Promise<FindInput>
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<FindResult>
- Defined in screen.class.ts:195

findAll

findAll<PROVIDER_DATA_TYPE>(searchInput: RegionResultFindInput | Promise<RegionResultFindInput>, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Region[]>
findAll will search for every occurrence of a given search input on a systems main screen
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: RegionResultFindInput | Promise<RegionResultFindInput>
  
  A FindInput instance to search for
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
  
  OptionalSearchParameters which are used to fine tune search region and / or match confidence
Returns Promise<Region[]>
- Defined in screen.class.ts:334
findAll<PROVIDER_DATA_TYPE>(searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Point[]>
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<Point[]>
- Defined in screen.class.ts:338
findAll<PROVIDER_DATA_TYPE>(searchInput: { by: { title: string | RegExp }; id: string; type: "window" } | Promise<{ by: { title: string | RegExp }; id: string; type: "window" }>, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Window[]>
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: { by: { title: string | RegExp }; id: string; type: "window" } | Promise<{ by: { title: string | RegExp }; id: string; type: "window" }>
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<Window[]>
- Defined in screen.class.ts:342

grab

grab(): Promise<Image>
grab grabs screen content of a systems main display

Returns Promise<Image>
- Defined in screen.class.ts:655

grabRegion

grabRegion(regionToGrab: Region | Promise<Region>): Promise<Image>
grabRegion grabs screen content of a region on the systems main display
Parameters
- regionToGrab: Region | Promise<Region>
  
  The screen region to grab
Returns Promise<Image>
- Defined in screen.class.ts:721

height

height(): Promise<number>
height returns the main screen height This refers to the hardware resolution. Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher height in in actual pixels

Returns Promise<number>
- Defined in screen.class.ts:173

highlight

highlight(regionToHighlight: Region | Promise<Region>): Promise<Region>
highlight highlights a screen Region for a certain duration by overlaying it with an opaque highlight window
Parameters
- regionToHighlight: Region | Promise<Region>
  
  The Region to highlight
Returns Promise<Region>
- Defined in screen.class.ts:497

on

on(searchInput: { by: { title: string | RegExp }; id: string; type: "window" }, callback: WindowCallback): void
on registers a callback which is triggered once a certain searchInput image is found
Parameters
- searchInput: { by: { title: string | RegExp }; id: string; type: "window" }
  
  to trigger the callback on
  - by: { title: string | RegExp }
    - title: string | RegExp
  - id: string
  - type: "window"
- callback: WindowCallback
  
  The FindHookCallback function to trigger
Returns void
- Defined in screen.class.ts:589
on(searchInput: { by: { color: RGBA }; id: string; type: "color" }, callback: MatchResultCallback<Point>): void
Parameters
- searchInput: { by: { color: RGBA }; id: string; type: "color" }
  - by: { color: RGBA }
    - color: RGBA
  - id: string
  - type: "color"
- callback: MatchResultCallback<Point>
Returns void
- Defined in screen.class.ts:590
on(searchInput: RegionResultFindInput, callback: MatchResultCallback<Region>): void
Parameters
- searchInput: RegionResultFindInput
- callback: MatchResultCallback<Region>
Returns void
- Defined in screen.class.ts:594

waitFor

waitFor<PROVIDER_DATA_TYPE>(searchInput: RegionResultFindInput | Promise<RegionResultFindInput>, timeoutMs?: number, updateInterval?: number, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Region>
waitFor searches for a template image for a specified duration
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: RegionResultFindInput | Promise<RegionResultFindInput>
  
  Filename of the template image, relative to ScreenClass.config.resourceDirectory, or an Image
- Optional timeoutMs: number
  
  Timeout in milliseconds after which waitFor fails
- Optional updateInterval: number
  
  Update interval in milliseconds to retry search
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
  
  OptionalSearchParameters which are used to fine tune search region and / or match confidence
Returns Promise<Region>
- Defined in screen.class.ts:534
waitFor<PROVIDER_DATA_TYPE>(searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>, timeoutMs?: number, updateInterval?: number, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Point>
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>
- Optional timeoutMs: number
- Optional updateInterval: number
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<Point>
- Defined in screen.class.ts:540
waitFor<PROVIDER_DATA_TYPE>(searchInput: { by: { title: string | RegExp }; id: string; type: "window" } | Promise<{ by: { title: string | RegExp }; id: string; type: "window" }>, timeoutMs?: number, updateInterval?: number, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<Window>
Type Parameters
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: { by: { title: string | RegExp }; id: string; type: "window" } | Promise<{ by: { title: string | RegExp }; id: string; type: "window" }>
- Optional timeoutMs: number
- Optional updateInterval: number
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<Window>
- Defined in screen.class.ts:546

width

width(): Promise<number>
width returns the main screen width This refers to the hardware resolution. Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher width in in actual pixels

Returns Promise<number>
- Defined in screen.class.ts:163

Class ScreenClass

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

providerRegistry: ProviderRegistry

findHooks: Map<FindInput, FindHookCallback[]> = ...

Returns ScreenClass

Properties

config

Methods

capture

Parameters

fileName: string

fileFormat: FileType = FileType.PNG

filePath: string = ...

fileNamePrefix: string = ""

fileNamePostfix: string = ""

Returns Promise<string>

captureRegion

Parameters

fileName: string

regionToCapture: Region | Promise<Region>

fileFormat: FileType = FileType.PNG

filePath: string = ...

fileNamePrefix: string = ""

fileNamePostfix: string = ""

Returns Promise<string>

colorAt

Parameters

point: Point | Promise<Point>

Returns Promise<RGBA>

find

Type Parameters

Type Parameters

PROVIDER_DATA_TYPE

Parameters

searchInput: RegionResultFindInput | Promise<RegionResultFindInput>

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<Region>

Type Parameters

Type Parameters

PROVIDER_DATA_TYPE

Parameters

searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<Point>

Type Parameters

Type Parameters

PROVIDER_DATA_TYPE

Parameters

searchInput: { by: { title: string | RegExp }; id: string; type: "window" } | Promise<{ by: { title: string | RegExp }; id: string; type: "window" }>

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<Window>

Type Parameters

Type Parameters

PROVIDER_DATA_TYPE

Parameters

searchInput: FindInput | Promise<FindInput>

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<FindResult>

findAll

Type Parameters

Type Parameters

PROVIDER_DATA_TYPE

Parameters

searchInput: RegionResultFindInput | Promise<RegionResultFindInput>

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<Region[]>

Type Parameters

Type Parameters

PROVIDER_DATA_TYPE

Parameters

searchInput: { by: { color: RGBA }; id: string; type: "color" } | Promise<{ by: { color: RGBA }; id: string; type: "color" }>

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<Point[]>

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` timeoutMs: number

`Optional` updateInterval: number

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` timeoutMs: number

`Optional` updateInterval: number

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

`Optional` timeoutMs: number

`Optional` updateInterval: number

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>