Click to expand library description
This library is a prototype that detects objects in the image in a very naive way (by their color). It was developed for the demo purpose only, it doesn't produce reliable results and it's not meant to be used in production.
Search all objects in the image.
| Function | Return | Description |
|---|---|---|
pix.findAll(<Object> options)
|
Array | Detects objects by the given options. |
| Option | Type | Default | Description |
|---|---|---|---|
| img | HTMLImageElement | HTMLCanvasElement | Loaded image or canvas element that has to be analyzed. | |
| colors | Array | Colors of objects to find. | |
| tolerance | Number | 50 | Color variation (number of shades). Helps to detect objects not only by strict colors (colors option), but by their shades too. |
| accuracy | Number | 2 | If accuracy = 1 then Pixfinder analyzes each pixel of the image, if accuracy = 2 then each 2nd pixel, and so on. Large number for better performance and worse quality and vice versa. The number should be a positive integer. |
| distance | Number | 10 | Distance between objects (in pixels). During the image analysis Pixfinder detects all pixels according to specified colors and then splits them into several objects by distance. If distance between two pixels is shorter than this option then pixels belong to the same object. |
| clearNoise | Boolean | Number | false | Removes all small objects after the image analysis. If false then noise clearing is disabled. If number is set then all objects that contain less than specified number of pixels will be removed. |
| concavity | Number | 10 | Determines the concavity of object edges. Internally Pixfinder uses hull.js library to build object boundary. Please see hull.js documentation for more information about this parameter. |
Starts searching from the start point and returns one object that belongs to this point. This method should be useful for example if you want to highlight object under the mouse cursor.
| Function | Return | Description |
|---|---|---|
pix.find(<Object> options)
|
Array | Returns points of the object which belongs to the startPoint. |
| Option | Type | Default | Description |
|---|---|---|---|
| img | HTMLImageElement | HTMLCanvasElement | Loaded image or canvas element that has to be analyzed. | |
| colors | Array | Colors of objects to find. | |
| startPoint | Point | Point from which to start the object pixels search. | |
| tolerance | Number | 50 | Color variation (number of shades). Helps to detect objects not only by strict colors (colors option), but by their shades too. |
| distance | Number | 10 | Distance between objects (in pixels). If distance between two pixels is shorter than this option then Pixfinder decides that pixels belong to the same object. |
| concavity | Number | 10 | Determines the concavity of object edges. Internally Pixfinder uses hull.js library to build object boundary. Please see hull.js documentation for more information about this parameter. |
Various DOM utility functions.
| Method | Returns | Description |
|---|---|---|
| onload(<HTMLImageElement> img, <Function> func) | Calls func function when img image is loaded. |
|
| loaded(<HTMLImageElement> img) | Boolean | Checks whether img image has been loaded. |
Contains information about point.
| Property | Type | Description |
|---|---|---|
| x | Number | The x coordinate. |
| y | Number | The y coordinate. |
npm install # install dependencies
npm run build # build library
- Cleanup and deprecate
- Remove vulnerable dev dependencies
- Introduce pixfinder.d.ts
- Update dependencies;
- Introduce
concavityparameter.
- Minor package.json and copyright fixes.
- Minor package.json fixes.
- Minor package.json fixes.
- Readme fixes.
- API changes without backward compatibility.
- First Pixfinder release (unstable alpha version).