SignEffect - Cesium Documentation

SignEffect

轨迹特效继承自PlotGeoEffectBase

new Cesium.SignEffect(options)

Name Type Description

options

Object

optional Object with the following properties:

Name Type Default Description

isUsePlotVisible Boolean true optional 是否受标号对象的显隐影响

visible Boolean false optional 是否显示

scene Scene optional 设置场景

geoGraphicObject geoGraphicObject optional 设置绑定的标号

position MPoint3D optional 设置特效位置,未设置则先从标号中获取，如果未绑定标号，则需要通过updateEffect(options)接口，更新位置点。

scale Number 1 optional 标牌大小缩放比例

texts Array.<String> ["This is a sign"] optional 标牌文本信息数组

createdMode Number 0 optional 标牌创建模式；0-（需要设置texts、textStyles、frameStyle三个参数）；1-（需要设置texts，templateUrl）

textStyles Array.<Object> [] optional 标牌文本样式数组(createdMode == 0 生效)

textStyles[i].color String "rgba(255, 0, 0, 1)" optional 标牌文本颜色

textStyles[i].fontFamily String "Microsoft YaHei" optional 标牌文本字体 Arial | Helvetica | ...

textStyles[i].fontStyle String "normal" optional 标牌文本样式 itailc | oblique

textStyles[i].fontSize Number 16 optional 标牌文本大小

textStyles[i].fontWeight String "400" optional 标牌文本粗细 normal | bold | bolder | lighter | 100 | 200 | 300 | ... | 900

contentFrameStyle

Object

{}

optional 标牌内容框样式(createdMode == 0 生效)

Name	Type	Default	Description
`visible`	Boolean	`true`	optional 是否显示
`lineWidth`	Number	`2`	optional 线宽
`lineColor`	String	`"rgba(255, 0, 0, 1)"`	optional 线色
`backgroundColor`	String	`"rgba(255, 0, 0, 0.4)"`	optional 背景色

trayStyle

Object

{}

optional 标牌托样式(createdMode == 0 生效)

Name	Type	Default	Description
`visible`	Boolean	`true`	optional 是否显示
`lineWidth`	Number	`2`	optional 线宽
`lineColor`	String	`"rgba(255, 0, 0, 1)"`	optional 线色

barStyle

Object

{}

optional 标牌柄样式(createdMode == 0 生效)

Name	Type	Default	Description
`visible`	String	`true`	optional 是否显示
`lineWidth`	String	`2`	optional 线宽
`lineColor`	String	`"rgba(255, 0, 0, 1)"`	optional 线色
`barHeight`	String	`40`	optional 标牌柄高度

templateUrl String "" optional 用户自定义标牌模板资源路径(createdMode == 1 生效)

pixScale Number 2 optional 标牌像素缩放比例（清晰度）(createdMode == 1 生效)

Members

createdMode : Number

标牌创建模式,可设置为0或1; 0-参数创建（需要设置texts、textStyles、frameStyle三个参数）；1-模板创建（需要设置texts，templateUrl）

id : String

特效id

isSolid : Boolean

标牌是否立体

offset2D : Number

标号标牌偏移量

offset3D : Number

模型标牌偏移量

pixScale : Number

标牌像素缩放比例（清晰度）,当createdMode == 1时生效

readyPromise : Promise.<Image>

标牌资源准备完成

scale : Number

标牌大小缩放比例

signEffectType : SignEffectType

标牌类型，当createdMode == 0时生效

templateUrl : String

标牌模板资源路径，当createdMode == 1时生效

Methods

destroy()

释放资源

fromJSON(jsonObj)

Json对象转特效对象, 注意：json对象中没有包含scene和geoGraphicObject对象，需要调用对应接口设置（未完成）

Name	Type	Description
`jsonObj`	Object	json对象

getBarStyle() → Object

获取标牌柄样式

Returns:

标牌标牌柄样式(setBarStyle()接口)

getContentFrameStyle() → Object

获取标牌内容框样式

Returns:

标牌内容框样式(object详见setContentFrameStyle()接口)

getTexts() → Array.<String>

获取标牌文本数组

Returns:

文本数组

getTextStyle() → Object

获取标牌标题样式

Returns:

标牌标题样式(object详见setTitleStyle()接口)

getTitle() → String

