Insight

Insight. Insight

new Insight(props[opt]) → {Object}

The description of an Insight test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes an insight test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
Object

Methods

image(base64ImageString[opt]) → {string|Description}

The Base64 string representing the source image for this Insight test object.
Parameters:
NameTypeAttributesDescription
base64ImageStringstring <optional>
When a Base64 string representation of an image is provided, this method acts as a setter and sets the image property of the description.
Returns:
If no parameter is provided, the method acts as a getter and returns the current Base64 string representation of the image property; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

similarity(similarityValue[opt]) → {string|Description}

A percentage value that specifies how similar an object in the AUT must be to this Insight object's source image in order to be considered a match. Possible values: 0 - 100.
Parameters:
NameTypeAttributesDescription
similarityValuenumber <optional>
When provided, this method acts as a setter and sets the similarity value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored similarity value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description