diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 8455616..1ea587c 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -98,6 +98,10 @@ const config = { text: "Rectangle", link: "/guide/Rectangle", }, + { + text: "Polygon", + link: "/guide/Polygon", + }, ], }, { diff --git a/docs/.vitepress/theme/index.js b/docs/.vitepress/theme/index.js index 9eadd48..e6e28a4 100644 --- a/docs/.vitepress/theme/index.js +++ b/docs/.vitepress/theme/index.js @@ -6,6 +6,7 @@ import NaverInfoWindow from "../../example/InfoWindow.vue"; import NaverCircle from "../../example/Circle.vue"; import NaverEllipse from "../../example/Ellipse.vue"; import NaverRectangle from "../../example/Rectangle.vue"; +import NaverPolygon from "../../example/Polygon.vue"; export default { ...theme, @@ -15,6 +16,6 @@ export default { app.component("naver-info-window", NaverInfoWindow); app.component("naver-circle", NaverCircle); app.component("naver-ellipse", NaverEllipse); - app.component("naver-rectangle", NaverRectangle); + app.component("naver-polygon", NaverPolygon); }, }; diff --git a/docs/api/index.md b/docs/api/index.md index 27aff86..311830b 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -338,3 +338,76 @@ const bounds = { - **선택** - **반환타입:** `naver.maps.Rectangle` - **상세:** +- + +## NaverPolygon + +폴리곤 컴포넌트에서 사용되는 Props 입니다. + +### paths + +- **필수** +- **타입:** `naver.maps.ArrayOfCoords`| `naver.maps.KVOArrayOfCoords` | `naver.maps ArrayOfCoordsLiteral` +- **상세:** + +연결 될 각 좌표들을 설정합니다. + +```js +// naver.maps.ArrayOfCoords 타입 +const paths = [ + new naver.maps.LatLng(38, 127), + new naver.maps.LatLng(39, 128), + new naver.maps.LatLng(39, 128), +]; +``` + +```js +// naver.maps.KVOArrayOfCoords 타입 +const paths = [ + { + south: 37.566616443521745, + north: 38.566616443521745, + west: 126.97837068565364, + east: 127.97837068565364, + }, + { + south: 37.566616443521745, + north: 38.566616443521745, + west: 126.97837068565364, + east: 127.97837068565364, + }, +]; +``` + +```js +// naver.maps ArrayOfCoordsLiteral 타입 +const paths = [ + [126.9797895, 37.5670131], + [126.979215, 37.5649555], + [126.9766789, 37.5649082], + [126.9789515, 37.5637645], + [126.9785598, 37.5614914], + [126.9804949, 37.5632666], + [126.9827689, 37.5619065], + [126.9818039, 37.5639213], + [126.9837414, 37.5653719], + [126.9811162, 37.5651081], +]; +``` + +위와 같은 예제로 paths를 지정할 수 있습니다. + +### options + +- **선택** +- **타입:** `naver.maps.PolygonOptions` +- **기본값:** `{}` +- **상세:** + +폴리곤 컴포넌트에서 사용 가능한 추가적인 옵션을 입력합니다. + +### @onLoad + +- **선택** +- **반환타입:** `naver.maps.Polygon` +- **상세:** diff --git a/docs/example/Polygon.vue b/docs/example/Polygon.vue new file mode 100644 index 0000000..6dc2f9a --- /dev/null +++ b/docs/example/Polygon.vue @@ -0,0 +1,66 @@ + + + diff --git a/docs/guide/Polygon.md b/docs/guide/Polygon.md new file mode 100644 index 0000000..05c6162 --- /dev/null +++ b/docs/guide/Polygon.md @@ -0,0 +1,97 @@ +# Polygon + +`NaverPolygon`는 폴리곤을 생성하는 컴포넌트 입니다. `NaverMaps` 생성 이후에 사용 가능합니다. + +## 예시 + +\ + + +```vue + + + +``` + +자세한 Props, Emit 옵션은 [NaverPolygon](../api/#naverpolygon)에서 확인 가능합니다. + +## 설정 + +`paths`는 필수적으로 입력해 주셔야 합니다. 연결할 각 좌표를 의미 합니다. + +## UI 이벤트 + +이벤트에 대한 자세한 설명은 [이벤트 상세설명](https://navermaps.github.io/maps.js.ncp/docs/naver.maps.Polygon.html#toc28__anchor)에서 확인 가능합니다. + +- click +- clickable_changed +- dblclick +- mousedown +- mouseout +- mouseover +- mouseup +- visible_changed +- zIndex_changed