# MapGIS Client for JavaScript API

Cesium MapboxGL Leaflet OpenLayers
API文档

#### # new SimpleLineSymbol(options)

简单线符号，支持线几何对象，参考示例：[线符号样式]
[ES5引入方式]：
Zondy.Symbol.SimpleLineSymbol()
[ES6引入方式]：
import { SimpleLineSymbol } from "@mapgis/webclient-common"

#### 参数:

名称 | 类型 | 默认值 | 描述
--- | --- | --- | ---
`options` | Object |  | 线符号样式
`width` | Number | 1 | 线符号宽度，默认为1
`color` | Color | String | new Color(255, 0, 0, 1) | 线符号颜色，默认为红色
`cap` | String | 'round' | 线的起点和终点样式,可选参数 "butt"|"round"|"square" butt：线的首尾为直角，round：线的首尾为圆形，square：线的首尾会超出一部分，且为矩形
`join` | String | 'round' | 线的拐角样式，可选参数 "miter"|"round"|"bevel"， miter：线的拐角为直角，round：线的拐角为圆角，bevel：线的拐角为斜角
`miterLimit` | Number | 2 | 斜接的宽度与线宽的最大允许比率,防止转角过小问题
`style` | String | 'solid' | 线样式,默认'solid',可选"dash"|"dash-dot"|"dot"|"long-dash"|"long-dash-dot"|"long-dash-dot-dot"|"none"|"short-dash"|"short-dash-dot"|"short-dash-dot-dot"|"short-dot"|"solid"
`marker` | LineSymbolMarker |  | 线端点样式

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 7

##### 支持如下方法：

`1、克隆并返回新的符号对象`
`2、导出一个JSON对像`
[3、通过json构造并返回一个新的SimpleLineSymbol对象]

##### 示例

创建线符号样式对象

    // ES5引入方式
    const { SimpleLineSymbol } = Zondy.Symbol
    const { Color } = Zondy
    // ES6引入方式
    import { SimpleLineSymbol, Color } from "@mapgis/webclient-common"
    const simpleLineSymbol = new SimpleLineSymbol({
      // 线符号颜色
      color: new Color(255, 0, 0, 1),
      // 线符号宽度
      width: 2,
      // 线首尾角样式
      cap: "round",
      // 线接角样式
      join: "round",
      // 斜接的宽度与线宽的最大允许比率
      miterLimit: 2,
      // 线样式
      style: "solid"
    });

### 继承关系

- LineSymbol

### 成员变量

类型: String

#### # cap

首尾角样式

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 66

类型: Color

#### # color

颜色

Inherited From:
  - LineSymbol#color

查看源代码 common/base/symbol/LineSymbol.js, line 19

类型: String

#### # join

接角样式

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 71

类型: LineSymbolMarker

#### # marker

线端点样式

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 86

类型: Number

#### # miterLimit

斜接的宽度与线宽的最大允许比率

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 76

类型: String

#### # style

线样式

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 81

类型: String

#### # type

符号类型

Overrides:
  - LineSymbol#type

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 61

类型: Number

#### # width

线宽度

Inherited From:
  - LineSymbol#width

查看源代码 common/base/symbol/LineSymbol.js, line 32

### 方法

#### # static fromJSON(json)

通过json构造并返回一个新的SimpleLineSymbol对象

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`json` | Object | 符号的实例化JSON

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 105

返回值:

新的SimpleLineSymbol对象

类型: SimpleLineSymbol

##### 示例

    <caption><h7>通过json构造并返回一个新的SimpleLineSymbol对象</h7></caption>

#### # clone()

克隆并返回新的符号对象

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 114

返回值:

克隆后的新符号对象

类型: SimpleLineSymbol

#### # toJSON()

导出为JSON对象

Overrides:
  - LineSymbol#toJSON

查看源代码 common/base/symbol/SimpleLineSymbol.js, line 122

返回值:

JSON对像

类型: Object
构造函数
成员变量
方法
事件