Skip to content

Commit

Permalink
consisent documentation formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewharvey committed Aug 15, 2024
1 parent c5aea58 commit a96bbae
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,17 @@ Returns the zoom on which the cluster expands into several children (useful for

## Options

| Option | Default | Description |
|------------|--------------|------------------------------------------------------------------------------------|
| minZoom | 0 | Minimum zoom level at which clusters are generated. |
| maxZoom | 16 | Maximum zoom level at which clusters are generated. |
| minPoints | 2 | Minimum number of points to form a cluster. |
| radius | 40 | Cluster radius, in pixels. |
| extent | 512 | (Tiles) Tile extent. Radius is calculated relative to this value. |
| nodeSize | 64 | Size of the KD-tree leaf node. Affects performance. |
| arrayType | Float32Array | Array type to use for storing coordinate values. Affects accuracy for small radius |
| log | false | Whether timing info should be logged. |
| generateId | false | Whether to generate ids for input features in vector tiles. |
| Option | Default | Description |
|------------|--------------|-------------------------------------------------------------------------------------|
| minZoom | 0 | Minimum zoom level at which clusters are generated. |
| maxZoom | 16 | Maximum zoom level at which clusters are generated. |
| minPoints | 2 | Minimum number of points to form a cluster. |
| radius | 40 | Cluster radius, in pixels. |
| extent | 512 | (Tiles) Tile extent. Radius is calculated relative to this value. |
| nodeSize | 64 | Size of the KD-tree leaf node. Affects performance. |
| arrayType | Float32Array | TypedArray to use for storing coordinate values. Affects accuracy for small radius. |
| log | false | Whether timing info should be logged. |
| generateId | false | Whether to generate ids for input features in vector tiles. |

### Property map/reduce options

Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const defaultOptions = {
radius: 40, // cluster radius in pixels
extent: 512, // tile extent (radius is calculated relative to it)
nodeSize: 64, // size of the KD-tree leaf node, affects performance
arrayType: Float32Array, // Array type to use for storing coordinate values. Affects accuracy for small radius
arrayType: Float32Array, // TypedArray to use for storing coordinate values, affects accuracy for small radius
log: false, // whether to log timing info

// whether to generate numeric ids for input features (in vector tiles)
Expand Down

0 comments on commit a96bbae

Please sign in to comment.