Skip to content

Commit 1dfb58a

Browse files
committed
Updated docs
1 parent 45dd02f commit 1dfb58a

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

readme.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Given any GeoJSON data, generate a `BitBox` with the provided options.
1515
Supported options:
1616

1717
* `resolution` - The size (width and height) of a "cell" in the same units as the input data.
18+
* `origin` - By default, `[0, 0]` is considered the origin.
1819

1920
### `bitgeo.or(datas, options)`
2021

@@ -32,14 +33,14 @@ var bitbox = bitgeo(data, options);
3233

3334
A bitbox is a (conceptually) rasterized representation of vector data containing information about where data is present and absent.
3435

35-
#### `bitbox.getArea()`
36-
37-
Returns the area of the bitbox where data is present (this will be an integer multiple of `resolution * resolution`).
38-
3936
#### `bitbox.get(i, j)`
4037

4138
Test if data is present at the provided location. The `i` and `j` values are offsets from the origin in terms of the bitbox resolution. For example, if a bitbox is created with `resolution: 10`, then `bitbox.get(1, 2)` would return `true` if there is data between `[10, 20]` and `[20, 30]` (with upper bounds being exclusive).
4239

40+
#### `bitbox.forEach(callback)`
41+
42+
Calls the provided callback for each `true` bit in the bitbox. The callback will be called with `i` and `j` as arguments. If the callback returns `false`, iteration will stop.
43+
4344
#### `bitbox.contains(minI, minJ, maxI, maxJ)`
4445

4546
Determine if all, some, or none of a range of bits are `true`. Returns `bitgeo.ALL` if all of the bits in the provided range are `true`, `bitgeo.SOME` if some bits are `true` and some are `false`, and `bitgeo.NONE` if all of the bits in the range are `false`. Ranges are inclusive (both min and max values are tested).
@@ -51,3 +52,7 @@ Return a bitbox that is the union of two bitboxes (`bitbox` and `other`).
5152
#### `bitbox.and(other)`
5253

5354
Return a bitbox that is the intersection of two bitboxes (`bitbox` and `other`).
55+
56+
#### `bitbox.getArea()`
57+
58+
Returns the area of the bitbox where data is present (this will be an integer multiple of `resolution * resolution`).

0 commit comments

Comments
 (0)