TextSymbol - CooSDK Documentation

new CooSDK.TextSymbol(props)

文字符号化对象。

Name Type Description

props

Object

optional

包含如下属性的Object：

Name	Type	Default	Description
`alignmentMode`	EnumAlignment	`EnumAlignment.CENTER_DOWN`	optional 文字的对齐方式。
`axisAlignment`	EnumTextAxis	`EnumTextAxis.AUTO`	optional 文字旋转模式。
`backColor`	ColorObj	`new ColorObj(1.0, 0.0, 0.0, 1)`	optional 背景颜色。
`backdropMarginDown`	Number	`0.0`	optional 背景图片下边距大小。
`backdropMarginLeft`	Number	`0.0`	optional 背景图片左边距大小。
`backdropMarginRight`	Number	`0.0`	optional 背景图片右边距大小。
`backdropMarginUp`	Number	`0.0`	optional 背景图片上边距大小。
`characterMode`	EnumCharacterMode	`EnumCharacterMode.CAMERA`	optional 文字显示大小的变化模式。
`characterScale`	Number	`1.0`	optional 文字按相机缩放因子，当characterMode=EnumCharacterMode.MIX时生效。
`characterSize`	Number	`10`	optional 文字在场景中显示的大小。
`clusterAlignmentMode`	EnumAlignment	`EnumAlignment.CENTER_DOWN`	optional 聚合后的标注文字的对齐方式,如果不配置则使用alignmentMode的值。
`clusterAxisAlignment`	EnumTextAxis	`EnumTextAxis.AUTO`	optional 聚合后的标注文字旋转模式，如果不配置则使用axisAlignment的值。
`clusterBackdropSize`	Number	`5`	optional 聚合后的标注图标大小。
`clusterCharacterMode`	EnumCharacterMode	`EnumCharacterMode.CAMERA`	optional 聚合后的标注文字显示大小的变化模式，如果不配置则使用characterMode的值。
`clusterCharacterSize`	Number	`10`	optional 聚合后的文字在场景中显示的大小，如果不配置则使用characterSize的值。
`clusterSize`	Number	`16`	optional 聚合后标注文字锐化程度，该值越大，聚合文字显示越精细，如果不配置则使用size的值。
`clusterIsEmbolden`	Boolean	`false`	optional 聚合后标注是否加粗文字，如果不配置则使用isEmbolden的值。
`clusterIsHorizontal`	Boolean	`true`	optional 聚合后标注文字是否水平排列，如果不配置则使用isHorizontal的值。
`clusterIsTransform`	Boolean	`false`	optional 聚合后标注是否斜体文字，如果不配置则使用isTransform的值。
`clusterIsUnderline`	Boolean	`false`	optional 聚合后标注是否给文字添加下划线，如果不配置则使用isUnderline的值。
`clusterIsVisibleText`	Boolean	`true`	optional 聚合后标注是否显示文字。
`clusterImageUrl`	String	`null`	optional 聚合标注文字背景图片地址，可以是本地绝对路径，也可以是网络路径，支持base64编码，但大小不可超过1MB。
`content`	String	`null`	optional 显示文字的内容，可以是字符串，也可以是表达式。
`featureLiftUp`	Number \| String	`0.0`	optional 符号对象相当于要素的抬高高度或者属性字段。
`fieldPrecision`	Number	`8`	optional 字段精度，如文字为数字形式，表示小数点后几位。
`fillingColor`	ColorObj	`new ColorObj(1, 0.13, 0.25, 1.0)`	optional 文字颜色。
`fontUrl`	String	`"C:\\Windows\\Fonts\\msyh.ttf"`	optional 文字字体的本地绝对路径。
`groundLineStipple`	Number	`-1`	optional 接地线样式，-1为实线，1~65535为虚线。
`groundLineWidth`	Number	`1.0`	optional 接地线宽度。
`horizonSpacingSize`	Number	`0.0`	optional 字符间隔距离。
`iconAlignmentType`	EnumIconAlignmentType	`EnumIconAlignmentType.LEFT`	optional 图标相对于文字的位置。
`iBAlignmentType`	EnumIBAlignmentType	`EnumIBAlignmentType.CENTER`	optional 图标与文字背景对齐方式。
`iconUrl`	String	`null`	optional 图标路径，支持base64编码，但大小不可超过1MB。
`iconWidth`	Number	`8`	optional 图标宽度，单位:px。
`iconHeight`	Number	`8`	optional 图标高度，单位:px 。
`iconMargin`	Number	`0`	optional 图标与文字之间的边距。
`imageUrl`	String	`null`	optional 背景图片地址，可以是本地绝对路径，也可以是网络路径，支持base64编码，但大小不可超过1MB。
`isAddGroundLine`	Boolean	`true`	optional 文字是否添加接地线。
`isBack`	Boolean	`false`	optional 文字是否添加背景。
`isCrossData`	Boolean	`true`	optional 是否参与多Data对象抽稀避让计算。
`isDepthTest`	Boolean	`true`	optional 是否给文字加深度测试。
`isEmbolden`	Boolean	`false`	optional 是否加粗文字。
`isHorizontal`	Boolean	`true`	optional 文字是否水平排列。
`isOutline`	Boolean	`false`	optional 文字是否有轮廓线。
`isSyncVisible`	Boolean	`true`	optional 是否在抽稀时，同步显隐文字符号和点符号。
`isTransform`	Boolean	`false`	optional 是否斜体文字。
`isUnderline`	Boolean	`false`	optional 是否给文字添加下划线。
`isVacuate`	Boolean	`false`	optional 是否进行文字抽稀。
`isVisibleIcon`	Boolean	`true`	optional 是否显示图标。
`isVisibleText`	Boolean	`true`	optional 是否显示文字。
`lineColor`	ColorObj	`new ColorObj(0.6, 0.6, 0.6, 1.0)`	optional 接地线颜色。
`outlineColor`	ColorObj	`new ColorObj(0.0, 0.0, 0.0, 1)`	optional 文字轮廓线颜色。
`outlineOffset`	Number	`0.8`	optional 文字轮廓线偏移值。范围0.01~1。
`size`	Number	`64`	optional 文字锐化程度，该值越大，文字显示越精细。
`vacuateDensity`	Number	`25`	optional 文字抽稀密度。
`vacuateRange`	Number	`20`	optional 文字四周扩充范围，用于碰撞检测，单位:px。
`vacuateHeight`	Number	`1000`	optional 在垂直俯视的情况下,视点低于该高度时，不进行文字抽稀；高于该高度时，进行文字抽稀计算。
`weightField`	String	`null`	optional 针对当前对象权重字段名称。

Demo:

CooSDK Application 矢量数据符号化加载demo

Members

axisAlignment : EnumTextAxis

获取或者设置文字旋转模式。

Default Value: EnumTextAxis.AUTO

backColor : ColorObj

获取或者设置文字背景色。

Default Value: new ColorObj(1.0, 0.0, 0.0, 1)

backdropMarginDown : Number

获取或者设置背景边框下侧大小。

Default Value: 0.0

backdropMarginLeft : Number

获取或者设置背景边框左侧大小。

Default Value: 0.0

backdropMarginRight : Number

获取或者设置背景边框右侧大小。

Default Value: 0.0

backdropMarginUp : Number

获取或者设置背景边框上侧大小。

Default Value: 0.0

characterMode : EnumCharacterMode

获取或者设置文字显示大小的变化模式。

Default Value: EnumCharacterMode.CAMERA

characterScale : Number

获取或者设置文字按相机缩放因子，当characterMode=EnumCharacterMode.MIX时生效。

Default Value: 1.0

characterSize : Number

获取或者设置文字在场景中显示的大小。

Default Value: 10

clusterAlignmentMode : EnumAlignment

获取或者设置聚合后的标注文字的对齐方式，如果不配置则使用alignmentMode的值。

Default Value: EnumAlignment.CENTER_CENTER

clusterAxisAlignment : EnumTextAxis

获取或者设置聚合后的标注文字旋转模式，如果不配置则使用axisAlignment的值。

Default Value: EnumTextAxis.AUTO

clusterBackdropSize : Number

获取或者设置聚合后的标注图标大小。

Default Value: 5

clusterCharacterMode : EnumCharacterMode

获取或者设置聚合后的标注文字显示大小的变化模式，如果不配置则使用characterMode的值。

Default Value: EnumCharacterMode.CAMERA

clusterCharacterSize : Number

获取或者设置聚合后的文字在场景中显示的大小，如果不配置则使用characterSize的值。

Default Value: 10

clusterIsEmbolden : Boolean

获取或者设置聚合后标注是否加粗文字，如果不配置则使用isEmbolden的值。

Default Value: false

clusterIsHorizontal : Boolean

获取或者设置聚合后标注文字是否水平排列，如果不配置则使用isHorizontal的值。

Default Value: true

clusterIsTransform : Boolean

获取或者设置聚合后标注是否斜体文字，如果不配置则使用isTransform的值。

Default Value: false

clusterIsUnderline : Boolean

获取或者设置聚合后标注是否给文字添加下划线，如果不配置则使用isUnderline的值。

Default Value: false

clusterIsVisibleText : boolean

获取或者设置聚合后标注是否显示文字。

Default Value: true

clusterSize : Number

获取或者设置聚合后标注文字锐化程度，该值越大，聚合文字显示越精细，如果不配置则使用size的值。

Default Value: 16

content : String

获取或者设置展示的文字或者某属性字段值。

Default Value: null

featureLiftUp : Number|String

获取或者设置接地线抬升值。

Default Value: 0.0

fieldPrecision : Number

获取或者设置字段精度，如文字为数字形式，表示小数点后几位。

Default Value: 8

fillingColor : ColorObj

获取或者设置文字颜色(RGBA)。

Default Value: new ColorObj(1, 0.13, 0.25, 1.0)

fontUrl : String

获取或者设置文字字体路径。

Default Value: "C:\\Windows\\Fonts\\msyh.ttf"

groundLineWidth : Number

获取或者设置接地线宽度。

Default Value: 1

horizonSpacingSize : Number

获取或者设置文字字符水平间隔距离。

Default Value: 0.0

iconAlignmentType : EnumIconAlignmentType

获取或者设置图标相对于文字的位置。

Default Value: EnumIconAlignmentType.LEFT

iconHeight : Number

获取或者设置图标高度，单位:px 。

Default Value: 8

iconMargin : Number

获取或者设置图标与文字之间的边距。

Default Value: 0

iconUrl : String

获取或者设置图标路径，支持base64编码，但大小不可超过1MB。

Default Value: null

iconWidth : Number

获取或者设置图标宽度，单位:px。

Default Value: 8

imageUrl : String

获取或者设置背景图片地址，支持base64编码，但大小不可超过1MB。

Default Value: null

isAddGroundLine : Boolean

获取或者设置是否开启接地线。

Default Value: true

isBack : Boolean

获取或者设置背景是否开启。

Default Value: false

isCrossData : Boolean

获取或者设置是否参与多Data对象抽稀避让计算。

Default Value: true

isDepthTest : Boolean

获取或者设置是否开启深度测试。

Default Value: true

isEmbolden : Boolean

获取或者设置文字是否加粗。

Default Value: false

isHorizontal : Boolean

获取或者设置文字是否水平排列。

Default Value: true

isOutline : Boolean

获取或者设置文字是否有轮廓线。

Default Value: false

isSyncVisible : Boolean

获取或者设置是否在抽稀时,同步显隐文字符号和点符号。

Default Value: true

isTransform : Boolean

获取或者设置文字是否斜体。

Default Value: false

isUnderline : Boolean

获取或者设置文字是否加下划线。

Default Value: false

isVacuate : Boolean

获取或者设置是否进行文字抽稀。

Default Value: false

isVisibleIcon : Boolean

获取或者设置是否显示图标。

Default Value: true

isVisibleText : Boolean

获取或者设置是否显示文字。

Default Value: true

lineColor : ColorObj

获取或者设置接地线颜色(RGBA)。

Default Value: new ColorObj(0.6, 0.6, 0.6, 1.0)

outlineColor : ColorObj

获取或者设置文字轮廓线颜色。

Default Value: new ColorObj(0.0, 0.0, 0.0, 1)

outlineOffset : Number

获取或者设置文字轮廓线偏移值。范围0.01~1。

Default Value: 0.8

size : Number

获取或者设置文字锐化程度，该值越大，文字显示越精细。

Default Value: 16

vacuateDensity : Number

获取或者设置文字抽稀密度。

Default Value: 25

vacuateHeight : Number

获取或者设置在垂直俯视的情况下,视点低于该高度时,不进行文字抽稀;高于该高度时,进行文字抽稀计算。

Default Value: 1000

vacuateRange : Number

获取或者设置文字四周扩充范围，用于碰撞检测，单位:px。

Default Value: 20

weightField : String

获取或者设置针对当前对象权重字段名称。

Default Value: null