19.1 Allgemeine Parameter der Check-Funktionen

Die bereitgestellten Methoden zum Testen der Barrierefreiheit sind über verschiedene Parameter einstellbar, um beispielsweise den Umfang des Tests oder die Art der Protokollierung festzulegen.
Diese Parameter werden im Folgenden genauer erklärt.

scope

Hier wird die QF-Test ID der Komponente angegeben, innerhalb derer die Checks angewandt werden sollen. Die Tests werden nur auf diese Komponente und ihre Kindkomponenten angewendet.
Default: genericDocument, also die gesamte Seite

genericClassesToSkip

Die mit einem Komma getrennten Namen von Generische Klassen, die bei den Tests übergangen werden sollen. Diese Klassen und eventuelle Unterklassen werden bei den Tests nicht überprüft.
Default: -

skipInvisibleElements

Legt fest, ob die Checks bei unsichtbaren Elementen übersprungen werden sollen.
Default: true

showSuccessfulChecks

Wird dieser Parameter auf true gesetzt, werden auch erfolgreiche Checks als Information im Protokoll gelistet.
Default: false

showSkippedChecks

Wird dieser Parameter auf true gesetzt, werden Checks, die nicht vollständig ausgeführt werden konnten, als Warnung im Protokoll gelistet. Ein Grund hierfür kann zum Beispiel die Überdeckung des zu prüfenden Elementes durch ein anderes sein.
Default: true

logOverviewScreenshot

Legt fest, ob im Fehlerfall ein Bildschirmabbild für den Überblick über die fehlerhaften Elemente erzeugt werden soll. Das Bildschirmabbild umfasst den definierten scope, kann also auch die gesamten Seite beinhalten. Auf dem Bild werden Elemente mit Fehlern rot umrandet, Elemente mit Warnungen gelb.
Default: true

allowedHeightOfOverviewScreenshot

Legt die maximale Höhe (in Pixeln) für das Bildschirmabbild für den Überblick fest. Wirkt sich nur auf das Bildschirmabbild aus, wenn dieses größer als das Browserfenster ist. Das Limit ist aus Speichergründen erforderlich.
Default: 2000

logElementScreenshots

Legt fest, ob im Fehlerfall ein Abbild der einzelnen Elemente erzeugt werden soll.
Wenn der Wert all ist, wird für jedes einzelne fehlerhafte Element ein Abbild erzeugt.
Wenn der Wert first ist, wird nur für das erste Element eines Fehlertyps ein Abbild erzeugt.
Wenn der Wert none ist, werden keine Abbilder erzeugt.
Auf dem Bild wird das Elemente bei Fehlern rot umrandet, bei Warnungen gelb. Die Gesamtanzahl der Abbilder wird durch den folgenden Parameter allowedNumberOfElementScreenshots begrenzt.
Default: all
Mögliche Werte: all, first, none

allowedNumberOfElementScreenshots

Bestimmt die maximale Anzahl an Einzelbildern von Elementen im Fehlerfall. Das Limit ist aus Speichergründen erforderlich.
Default: 10

logElementSmartIdToMessage

Legt fest, ob die QF-Test spezifische SmartID des überprüften Elementes im Protokoll aufgeführt werden soll.
Die SmartID hilft beim addressieren der fehlerhaften Komponenten innerhalb QF-Tests.
Default: false

squashCheckResultsWithSameMessage

Wird dieser Parameter auf true gesetzt, werden Elemente mit der gleichen Fehlermeldung im Protokoll unter einem einzigen Fehler (oder Warnung) zusammengefasst.
Default: false