KBE3D / KBCore / Cesium / LabelGraphics

类: LabelGraphics

Describes a two dimensional label located at the position of the containing Entity. <p> <div align='center'> <img src='/Images/Label.png' width='400' height='300' /><br /> Example labels </div> </p>

参数

Object describing initialization options

属性

definitionChanged

readonly definitionChanged: Event

Gets the event that is raised whenever a property or sub-property is changed or modified.

---

show

show: Property | undefined

Gets or sets the boolean Property specifying the visibility of the label.

---

text

text: Property | undefined

Gets or sets the string Property specifying the text of the label. Explicit newlines '\n' are supported.

---

font

font: Property | undefined

Gets or sets the string Property specifying the font in CSS syntax.

---

style

style: Property | undefined

Gets or sets the Property specifying the LabelStyle.

---

scale

scale: Property | undefined

Gets or sets the numeric Property specifying the uniform scale to apply to the image. A scale greater than <code>1.0</code> enlarges the label while a scale less than <code>1.0</code> shrinks it. <p> <div align='center'> <img src='/Images/Label.setScale.png' width='400' height='300' /><br/> From left to right in the above image, the scales are <code>0.5</code>, <code>1.0</code>, and <code>2.0</code>. </div> </p>

---

showBackground

showBackground: Property | undefined

Gets or sets the boolean Property specifying the visibility of the background behind the label.

---

backgroundColor

backgroundColor: Property | undefined

Gets or sets the Property specifying the background Color.

---

backgroundPadding

backgroundPadding: Property | undefined

Gets or sets the Cartesian2 Property specifying the label's horizontal and vertical background padding in pixels.

---

pixelOffset

pixelOffset: Property | undefined

Gets or sets the Cartesian2 Property specifying the label's pixel offset in screen space from the origin of this label. This is commonly used to align multiple labels and labels at the same position, e.g., an image and text. The screen space origin is the top, left corner of the canvas; <code>x</code> increases from left to right, and <code>y</code> increases from top to bottom. <p> <div align='center'> <table border='0' cellpadding='5'><tr> <td align='center'><code>default</code><br/><img src='/Images/Label.setPixelOffset.default.png' width='250' height='188' /></td> <td align='center'><code>l.pixeloffset = new Cartesian2(25, 75);</code><br/><img src='/Images/Label.setPixelOffset.x50y-25.png' width='250' height='188' /></td> </tr></table> The label's origin is indicated by the yellow point. </div> </p>

---

eyeOffset

eyeOffset: Property | undefined

Gets or sets the Cartesian3 Property specifying the label's offset in eye coordinates. Eye coordinates is a left-handed coordinate system, where <code>x</code> points towards the viewer's right, <code>y</code> points up, and <code>z</code> points into the screen. <p> An eye offset is commonly used to arrange multiple labels or objects at the same position, e.g., to arrange a label above its corresponding 3D model. </p> Below, the label is positioned at the center of the Earth but an eye offset makes it always appear on top of the Earth regardless of the viewer's or Earth's orientation. <p> <div align='center'> <table border='0' cellpadding='5'><tr> <td align='center'><img src='/Images/Billboard.setEyeOffset.one.png' width='250' height='188' /></td> <td align='center'><img src='/Images/Billboard.setEyeOffset.two.png' width='250' height='188' /></td> </tr></table> <code>l.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);</code><br /><br /> </div> </p>

---

horizontalOrigin

horizontalOrigin: Property | undefined

Gets or sets the Property specifying the HorizontalOrigin.

---

verticalOrigin

verticalOrigin: Property | undefined

Gets or sets the Property specifying the VerticalOrigin.

---

heightReference

heightReference: Property | undefined

Gets or sets the Property specifying the HeightReference.

---

fillColor

fillColor: Property | undefined

Gets or sets the Property specifying the fill Color.

---

outlineColor

outlineColor: Property | undefined

Gets or sets the Property specifying the outline Color.

---

outlineWidth

outlineWidth: Property | undefined

Gets or sets the numeric Property specifying the outline width.

---

translucencyByDistance

translucencyByDistance: Property | undefined

Gets or sets NearFarScalar Property specifying the translucency of the label based on the distance from the camera. A label's translucency will interpolate between the NearFarScalar#nearValue and NearFarScalar#farValue while the camera distance falls within the lower and upper bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the label's translucency remains clamped to the nearest bound.

---

pixelOffsetScaleByDistance

pixelOffsetScaleByDistance: Property | undefined

Gets or sets NearFarScalar Property specifying the pixel offset of the label based on the distance from the camera. A label's pixel offset will interpolate between the NearFarScalar#nearValue and NearFarScalar#farValue while the camera distance falls within the lower and upper bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the label's pixel offset remains clamped to the nearest bound.

---

scaleByDistance

scaleByDistance: Property | undefined

Gets or sets near and far scaling properties of a Label based on the label's distance from the camera. A label's scale will interpolate between the NearFarScalar#nearValue and NearFarScalar#farValue while the camera distance falls within the lower and upper bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the label's scale remains clamped to the nearest bound. If undefined, scaleByDistance will be disabled.

---

distanceDisplayCondition

distanceDisplayCondition: Property | undefined

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this label will be displayed.

---

disableDepthTestDistance

disableDepthTestDistance: Property | undefined

Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain. When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.

方法

clone()

clone(result?: LabelGraphics): LabelGraphics

Duplicates this instance.

参数

result?

LabelGraphics

The object onto which to store the result.

返回

LabelGraphics

The modified result parameter or a new instance if one was not provided.

---

merge()

merge(source: LabelGraphics): void

Assigns each unassigned property on this object to the value of the same property on the provided source object.

参数

source

LabelGraphics

The object to be merged into this object.

返回

void

构造函数

构造函数

new LabelGraphics(options?: ConstructorOptions): LabelGraphics

参数

options?

ConstructorOptions

返回

LabelGraphics