Label

標簽將繪制定位在三維場景中的視區對齊文本。不應直接使用此構造函數，而應通過調用LabelCollection#add來創建標簽。

new Label()

Throws

DeveloperError : translucencybydistance.far必須大于translucencybydistance.near。
DeveloperError : pixeloffsetscaleByDistance.far必須大于pixeloffsetscaleByDistance.near。
DeveloperError : 距離displayCondition.far必須大于距離displayCondition.near

See:

Members

(static) enableRightToLeftDetection : Boolean

確定是否運行與標簽文本從右向左語言匹配的算法

Default Value: false

Examples:

// Example 1.
// Set a label's rightToLeft before init
bmgl.Label.enableRightToLeftDetection = true;
var myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: '?? ???? ?????? \n ?????? ?????? ????',
  }
});

// Example 2.
var myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: 'English text'
  }
});
// Set a label's rightToLeft after init
bmgl.Label.enableRightToLeftDetection = true;
myLabelEntity.text = '???? ???';

backgroundColor : Color

獲取或設置此標簽的背景色。

Default Value: new Color(0.165, 0.165, 0.165, 0.8)

backgroundPadding : Cartesian2

獲取或設置此標簽的背景填充（以像素為單位）。x值控制水平填充，y值控制垂直填充。

Default Value: new Cartesian2(7, 5)

disableDepthTestDistance : Number

獲取或設置與要禁用深度測試的照相機之間的距離，例如，防止對地形進行剪切。當設置為零時，始終應用深度測試。當設置為數字正無窮大時，深度測試永遠不會應用。

distanceDisplayCondition : DistanceDisplayCondition

獲取或設置條件，該條件指定此標簽將顯示在距相機的距離處。

Default Value: undefined

eyeOffset : Cartesian3

獲取和設置在眼坐標中應用于此標簽的三維笛卡爾偏移量。眼睛坐標系是左手坐標系，其中x指向觀看者的右側，y指向上方，z指向屏幕。眼睛坐標使用與世界和模型坐標相同的比例，通常是米。

眼睛偏移通常用于在同一位置排列多個標簽或對象，例如，在其對應的3D模型上方排列標簽。

下面，標簽位于地球中心，但眼睛偏移使其始終出現在地球頂部，無論觀眾或地球的方向如何。

l.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);

Default Value: Cartesian3.ZERO

fillColor : Color

獲取或設置此標簽的填充顏色。

Default Value: Color.WHITE

See:

HTML canvas 2D context fill and stroke styles

font : String

獲取或設置用于繪制此標簽的字體。使用與CSS“字體”屬性相同的語法指定字體。

Default Value: '30px sans-serif'

See:

HTML canvas 2D context text styles

heightReference : HeightReference

獲取或設置此公告牌的高度引用。

Default Value: HeightReference.NONE

horizontalOrigin : HorizontalOrigin

獲取或設置此標簽的水平原點，該原點確定標簽是繪制到其定位點位置的左側、中心還是右側。

Default Value: HorizontalOrigin.LEFT

Example:

// Use a top, right origin
l.horizontalOrigin = bmgl.HorizontalOrigin.RIGHT;
l.verticalOrigin = bmgl.VerticalOrigin.TOP;

id : *

獲取或設置拾取標簽時返回的用戶定義值。

outlineColor : Color

獲取或設置此標簽的大綱顏色。

Default Value: Color.BLACK

See:

HTML canvas 2D context fill and stroke styles

outlineWidth : Number

獲取或設置此標簽的輪廓寬度。

Default Value: 1.0

See:

HTML canvas 2D context fill and stroke styles

pixelOffset : Cartesian2

獲取或設置屏幕空間中距此標簽原點的像素偏移量。這通常用于在同一位置對齊多個標簽和廣告牌，例如圖像和文本。屏幕空間原點是畫布的左上角；x從左到右增加，y從上到下增加。

default l.pixeloffset = new Cartesian2(25, 75);

標簽的原點用黃色點表示。

Default Value: Cartesian2.ZERO

pixelOffsetScaleByDistance : NearFarScalar

獲取或設置基于標簽與相機的距離的標簽的近像素和遠像素偏移縮放屬性。標簽的像素偏移量將在NearFarScalar#nearValue和NearFarScalar#farValue之間縮放，而相機距離在指定NearFarScalar#near和NearFarScalar#far的上下限內。在這些范圍之外，標簽的像素偏移比例保持固定到最近的界限。如果未定義，將禁用PixeLoffSetscaleByDistance。

Examples:

// Example 1.
// Set a label's pixel offset scale to 0.0 when the
// camera is 1500 meters from the label and scale pixel offset to 10.0 pixels
// in the y direction the camera distance approaches 8.0e6 meters.
text.pixelOffset = new bmgl.Cartesian2(0.0, 1.0);
text.pixelOffsetScaleByDistance = new bmgl.NearFarScalar(1.5e2, 0.0, 8.0e6, 10.0);

// Example 2.
// disable pixel offset by distance
text.pixelOffsetScaleByDistance = undefined;

position : Cartesian3

獲取或設置此標簽的笛卡爾位置。

scale : Number

獲取或設置與標簽大?。ㄒ韵袼貫閱挝唬┫喑说慕y一比例。比例尺為1.0不會更改標簽的大?。?大于1.0的比例會放大標簽；小于1.0的正比例會縮小標簽。

應用較大的值可能會使標簽像素化。要使文本變大而沒有像素化，請在調用Label#font時使用更大的字體。

在上圖中從左到右，比例為0.5，1.0和2.0。

Default Value: 1.0

scaleByDistance : NearFarScalar

根據標簽與相機的距離獲取或設置標簽的近縮放和遠縮放屬性。標簽的比例將在NearFarScalar#nearValue和NearFarScalar#farValue之間插入，而相機距離在指定NearFarScalar#near和NearFarScalar#far的上下限內。在這些范圍之外，標簽的刻度將保持在最近的范圍內。如果未定義，將禁用scaleByDistance。

Examples:

// Example 1.
// Set a label's scaleByDistance to scale by 1.5 when the
// camera is 1500 meters from the label and disappear as
// the camera distance approaches 8.0e6 meters.
label.scaleByDistance = new bmgl.NearFarScalar(1.5e2, 1.5, 8.0e6, 0.0);

// Example 2.
// disable scaling by distance
label.scaleByDistance = undefined;

show : Boolean

確定是否顯示此標簽。使用此選項可隱藏或顯示標簽，而不是將其刪除并重新添加到集合中。

Default Value: true

showBackground : Boolean

確定是否顯示此標簽后面的背景。

Default Value: false

style : LabelStyle

獲取或設置此標簽的樣式。

Default Value: LabelStyle.FILL

text : String

獲取或設置此標簽的文本。

totalScale : Number

獲取標簽的總比例，該比例是標簽的比例乘以所需字體的計算相對大小（與生成的glyph大小相比）。

Default Value: 1.0

translucencyByDistance : NearFarScalar

根據標簽與相機的距離獲取或設置標簽的近半透明屬性和遠半透明屬性。標簽的半透明將插入NearFarScalar#nearValue和NearFarScalar#farValue之間，而相機距離在指定NearFarScalar#near和NearFarScalar#far的上下限內。在這些范圍之外，標簽的半透明性保持固定到最近的邊界。如果未定義，半透明Y距離將被禁用。

Examples:

// Example 1.
// Set a label's translucencyByDistance to 1.0 when the
// camera is 1500 meters from the label and disappear as
// the camera distance approaches 8.0e6 meters.
text.translucencyByDistance = new bmgl.NearFarScalar(1.5e2, 1.0, 8.0e6, 0.0);

// Example 2.
// disable translucency by distance
text.translucencyByDistance = undefined;

verticalOrigin : VerticalOrigin

獲取或設置此標簽的垂直原點，該原點確定標簽是位于其定位點位置的上方、下方還是中心。

Default Value: VerticalOrigin.BASELINE

Example:

// Use a top, right origin
l.horizontalOrigin = bmgl.HorizontalOrigin.RIGHT;
l.verticalOrigin = bmgl.VerticalOrigin.TOP;

Methods

computeScreenSpacePosition(scene, result) → {Cartesian2}

計算標簽原點的屏幕空間位置，同時考慮眼睛和像素偏移。屏幕空間原點是畫布的左上角；x從左到右增加，y從上到下增加。

Parameters:

scene (Scene) 標簽所在的場景。

result (Cartesian2) 存儲結果的對象。

Example

console.log(l.computeScreenSpacePosition(scene).toString());

See:

equals(other) → {Boolean}

確定此標簽是否等于另一個標簽。如果標簽的所有屬性都相同，則標簽是相等的。不同集合中的標簽可以相等。

Parameters:

other (Label) 用于比較是否相等的標簽。

isDestroyed() → {Boolean}

如果此對象被破壞，則返回true；否則返回false。

如果此對象被破壞，則不應使用它；調用除isDestroyed以外的任何函數將導致DeveloperError異常。