You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
libdoc={"name": "ImageCompare","doc": "<p>Documentation for library <code>ImageCompare</code>.</p>","version": "0.1.0","generated": "2022-05-10 09:40:37","type": "LIBRARY","scope": "TEST","docFormat": "HTML","source": "C:\\workspace\\robotframework-imagecompare\\ImageCompare\\__init__.py","lineno": 93,"tags": [],"inits": [],"keywords": [{"name": "Compare Images","args": [{"name": "reference_image","types": [],"typedocs": {},"defaultValue": null,"kind": "POSITIONAL_OR_NAMED","required": true,"repr": "reference_image"},{"name": "test_image","types": [],"typedocs": {},"defaultValue": null,"kind": "POSITIONAL_OR_NAMED","required": true,"repr": "test_image"},{"name": "kwargs","types": [],"typedocs": {},"defaultValue": null,"kind": "VAR_NAMED","required": false,"repr": "**kwargs"}],"doc": "<p>Compares the documents/images <code>reference_image</code> and <code>test_image</code>.</p>\n<p><code>**kwargs</code> can be used to add settings for <code>placeholder_file</code></p>\n<p>Result is passed if no visual differences are detected.</p>\n<p><code>reference_image</code> and <code>test_image</code> may be image files, e.g. png, jpg, or tiff.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<th>Keyword</th>\n<th>reference_image</th>\n<th>test_image</th>\n<th>**kwargs</th>\n<th>comment</th>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.png</td>\n<td>candidate.png</td>\n<td></td>\n<td>#Performs a pixel comparison of both files</td>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.png (not existing)</td>\n<td>candidate.png</td>\n<td></td>\n<td>#Will always return passed and save the candidate.pdf as reference.pdf</td>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.png</td>\n<td>candidate.png</td>\n<td>placeholder_file=mask.json</td>\n<td>#Performs a pixel comparison of both files and excludes some areas defined in mask.json</td>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.pdf</td>\n<td>candidate.pdf</td>\n<td>contains_barcodes=${true}</td>\n<td>#Identified barcodes in documents and excludes those areas from visual comparison. The barcode data will be checked instead</td>\n</tr>\n</table>","shortdoc": "Compares the documents/images ``reference_image`` and ``test_image``.","tags": [],"source": "C:\\workspace\\robotframework-imagecompare\\ImageCompare\\imagecompare.py","lineno": 129}],"dataTypes": {"enums": [],"typedDicts": []},"typedocs": []}
1193
+
libdoc={"specversion": 1,"name": "ImageCompare","doc": "<p>Documentation for library <code>ImageCompare</code>.</p>","version": "0.2.0","generated": "2023-03-28T11:01:53+00:00","type": "LIBRARY","scope": "TEST","docFormat": "HTML","source": "C:\\workspace\\robotframework-imagecompare\\ImageCompare\\__init__.py","lineno": 95,"tags": [],"inits": [],"keywords": [{"name": "Compare Images","args": [{"name": "reference_image","types": [],"typedocs": {},"defaultValue": null,"kind": "POSITIONAL_OR_NAMED","required": true,"repr": "reference_image"},{"name": "test_image","types": [],"typedocs": {},"defaultValue": null,"kind": "POSITIONAL_OR_NAMED","required": true,"repr": "test_image"},{"name": "kwargs","types": [],"typedocs": {},"defaultValue": null,"kind": "VAR_NAMED","required": false,"repr": "**kwargs"}],"doc": "<p>Compares the documents/images <code>reference_image</code> and <code>test_image</code>.</p>\n<p><code>**kwargs</code> can be used to add settings for <code>placeholder_file</code></p>\n<p>Result is passed if no visual differences are detected.</p>\n<p><code>reference_image</code> and <code>test_image</code> may be image files, e.g. png, jpg, or tiff.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<th>Keyword</th>\n<th>reference_image</th>\n<th>test_image</th>\n<th>**kwargs</th>\n<th>comment</th>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.png</td>\n<td>candidate.png</td>\n<td></td>\n<td>#Performs a pixel comparison of both files</td>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.png (not existing)</td>\n<td>candidate.png</td>\n<td></td>\n<td>#Will always return passed and save the candidate.pdf as reference.pdf</td>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.png</td>\n<td>candidate.png</td>\n<td>placeholder_file=mask.json</td>\n<td>#Performs a pixel comparison of both files and excludes some areas defined in mask.json</td>\n</tr>\n<tr>\n<td>Compare Images</td>\n<td>reference.pdf</td>\n<td>candidate.pdf</td>\n<td>contains_barcodes=${true}</td>\n<td>#Identified barcodes in documents and excludes those areas from visual comparison. The barcode data will be checked instead</td>\n</tr>\n</table>","shortdoc": "Compares the documents/images ``reference_image`` and ``test_image``.","tags": [],"source": "C:\\workspace\\robotframework-imagecompare\\ImageCompare\\imagecompare.py","lineno": 118}],"dataTypes": {"enums": [],"typedDicts": []},"typedocs": []}
<<astyle="cursor: pointer;"class="type"title="Click to show type information"onclick="showModal(${$data.typedocs[$value]})">${$value}</a>>
1752
+
<<astyle="cursor: pointer;"class="type"title="Click to show type information"onclick="showModal(document.querySelector('#type-modal-${$data.typedocs[$value]}'))">${$value}</a>>
0 commit comments