npm package: @lbh7/react-amap-polyline
Description: 构造折线对象，支持 `lineString` 和 `MultiLineString`。
Author: Kenny Wong
Latest version: 1.0.7

Polyline 折线组件
===

[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor)
[![npm version](https://img.shields.io/npm/v/@lbh7/react-amap-polyline.svg)](https://www.npmjs.com/package/@lbh7/react-amap-polyline)
[![Downloads](https://img.shields.io/npm/dm/@lbh7/react-amap-polyline.svg?style=flat)](https://www.npmjs.com/package/@lbh7/react-amap-polyline)

构造折线对象，支持 `lineString` 和 `MultiLineString`。

```jsx
import { Polyline } from '@lbh7/react-amap';
// 或者单独安装使用
import { Polyline } from '@lbh7/react-amap-polyline';
```

### 基本用法

```jsx mdx:preview
import ReactDOM from 'react-dom';
import React, { useState, useRef } from 'react';
import { Map, APILoader, Polyline, ToolBarControl } from '@lbh7/react-amap';

const Example = () => {
  const [show, setShow] = useState(true);
  const [color, setColor] = useState('red');
  return (
    <>
      <button onClick={() => setShow(!show)}>
        {show ? '关闭' : '开启'}
      </button>
      <button onClick={() => setColor(color === 'red' ? 'black' : 'red')}>
        {color}
      </button>
      <div style={{ width: '100%', height: '300px' }}>
        <Map zoom={3}>
          <Polyline
            visiable={show}
            onHide={(obj) => {
              console.log('obj:', obj);
            }}
            onShow={(obj) => {
              console.log('obj:', obj);
            }}
            onClick={(obj) => {
              console.log('obj:', obj);
            }}
            strokeColor={color}
            strokeOpacity={1}
            draggable={true}
            onChange={e=>console.log(e)}
            onDragStart={(e)=>{console.log(e)}}
            onDragging={(e)=>{console.log(e)}}
            onDragEnd={(e)=>{console.log(e)}}
            path={[
              [116.405289, 39.904987],
              [113.964458, 40.54664],
              [111.47836, 41.135964],
              [108.949297, 41.670904],
              [106.380111, 42.149509],
              [103.774185, 42.56996],
              [101.135432, 42.930601],
              [98.46826, 43.229964],
              [95.777529, 43.466798],
              [93.068486, 43.64009],
              [90.34669, 43.749086],
              [87.61792, 43.793308]
            ]}
          />
          <Polyline
            visiable={show}
            strokeOpacity={1}
            strokeColor={color}
            path={[
              [121.099109,31.222311],
              [118.528308,31.989555],
              [117.319812,31.803006],
              [114.353503,30.67583],
              [115.891589,28.979429],
              [112.947253,28.188361],
            ]}
          />
        </Map>
      </div>
    </>
  );
}

const Mount = () => (
  <APILoader akey="a7a90e05a37d3f6bf76d4a9032fc9129">
    <Example />
  </APILoader>
);

export default Mount;
```

### 受控组件

```jsx mdx:preview
import ReactDOM from 'react-dom';
import React, { useState, useRef } from 'react';
import { Map, APILoader, Polyline, ToolBarControl } from '@lbh7/react-amap';

const path1 = [
  [121.099109,31.222311],
  [118.528308,31.989555],
  [117.319812,31.803006],
  [114.353503,30.67583],
  [115.891589,28.979429],
  [112.947253,28.188361],
];

const path2 = [
  [116.405289, 39.904987],
  [113.964458, 40.54664],
  [111.47836, 41.135964],
  [108.949297, 41.670904],
  [106.380111, 42.149509],
  [103.774185, 42.56996],
  [101.135432, 42.930601],
  [98.46826, 43.229964],
  [95.777529, 43.466798],
  [93.068486, 43.64009],
  [90.34669, 43.749086],
  [87.61792, 43.793308],
];
const path3 = [
  [120.098109,31.212311],
  [117.518308,31.969555],
  [116.329812,31.823006],
  [113.363503,30.68583],
  [114.861589,28.969429],
  [111.937253,28.158361],
];
const options1={
  zIndex:2,
  cursor:"text",
  isOutline:false,
  strokeWeight:2,
  strokeOpacity:1,
  strokeColor:"red",
  lineJoin:"bevel",
  lineCap:"round",
};

const options2={
  zIndex:4,
  cursor:"move",
  isOutline:true,
  outlineColor:"green",
  borderWeight:2,
  strokeWeight:1,
  strokeOpacity:0.5,
  strokeColor:"blue", 
  lineJoin:"round",
  lineCap:"square"

};
const Example = () => {
  const [show, setShow] = useState(true);
  const [paths, setPaths] = useState(path1);
  const [options,setOptions]=useState(options1);
  return (
    <>
      <button onClick={() => setShow(!show)}>
        {show ? '关闭' : '开启'}
      </button>
      {show && (
        <>
        <button onClick={() => setPaths(paths.length === 6 ? path2 : path1)}>
          切换路线
        </button>
        <button onClick={() => setOptions(options.strokeColor === "blue" ? options1 : options2)}>
          切换样式
        </button>
        </>
      )}
      <div style={{ width: '100%', height: '300px' }}>
        <Map zoom={3}>
          <Polyline
            akey="1"
            visiable={show}
            strokeOpacity={1}
            path={paths}
            options={options}
          />
          <Polyline
            akey="2"
            zIndex={3}
            visiable={true}
            strokeColor={"yellow"}
            strokeOpacity={1}
            strokeWeight={4}
            path={path3}
          />
        </Map>
      </div>
    </>
  );
}

const Mount = () => (
  <APILoader akey="a7a90e05a37d3f6bf76d4a9032fc9129">
    <Example />
  </APILoader>
);

export default Mount;
```

### Props

[更多参数设置](https://github.com/uiwjs/react-amap/blob/268303d/src/types/overlay.d.ts#L275-L370)

[V1.x.xx API](https://lbs.amap.com/api/javascript-api/reference/overlay#polyline)

[V2.x.xx API](https://lbs.amap.com/api/jsapi-v2/documentation#polyline)

| 参数 | 说明 | 类型 | 默认值 |
| ----- | ----- | ----- | ----- |
| visiable | 覆盖物是否可见。 | `boolean` | - |
| path | 路径，支持 lineString 和 MultiLineString。 | `Array<LngLat>` / `Array<Array<LngLat>>` | - |
| options | 折线属性（包括路径的节点、线样式、是否绘制大地线等）。 | `PolylineOptions` | - |

### 事件

Polyline v1.4.15 和 v2.0.xx 版本都是支持 drag 相关事件的，虽然官网文档有的写的不全，但经实验都是可以的。
<!--rehype:style=background: #fff3b7;-->

[事件类型文档](https://github.com/uiwjs/react-amap/blob/268303d/src/types/overlay.d.ts#L249-L274)

| 参数 | 说明 | 类型 |
| ---- | ---- | ---- |
| onHide | 隐藏 | (event: { type: string, target: any }): void; |
| onShow | 显示 | (event: { type: string, target: any }): void; |
| onMouseOut | 鼠标移出 | (event: MapsEvent): void; |
| onRightClick | 鼠标右键单击事件 | (event: MapsEvent): void; |
| onDblClick | 鼠标左键双击事件 | (event: MapsEvent): void; |
| onMouseOver | 鼠标经过 | (event: MapsEvent): void; |
| onTouchEnd | 触摸结束时触发事件，仅适用移动设备 | (event: MapsEvent): void; |
| onTouchMove | 触摸移动进行中时触发事件，仅适用移动设备 | (event: MapsEvent): void; |
| onTouchStart | 触摸开始时触发事件，仅适用移动设备 | (event: MapsEvent): void; |
| onMouseUp | 鼠标抬起 | (event: MapsEvent): void; |
| onMouseDown | 鼠标按下 | (event: MapsEvent): void; |
| onDragStart | 拖拽开始 | `(event: MapsEvent): void;` |
| onDragging | 拖拽中 | `(event: MapsEvent): void;` |
| onDragEnd | 拖拽结束 | `(event: MapsEvent): void;` |
| onChange | 属性发生变化时 | `(event: { type: string, target: any }): void;` |