ConfigurationPlain class

Platform: PuppeteerLanguage: JavaScript SDK:
This type is used to create a configuration object that is used to configure an Eyes object by passing it to the Eyes.setConfiguration method.
You can use this configuration object instead of using the various Eyes methods and properties that set the same attributes. Typically you set up a Configuration object by calling its setXXXX methods chained with a '.' in a Fluent coding style. In this class, some attributes can be set by both a property and a set command. The properties allow you simple direct access to assign to and retrieve the attribute. The corresponding set method allows you to set multiple attributes using a Fluent style.

Properties

agentIdType:string
Use this property to set and retrieve the name and version of the SDK.
agentIdType:string
Use this property to set and retrieve the name and version of the SDK.
apiKeyType:string
Use this property to set and retrieve your Eyes license key.
apiKeyType:string
Use this property to set and retrieve your Eyes license key.
appNameType:string
Use this property to set and retrieve the value of the application name property. The application name is one of the 5 properties that define the baseline.
appNameType:string
Use this property to set and retrieve the value of the application name property. The application name is one of the 5 properties that define the baseline.
baselineBranchNameType:string
Use this property to set and retrieve the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.
baselineBranchNameType:string
Use this property to set and retrieve the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.
baselineEnvNameType:string
Use this property to set and retrieve the name of the environment that will be used to determine the baseline.
baselineEnvNameType:string
Use this property to set and retrieve the name of the environment that will be used to determine the baseline.
batchType:BatchInfoPlain
Use this property to set and retrieve the batch information for this test.
batchType:BatchInfoPlain
Use this property to set and retrieve the batch information for this test.
branchNameType:string
Use this property to set and retrieve the branch used for the baseline of this run.
branchNameType:string
Use this property to set and retrieve the branch used for the baseline of this run.
browsersInfoType:(DesktopBrowserInfo|ChromeEmulationInfo|IOSDeviceInfo)[]
Sets the list of one or more browsers or devices to be rendered on the Ultrafast Grid.
browsersInfoType:(DesktopBrowserInfo|ChromeEmulationInfo|IOSDeviceInfo)[]
Sets the devices to be rendered on the Ultrafast Grid.
deviceInfoType:string
Set the name of the device being rendered on the Ultrafast Grid.
forceFullPageScreenshotType:boolean
Use this property to set and retrieve whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.
forceFullPageScreenshotType:boolean
Use this property to set and retrieve whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.
hideCaretType:boolean
Use this property to set and retrieve whether Eyes should hide the cursor before the screenshot is captured.
hideCaretType:boolean
Use this property to set and retrieve whether Eyes should hide the cursor before the screenshot is captured.
hideScrollbarsType:boolean
Use this property to set and retrieve whether Eyes hides the scrollbars before capturing screenshots or not.
hideScrollbarsType:boolean
Use this property to set and retrieve whether Eyes hides the scrollbars before capturing screenshots or not.
hostAppType:string
Use this property to set and retrieve the name of the hosting application property.
hostAppType:string
Use this property to set and retrieve the name of the hosting application property.
hostAppInfoType:string
Set the value that shold be displayed in the Browser column of the Test Results page of the Test Manager.
hostOSType:string
Use this property to set and retrieve the name of the hosting operating system property.
hostOSType:string
Use this property to set and retrieve the name of the hosting operating system property.
hostOSInfoType:string
Set the value that shold be displayed in the OS column of the Test Results page of the Test Manager.
matchTimeoutType:number
Use this property to set and retrieve the maximum time Eyes will try to perform a match on the fully captured image.
matchTimeoutType:number
Use this property to set and retrieve the maximum time Eyes will try to perform a match on the fully captured image.
parentBranchNameType:string
Use this property to set and retrieve the parent branch from which newly created branches get their initial baseline.
parentBranchNameType:string
Use this property to set and retrieve the parent branch from which newly created branches get their initial baseline.
propertiesType:PropertyDataPlain[]
Set a list of user-defined properties each of which is a key/value pair.
propertiesType:PropertyDataPlain[]
Set a list of user-defined properties each of which is a key/value pair.
proxyType:ProxySettingsPlain
Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.
rotationType:ImageRotationPlain
Use this property to set and retrieve the rotation to apply to the checkpoint images before matching.
rotationType:ImageRotationPlain
Use this property to set and retrieve the rotation to apply to the checkpoint images before matching.
saveNewTestsType:boolean
Use this property to set and retrieve whether or not 'new' tests are saved to the baseline by default.
saveNewTestsType:boolean
Use this property to set and retrieve whether or not 'new' tests are saved to the baseline by default.
scaleRatioType:number
Use this property to set and retrieve the scale ratio to be applied to images before matching.
scrollRootElementType:ElementHandle|Selector
Use this property to set and retrieve the element to which setHideScrollbars will be applied.
sendDomType:boolean
Use this property to set and retrieve if DOM information should be sent for checkpoints.
sendDomType:boolean
Use this property to set and retrieve if DOM information should be sent for checkpoints.
serverUrlType:string
Use this property to set and retrieve the URL of the Eyes server used to process the captured images.
serverUrlType:string
Use this property to set and retrieve the URL of the Eyes server used to process the captured images.
stitchModeType:StitchModePlain
Use this property to set and retrieve the type of stitching used for full page screenshots.
stitchModeType:StitchModePlain
Use this property to set and retrieve the type of stitching used for full page screenshots.
stitchOverlapType:number
Use this property to set and retrieve the overlap between sub-images when a scrolled window is stitched.
stitchOverlapType:number
Use this property to set and retrieve the overlap between sub-images when a scrolled window is stitched.
testNameType:string
Use this property to set and retrieve the name of the test.
testNameType:string
Use this property to set and retrieve the name of the test.
viewportSizeType:RectangleSizePlain
Use this property to set and retrieve the viewport size to be used by the browser for the test.
viewportSizeType:RectangleSizePlain
Set the viewport size to be used by the browser for the test.
visualGridOptionsType:Record<string,any>
Use this property to set and retrieve configuration values for the Ultrafast Grid.
visualGridOptionsType:Record<string,any>
Use this property to set and retrieve configuration values for the Ultrafast Grid.
waitBeforeScreenshotsType:number
Use this property to set and retrieve the amount of time in milliseconds that Eyes will wait before capturing a screenshot.
waitBeforeScreenshotsType:number
Use this property to set and retrieve the amount of time in milliseconds that Eyes will wait before capturing a screenshot.