diff --git a/docs/component/circle-geom.md b/docs/component/circle-geom.md index fac19d98..35e6e2d5 100644 --- a/docs/component/circle-geom.md +++ b/docs/component/circle-geom.md @@ -1,5 +1,9 @@ # vl-geom-circle +> The circle geometry. + +`vl-geom-circle` can be used in a [`vl-feature`](/docs/component/feature.md) to draw circles on the map. + ## ES6 Module ```javascript @@ -7,3 +11,51 @@ import { CircleGeom } from 'vuelayers' Vue.use(CircleGeom); ``` + +## Usage + + + + + + +## Properties + +### coordinates + +- **Type**: `number[]` +- **Default**: `[0, 0]` + +The center coordinate of the circle in the unit specified by the view's [`projection`](/docs/quickstart.md#global-data-projection). + +### radius + +- **Type**: `number` +- **Default**: `0` + +The radius of the circle in the unit specified by the view's [`projection`](/docs/quickstart.md#global-data-projection).