Class: Symbol

Symbol

new Symbol(options)

base/symbol/Symbol.js, line 7

符号基类,定义颜色、类型与引擎扩展参数等通用样式能力,是所有二维/三维符号实现的统一入口。

Name Type Default Description
options Object {} 可选

构造参数

Name Type Default Description
id String 可选

符号id

color Color | String | Array | Object new Color(0, 0, 0, 0.25) 可选

颜色

extensionOptions Object {} 可选

符号的扩展参数。可以通过该属性传入引擎原生图元的样式参数。 该参数的优先级高于二维符号、三维符号图层自身属性的优先级(如果有冲突时采用extendOptions中指定的)。符号类型与原生图元类型的对照表参见: 符号

See:
  • 符号

Example
设置颜色的几种方式
1.结构化形式
symbol.color = new Color(0, 0, 0, 0.25)
symbol.color ={
   red:255,
   green:0,
   blue:0,
   alpha:1
}
2.数组
symbol.color = [255,0,0]
symbol.color = [255,0,0,1]
3.字符串
symbol.color = '#ff0000'
symbol.color = 'rgba(255,0,0,1)'

Members

colorColor

颜色

extensionOptionsObject

符号的额外构造参数,该构造参数是地图引擎的额外构造参数,在此设置了之后,会覆盖该符号转换好地图引擎的构造参数

Default Value:
{}

idString

符号id

typeString

符号类型

Methods

clone(){Symbol}

base/symbol/Symbol.js, line 109

克隆并返回新的符号对象

Returns:
Type Description
Symbol 克隆后的新符号对象

toJSON(){Object}

base/symbol/Symbol.js, line 96

导出为JSON对象

Returns:
Type Description
Object JSON对像

Symbol.fromJSON(json)

base/symbol/Symbol.js, line 71

通过json文件构建symbol

Name Type Description
json Object

符号的实例化JSON

Example
// ES5引入方式
const { Symbol, Color } = zondy

// ES6引入方式
import { Symbol, Color } from "@mapgis/webclient-common"
const simpleLineSymbol = Symbol.fromJSON({
    type:'simple-line',
    color:new Color(255,255,255,1),
    width:2
})