Skip to content

Commit

Permalink
docs: enhance docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mym0404 committed Apr 14, 2024
1 parent 2e9982c commit 6ee10a3
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions src/component/NaverMapPolylineOverlay.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,48 @@ import invariant from 'invariant';

export interface NaverMapPolylineOverlayProps extends BaseOverlayProps {
coords: Coord[];
/**
* 두께를 지정할 수 있습니다.
*
* dp, pt단위입니다.
*
* @default 1
*/
width?: number;
/**
* color속성을 사용해 선의 색상을 지정할 수 있습니다.
*
* @default black
*/
color?: ColorValue;
pattern?: number[];
/**
* capType 속성을 사용해 끝 지점의 모양을 지정할 수 있습니다.
*
* 다음 그림은 위에서부터 차례대로 Round, Butt, Square 모양을 나타냅니다.
*
* @description
*
* <img src="https://navermaps.github.io/ios-map-sdk/assets/5-4-captype.png" width="300" alt="preview">
*
* @see CapType
* @default Round
*/
capType?: CapType;
/**
* joinType 속성을 사용해 연결점의 모양을 지정할 수 있습니다.
*
* 다음 그림은 위에서부터 차례대로 Round, Butt, Square 모양을 나타냅니다.
*
* @description
*
* <img src="https://navermaps.github.io/ios-map-sdk/assets/5-4-join-bevel.png" width="300" alt="preview">
* <img src="https://navermaps.github.io/ios-map-sdk/assets/5-4-join-miter.png" width="300" alt="preview">
* <img src="https://navermaps.github.io/ios-map-sdk/assets/5-4-join-round.png" width="300" alt="preview">
*
* @see JoinType
* @default Round
*/
joinType?: JoinType;
}

Expand Down

0 comments on commit 6ee10a3

Please sign in to comment.