| layout | api-command | |||
|---|---|---|---|---|
| language | JavaScript | |||
| permalink | api/javascript/polygon_sub/ | |||
| command | polygonSub | |||
| io |
|
|||
| related_commands |
|
{% apibody %} polygon1.polygonSub(polygon2) → polygon {% endapibody %}
Use polygon2 to "punch out" a hole in polygon1. polygon2 must be completely contained within polygon1 and must have no holes itself (it must not be the output of polygonSub itself).
Example: Define a polygon with a hole punched in it.
var outerPolygon = r.polygon(
[-122.4,37.7],
[-122.4,37.3],
[-121.8,37.3],
[-121.8,37.7]
);
var innerPolygon = r.polygon(
[-122.3,37.4],
[-122.3,37.6],
[-122.0,37.6],
[-122.0,37.4]
);
outerPolygon.polygonSub(innerPolygon).run(conn, callback);