获取标牌标题

Returns:

标牌标题

getTitleFrameStyle() → Object

获取标牌标题框样式

Returns:

标牌标题框样式(object详见setTitleFrameStyle()接口)

getTitleStyle() → Object

获取标牌标题样式

Returns:

标牌标题样式(object详见setTitleStyle()接口)

getTrayStyle() → Object

获取标牌托盘样式

Returns:

标牌托盘样式(setTrayStyle()接口)

setBarStyle(barStyle)

设置标牌柄样式，（createMode == 1）时生效

Name Type Description

barStyle

Object

标牌柄样式

Name	Type	Description
`visible`	Boolean	是否显示
`lineWidth`	Number	线宽（像素）
`lineColor`	String	线色（例："rgba(255, 0, 0, 1)"）
`barHeight`	String	柄高（像素）

setContentFrameStyle(contentFrameStyle)

设置标牌内容框样式，（createMode == 1）时生效

Name Type Description

contentFrameStyle

Object

标牌内容框样式

Name	Type	Description
`visible`	Boolean	是否显示
`lineWidth`	Number	线宽（像素）
`lineColor`	String	线色（例："rgba(255, 0, 0, 1)"）
`backgroundColor`	String	背景色（例例："rgba(255, 0, 0, 0.4)"）
`arcCorner`	String	是否圆角（boolean）
`image`	String	背景图片（例："http://localhost:8090/iserver/mgis/situationSimulation/Sign/科技.png"）

setTexts(texts)

设置标牌文本数组

Name	Type	Description
`texts`	Array.<String>	文本数组

setTextStyle(textStyle)

设置标牌内容文本样式，(createMode == 1)时生效

Name Type Description

textStyle

Object

标牌内容文本样式

Name	Type	Description
`visible`	Boolean	是否显示
`color`	Number	文字颜色(例："rgba(255, 0, 0, 1)")
`fontFamily`	String	字体系列
`fontStyle`	String	字体样式(例:1.默认值:nomal(正常) 2.italic(倾斜))
`fontSize`	String	字体大小(例:22)
`fontWeight`	String	字体粗细(例：1.关键字nomal(正常)bold(加粗) 2.纯数字100-900的整百数 400(正常) 700加粗)

setTitle(title)

设置标牌标题

Name	Type	Description
`title`	String	标牌标题

setTitleFrameStyle(titleFrameStyle)

设置标牌标题框样式，（createMode == 1）时生效

Name Type Description

titleFrameStyle

Object

标牌标题框样式

Name	Type	Description
`visible`	Boolean	是否显示
`lineWidth`	Number	线宽（像素）
`lineColor`	String	线色（例："rgba(255, 0, 0, 1)"）
`backgroundColor`	String	背景色（例例："rgba(255, 0, 0, 0.4)"）
`arcCorner`	String	是否圆角（boolean）
`image`	String	背景图片（例："http://localhost:8090/iserver/mgis/situationSimulation/Sign/科技.png"）

setTitleStyle(titleStyle)

设置标牌标题样式，（createMode == 1）时生效

Name Type Description

titleStyle

Object

标牌标题样式

Name	Type	Description
`visible`	Boolean	是否显示
`color`	Number	文字颜色（例："rgba(255, 0, 0, 1)"）
`fontFamily`	String	字体系列
`fontStyle`	String	字体样式（例:1.默认值:nomal(正常) 2.italic(倾斜)）
`fontSize`	String	字体大小（例:22）
`fontWeight`	String	字体粗细（例：1.关键字nomal(正常)bold(加粗) 2.纯数字100-900的整百数 400(正常) 700加粗)

setTrayStyle(trayStyle)

设置标牌托盘样式，（createMode == 1）时生效

Name Type Description

trayStyle

Object

标牌托盘样式

Name	Type	Description
`visible`	Boolean	是否显示
`lineWidth`	Number	线宽（像素）
`lineColor`	String	线色（例："rgba(255, 0, 0, 1)"）

toJSON() → String

特效对象转Json对象, 注意：json对象中没有包含scene和geoGraphicObject对象（未完成）

Returns:

Json字符串

updateEffect(options)

Name Type Description

options

Object

optional Object with the following properties:

Name	Type	Description
`point`	MPoint3D	optional 位置点