META-INF.apidocs.nl.praegus.fitnesse.slim.fixtures.ImageCompareFixture.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-fixtures Show documentation
Show all versions of toolchain-fixtures Show documentation
Extensions on existing fixtures to aid in automated testing
{
"constructors" : [ {
"readableName" : "image compare fixture",
"usage" : "| image compare fixture |",
"name" : "ImageCompareFixture",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.praegus.fitnesse.slim.fixtures.ImageCompareFixture",
"publicMethods" : [ {
"readableName" : "set accepted difference percentage",
"usage" : "| set accepted difference percentage | [acceptedDifferencePercentage] | ",
"contexthelp" : "set accepted difference percentage <acceptedDifferencePercentage>",
"name" : "setAcceptedDifferencePercentage",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "acceptedDifferencePercentage",
"type" : "double"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set tolerance",
"usage" : "| set tolerance | [tolerance] | ",
"contexthelp" : "set tolerance <tolerance>",
"name" : "setTolerance",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "tolerance",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set comparison map file format",
"usage" : "| set comparison map file format | [comparisonMapFileFormat] | ",
"contexthelp" : "set comparison map file format <comparisonMapFileFormat>",
"name" : "setComparisonMapFileFormat",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "comparisonMapFileFormat",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "differences between and",
"usage" : "| differences between | [baselineImagePath] | and | [testImagePath] | ",
"contexthelp" : "differences between <baselineImagePath> and <testImagePath>",
"name" : "differencesBetweenAnd",
"docString" : "Returns an image showing a heatmap of differences between two given images. Images given can be of PNG, BMP, JPEG\n or GIF file format. The file format of the compared images might differ.\n@param baselineImagePath path of the image to be used as baseline to test an image against. Format is\n url: http://files/example.png or\n relative path: files/example.png or\n absolute path : C:\\Projects\\someProject\\wiki\\FitNesseRoot\\files\\example.png\n@param testImagePath the image to test against the given baseline\n@return HTML link to the generate heatmap\n@throws IOException when image can not be saved",
"annotations" : [ ],
"parameters" : [ {
"name" : "baselineImagePath",
"description" : "path of the image to be used as baseline to test an image against. Format is\n url: http://files/example.png or\n relative path: files/example.png or\n absolute path : C:\\Projects\\someProject\\wiki\\FitNesseRoot\\files\\example.png",
"type" : "String"
}, {
"name" : "testImagePath",
"description" : "the image to test against the given baseline",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "String"
}, {
"readableName" : "image is equal to",
"usage" : "| image is equal | [baselineImagePath] | to | [testImagePath] | ",
"contexthelp" : "image is equal <baselineImagePath> to <testImagePath>",
"name" : "imageIsEqualTo",
"docString" : "Boolean indicating if two given images are visually equal (depending on set tolerance and accepted\n difference percentage)\n@param baselineImagePath path of the image to be used as baseline to test an image against. Format is\n url: http://files/example.png or\n relative path: files/example.png or\n absolute path : C:\\Projects\\someProject\\wiki\\FitNesseRoot\\files\\example.png\n@param testImagePath the image to test against the given baseline\n@return true when the two given images are visually equal\n@throws IOException",
"annotations" : [ ],
"parameters" : [ {
"name" : "baselineImagePath",
"description" : "path of the image to be used as baseline to test an image against. Format is\n url: http://files/example.png or\n relative path: files/example.png or\n absolute path : C:\\Projects\\someProject\\wiki\\FitNesseRoot\\files\\example.png",
"type" : "String"
}, {
"name" : "testImagePath",
"description" : "the image to test against the given baseline",
"type" : "String"
} ],
"exceptions" : [ "java.io.IOException" ],
"returnType" : "boolean"
}, {
"readableName" : "add exclude region",
"usage" : "| add exclude region | [region] | ",
"contexthelp" : "add exclude region <region>",
"name" : "addExcludeRegion",
"docString" : "Add a region to ignore.\n A region is formatted as x, y, width, height in pixels. So 0,0,20,100 will ignore a region of 20x100px in the top left corner of the image\n@param region a comma separated list of integers (x,y,width,height)",
"annotations" : [ ],
"parameters" : [ {
"name" : "region",
"description" : "a comma separated list of integers (x,y,width,height)",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set global value to",
"usage" : "| set global value | [symbolName] | to | [value] | ",
"contexthelp" : "set global value <symbolName> to <value>",
"name" : "setGlobalValueTo",
"docString" : "Stores a (global) value so it can be accessed by other fixtures/pages.\n@param symbolName name to store value under.\n@param value value to store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name to store value under.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to store.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "global value",
"usage" : "| global value | [symbolName] | ",
"contexthelp" : "global value <symbolName>",
"name" : "globalValue",
"docString" : "Retrieves a (global) value, which was previously stored using #setGlobalValueTo().\n@param symbolName name value was stored under.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name value was stored under.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "wait seconds",
"usage" : "| wait seconds | [i] | ",
"contexthelp" : "wait seconds <i>",
"name" : "waitSeconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait milliseconds",
"usage" : "| wait milliseconds | [i] | ",
"contexthelp" : "wait milliseconds <i>",
"name" : "waitMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set repeat interval to milliseconds",
"usage" : "| set repeat interval to milliseconds | [milliseconds] | ",
"contexthelp" : "set repeat interval to milliseconds <milliseconds>",
"name" : "setRepeatIntervalToMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "milliseconds",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat interval",
"usage" : "| repeat interval |",
"contexthelp" : "repeat interval",
"name" : "repeatInterval",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times | [maxCount] | ",
"contexthelp" : "repeat at most times <maxCount>",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "maxCount",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times |",
"contexthelp" : "repeat at most times",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "repeat count",
"usage" : "| repeat count |",
"contexthelp" : "repeat count",
"name" : "repeatCount",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "time spent repeating",
"usage" : "| time spent repeating |",
"contexthelp" : "time spent repeating",
"name" : "timeSpentRepeating",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
} ],
"typeName" : "nl.praegus.fitnesse.slim.fixtures.ImageCompareFixture",
"name" : "ImageCompareFixture",
"annotations" : [ ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy