Icon - YouScene Documentation

Icon

图标

new YS.Icon(options)

图标

Name Type Description

options

Object

对象有下面这些属性:

Name	Type	Default	Description
`id`	String		唯一标识
`icon`	String		图标url地址,不显示icon的话请设为''
`position`	XYZ		经纬度（角度）object = {x:112,y:12,z:100}
`name`	String		optional 名称
`visible`	Boolean	`true`	optional 是否可见
`pixelOffset`	XY	`new XY(0, 0)`	optional 像素偏移
`width`	Number		optional 宽度，单位像素，未定义时使用原生宽度
`height`	Number		optional 高度，单位像素，未定义时使用原生高度
`scale`	Number	`1.0`	optional 应用于图标大小的比例，默认为1.0
`fontFamily`	String	`VT.ICON_DEFAULT_FONT`	optional 字体,如宋体
`fontSize`	Number	`14`	optional 字体大小,单位像素
`fontColor`	Color	`{r:1,g:1,b:1,a:1}`	optional 字体颜色，默认白色
`labelOffset`	XY	`{x:14,y:5}`	optional 文字偏移量,像素为单位
`labelPosition`	LabelPosition	`LabelPosition.NONE`	optional 文字默认在图标的位置，这个不为NONE时labelOffset无效，自动计算
`labelGap`	Number	`10`	optional 使用labelPosition时文字和图标的间隔
`showLabelBackground`	Boolean	`false`	optional 文字是否需要背景填充
`eyeOffset`	XYZ	`{x:0, y:0, z:0}`	optional 获取或设置眼睛坐标中标签的偏移量。眼睛坐标是左手坐标系，其中x指向观察者的右侧，y指向上, z指向屏幕
`labelBackgroundColor`	Color	`{r: 0.165,g:0.165,b:0.165,a:0.165}`	optional 文字填充背景的颜色
`labelBackgroundPadding`	XY	`{x: 7, y: 5}`	optional 文字填充的padding
`labelOutlineColor`	Color	`{r: 0,g:0,b:0,a:0}`	optional 文字边框的颜色
`labelOutlineWidth`	Number	`1`	optional 文字边框的宽度
`horizontalOrigin`	HorizontalOrigin	`HorizontalOrigin.CENTER`	optional 图标的中心点相对图标的的水平位置
`verticalOrigin`	VerticalOrigin	`VerticalOrigin.CENTER`	optional 图标的中心点相对图标的的竖直位置
`nameAlwaysVisible`	Boolean	`false`	optional 名称是否一直可见，不显示图标时无效
`heightReference`	HeightReference	`HeightReference.NONE`	optional 表示相对于地形的位置。

Implements:

Feature

Example:

//定义icon
var icon = new YS.Icon({
              id: 'icon1',
              icon: 'http://ys.infoearth.com:9090/images/model/%E6%8B%8D%E7%85%A7.png',
              position: {
                  x: 114,
                  y: 30,
                  z: 500
              },
              name: '这里有icon',
              fontColor: new YS.Color(0, 0, 1, 1),
              nameAlwaysVisible: false
          });

See:

PinIcon

Members

staticYS.Icon.labelOffset : XY

文字的偏移量

eyeOffset : Object

获取或设置眼睛坐标中图标的偏移量。眼睛坐标是左手坐标系，其中x指向观察者的右侧，y指向上, z指向屏幕。

Default Value: {x:0, y:0, z:0}

fontColor : Color

获取或设置字体颜色

Default Value: Color.Black

fontFamily : String

获取或设置字体

Default Value: 'Microsoft YaHei,宋体,Serif,Arial,Times'

fontSize : Number

获取或设置字体大小

Default Value: 14

height : Number

获取或设置图标高度.

heightReference : HeightReference

获取或设置贴地属性.

Default Value: HeightReference.NONE

horizontalOrigin : HorizontalOrigin

图标中心点相对图标的水平位置

Default Value: HorizontalOrigin.CENTER

icon : String

获取或设置图标链接.

labelBackgroundColor : Color

文字背景框的颜色

Default Value: {r: 0.165, g: 0.165, b: 0.165, a: 0.165}

labelBackgroundPadding : XY

文字背景框的间距

Default Value: {x: 7, y: 5}

labelGap : Number

获取或设置使用labelPosition名称和图标的间隔

Default Value: 10

labelOutlineColor : Color

文字的边框颜色

Default Value: {r: 0, g: 0, b: 0, a: 0}

labelOutlineWidth : Number

文字的边框宽度

Default Value: 1

labelPosition : LabelPosition

获取或设置名称相对于图标所在的位置

Default Value: LabelPosition.NONE

name : String

获取或设置图标文本.

Implements:

Feature#name

nameAlwaysVisible : Boolean

获取或设置名称是否一直可见，缺省为false，鼠标移动到名称上时可见

Default Value: false

pixelOffset : Object

获取或设置偏移距离

Default Value: {x: 0, y: 0}

position : XYZ

获取或设置图标位置.

scale : Number

获取或设置图标大小比例.

showLabelBackground : Boolean

是否显示文字背景框

Default Value: false

verticalOrigin : VerticalOrigin

图标中心点相对图标的竖直位置

Default Value: VerticalOrigin.CENTER

visible : Boolean

获取或设置要素显示和隐藏.

Implements:

Feature#visible

width : Number

获取或设置图片宽度.

Methods

exportKml()

Returns:

Promise

flashing()

Icon闪烁

getBoundingRect(ys) → Object

Feature的外接矩形，此方法在Icon和Label类中被重写

Name	Type	Description
`ys`	YouScene	YouScene对象

Returns:

Implements:

Feature#getBoundingRect

Events

visibleChanged

图标显示/隐藏状态切换事件

Implements:

Feature#event:visibleChanged