@jdultra/ultra-globe / LabelsLayer
Class: LabelsLayer
Defined in: layers/labels/LabelsLayer.d.ts:7
LabelsLayer
Facade class that extends Layer. Manages the connection between the Map, VectorLayers, and specific LabelHandlers.
Extends
Constructors
Constructor
new LabelsLayer(
properties):LabelsLayer
Defined in: layers/labels/LabelsLayer.d.ts:8
Parameters
properties
any
Returns
LabelsLayer
Overrides
Properties
attribution
attribution:
string|null
Defined in: layers/Layer.d.ts:29
Inherited from
bounds
bounds:
any
Defined in: layers/Layer.d.ts:26
Inherited from
bundle
bundle:
any
Defined in: layers/labels/LabelsLayer.d.ts:46
cameraForwardUniform
cameraForwardUniform:
any
Defined in: layers/labels/LabelsLayer.d.ts:14
cameraPositionUniform
cameraPositionUniform:
any
Defined in: layers/labels/LabelsLayer.d.ts:15
cameraRightUniform
cameraRightUniform:
any
Defined in: layers/labels/LabelsLayer.d.ts:12
cameraUpUniform
cameraUpUniform:
any
Defined in: layers/labels/LabelsLayer.d.ts:13
curvedlinesHandler
curvedlinesHandler:
CurvedLinesLabelsHandler
Defined in: layers/labels/LabelsLayer.d.ts:45
drapedPointsHandler
drapedPointsHandler:
DrapedPointsLabelsHandler
Defined in: layers/labels/LabelsLayer.d.ts:40
drapedPolygonsHandler
drapedPolygonsHandler:
DrapedPointsLabelsHandler
Defined in: layers/labels/LabelsLayer.d.ts:42
drapedPolylinesHandler
drapedPolylinesHandler:
DrapedPointsLabelsHandler
Defined in: layers/labels/LabelsLayer.d.ts:44
frustumMatrix
frustumMatrix:
any
Defined in: layers/labels/LabelsLayer.d.ts:52
frustumPlanes
frustumPlanes:
Float32Array<ArrayBuffer>
Defined in: layers/labels/LabelsLayer.d.ts:53
handlerReadyCallback
handlerReadyCallback:
Object
Defined in: layers/labels/LabelsLayer.d.ts:18
handlers
handlers:
PointsLabelsHandler[]
Defined in: layers/labels/LabelsLayer.d.ts:38
id
id:
string|number
Defined in: layers/Layer.d.ts:24
Inherited from
isLayer
isLayer:
boolean
Defined in: layers/Layer.d.ts:22
Inherited from
isPerspectiveUniform
isPerspectiveUniform:
any
Defined in: layers/labels/LabelsLayer.d.ts:11
isSelectable
isSelectable:
boolean
Defined in: layers/Layer.d.ts:23
Inherited from
layerCallbacks
layerCallbacks:
Map<any,any>
Defined in: layers/labels/LabelsLayer.d.ts:48
layerSelectionCallbacks
layerSelectionCallbacks:
Map<any,any>
Defined in: layers/labels/LabelsLayer.d.ts:49
listeners
listeners:
Object
Defined in: layers/Layer.d.ts:28
Inherited from
map
map:
any
Defined in: layers/Layer.d.ts:92
Inherited from
name
name:
string
Defined in: layers/Layer.d.ts:25
Inherited from
paused
paused:
boolean|undefined
Defined in: layers/Layer.d.ts:82
Inherited from
pixelScaleUniform
pixelScaleUniform:
any
Defined in: layers/labels/LabelsLayer.d.ts:10
pointsHandler
pointsHandler:
PointsLabelsHandler
Defined in: layers/labels/LabelsLayer.d.ts:39
polygonsHandler
polygonsHandler:
PointsLabelsHandler
Defined in: layers/labels/LabelsLayer.d.ts:41
polylinesHandler
polylinesHandler:
PointsLabelsHandler
Defined in: layers/labels/LabelsLayer.d.ts:43
screenSizeUniform
screenSizeUniform:
any
Defined in: layers/labels/LabelsLayer.d.ts:9
selectedAlign
selectedAlign:
any
Defined in: layers/labels/LabelsLayer.d.ts:28
selectedBackground
selectedBackground:
any
Defined in: layers/labels/LabelsLayer.d.ts:35
selectedBackgroundTextureFit
selectedBackgroundTextureFit:
any
Defined in: layers/labels/LabelsLayer.d.ts:36
selectedBorderColor
selectedBorderColor:
any
Defined in: layers/labels/LabelsLayer.d.ts:33
selectedBorderRadius
selectedBorderRadius:
any
Defined in: layers/labels/LabelsLayer.d.ts:34
selectedFontFamily
selectedFontFamily:
any
Defined in: layers/labels/LabelsLayer.d.ts:26
selectedFontSize
selectedFontSize:
any
Defined in: layers/labels/LabelsLayer.d.ts:25
selectedFontWeight
selectedFontWeight:
any
Defined in: layers/labels/LabelsLayer.d.ts:27
selectedLineHeight
selectedLineHeight:
any
Defined in: layers/labels/LabelsLayer.d.ts:29
selectedPadding
selectedPadding:
any
Defined in: layers/labels/LabelsLayer.d.ts:32
selectedPinColor
selectedPinColor:
any
Defined in: layers/labels/LabelsLayer.d.ts:37
selectedTextColor
selectedTextColor:
any
Defined in: layers/labels/LabelsLayer.d.ts:30
selectedTextGenerator
selectedTextGenerator:
any
Defined in: layers/labels/LabelsLayer.d.ts:24
selectedTextHaloColor
selectedTextHaloColor:
any
Defined in: layers/labels/LabelsLayer.d.ts:31
vectorLayers
vectorLayers:
Set<any>
Defined in: layers/labels/LabelsLayer.d.ts:47
visible
visible:
boolean
Defined in: layers/Layer.d.ts:27
Inherited from
Accessors
pointLabelOffset
Get Signature
get pointLabelOffset():
Vector2
Defined in: layers/labels/LabelsLayer.d.ts:65
Gets the pixel offset for point labels (vec2).
Returns
Vector2
Set Signature
set pointLabelOffset(
val):void
Defined in: layers/labels/LabelsLayer.d.ts:61
Sets the pixel offset for point labels. Triggers a re-computation of label positions/frames.
Parameters
val
Vector2
Returns
void
useSceneDepth
Get Signature
get useSceneDepth():
boolean
Defined in: layers/labels/LabelsLayer.d.ts:70
If true, label anchor depth testing will consider map.primaryGBuffer.depthTexture.
Returns
boolean
Set Signature
set useSceneDepth(
val):void
Defined in: layers/labels/LabelsLayer.d.ts:66
Parameters
val
boolean
Returns
void
useVectorsDepth
Get Signature
get useVectorsDepth():
boolean
Defined in: layers/labels/LabelsLayer.d.ts:75
If true, label anchor depth testing will consider map.vectorsRT.depthTexture.
Returns
boolean
Set Signature
set useVectorsDepth(
val):void
Defined in: layers/labels/LabelsLayer.d.ts:71
Parameters
val
boolean
Returns
void
Methods
addListener()
addListener(
key,listener):void
Defined in: layers/Layer.d.ts:74
Adds a listener for layer events
Parameters
key
any
can be anything but should be unique
listener
Function
a function : (layer, eventType)=>{}
Returns
void
Inherited from
addVectorLayer()
addVectorLayer(
layer):void
Defined in: layers/labels/LabelsLayer.d.ts:99
Parameters
layer
any
Returns
void
applyDeclutterResult()
applyDeclutterResult(
layerResult,payload):void
Defined in: layers/labels/LabelsLayer.d.ts:118
Phase 1+ API for DeclutterManager. The result contains per-handler visibility decisions.
Parameters
layerResult
any
payload
any
Returns
void
dispose()
dispose():
void
Defined in: layers/Layer.d.ts:87
disposes of any resources used by this layer
Returns
void
Inherited from
getBounds()
getBounds():
Box2
Defined in: layers/Layer.d.ts:62
Returns
Box2
bounds in longitude latitude (degrees)
Inherited from
getCenter()
getCenter(
sfct):Vector3
Defined in: layers/Layer.d.ts:37
Moves a given point to this layer's center in degree longitude/latitude
Parameters
sfct
Vector3
a point to move
Returns
Vector3
the input point
Inherited from
getDeclutterData()
getDeclutterData():
Object
Defined in: layers/labels/LabelsLayer.d.ts:105
Phase 1 API for DeclutterManager. Returns prepared screen-space label boxes for each handler that has them.
Returns
Object
getID()
getID():
string|number
Defined in: layers/Layer.d.ts:42
Returns
string | number
layer id
Inherited from
getName()
getName():
string
Defined in: layers/Layer.d.ts:47
Returns
string
layer name
Inherited from
raycast()
raycast(
mapRaycaster,raycastOnDepthLLH,raycastOnDepthCartesian,raycastOnDepthDistance,screenPixel?):object[]
Defined in: layers/labels/LabelsLayer.d.ts:90
Labels are not independently selectable; instead, clicking a label selects the underlying source feature (VectorLayer selection model).
Map.select() will call raycast() on layers. We accept an optional screen-pixel location (relative to map.domContainer) to perform CPU hit-testing on label frames.
Parameters
mapRaycaster
Raycaster
raycastOnDepthLLH
any
raycastOnDepthCartesian
any
raycastOnDepthDistance
number
screenPixel?
any
Returns
object[]
Overrides
removeListener()
removeListener(
key):void
Defined in: layers/Layer.d.ts:68
Removes the listener associated to the given key
Parameters
key
any
can be anything but should be unique
Returns
void
Inherited from
removeVectorLayer()
removeVectorLayer(
layer):void
Defined in: layers/labels/LabelsLayer.d.ts:100
Parameters
layer
any
Returns
void
setName()
setName(
name):void
Defined in: layers/Layer.d.ts:52
change the layer name
Parameters
name
string
Returns
void
Inherited from
setVisible()
setVisible(
visible):void
Defined in: layers/Layer.d.ts:57
Modifies the layer visibility
Parameters
visible
boolean
Returns
void