TcUiClientScreenshot

export function TcUiClientScreenshot(
    ctx: SelectableRequired<TcHmi.Context<void>, 'success' | 'error'>,
    path string,
    fileName: string,
    querySelectorAll: string,
    selectorIndex?: number
): void;

Creates a screenshot based on the parameters passed within the TcUiClient.

Parameter

Name

Type

Description

ctx

SelectableRequired<TcHmi.Context<void>, 'success' | 'error'>

An object that contains functions for Success and Error.

path

string

Path where the screenshot(s) should be saved.

filename

string

Name of the screenshot

querySelectorAll

string

QuerySelector of the elements of which a screenshot is to be created.

selectorIndex

number, undefined

Index of the element in the QuerySelector list from which the screenshot is to be created. With "undefined", a screenshot is taken of all elements.

Return value

Type

Description

-

-

TcUiClientScreenshot 1:

Available from version 1.14.3.349