Appearance
@jdultra/ultra-globe / CSSLabelsLayer
Class: CSSLabelsLayer
Defined in: layers/labels/CSSLabelsLayer.d.ts:153
Layer that renders HTML/CSS labels for features supplied by attached vector layers.
Labels are generated on demand via an elementGenerator callback and positioned with the map-owned CSS2D renderer.
Extends
Constructors
Constructor
new CSSLabelsLayer(
properties?):CSSLabelsLayer
Defined in: layers/labels/CSSLabelsLayer.d.ts:159
Creates a CSS labels layer.
Parameters
properties?
CSSLabelsLayerOptions
Layer configuration.
Returns
CSSLabelsLayer
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/CSSLabelsLayer.d.ts:177
debug
debug:
boolean
Defined in: layers/labels/CSSLabelsLayer.d.ts:162
elementGenerator
elementGenerator:
Object
Defined in: layers/labels/CSSLabelsLayer.d.ts:161
id
id:
string|number
Defined in: layers/Layer.d.ts:24
Inherited from
isCSSLabelsLayer
isCSSLabelsLayer:
boolean
Defined in: layers/labels/CSSLabelsLayer.d.ts:160
isLayer
isLayer:
boolean
Defined in: layers/Layer.d.ts:22
Inherited from
isSelectable
isSelectable:
boolean
Defined in: layers/Layer.d.ts:23
Inherited from
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
vectorLayers
vectorLayers:
Set<any>
Defined in: layers/labels/CSSLabelsLayer.d.ts:178
visible
visible:
boolean
Defined in: layers/Layer.d.ts:27
Inherited from
Accessors
anchorOffset
Get Signature
get anchorOffset():
Vector2
Defined in: layers/labels/CSSLabelsLayer.d.ts:256
Pixel offset applied to every label relative to its anchor.
Returns
Vector2
A clone of the current anchor offset.
Set Signature
set anchorOffset(
value):void
Defined in: layers/labels/CSSLabelsLayer.d.ts:247
Updates the pixel offset applied to every label relative to its anchor.
Parameters
value
any
New anchor offset in pixels.
Returns
void
useSceneDepth
Get Signature
get useSceneDepth():
boolean
Defined in: layers/labels/CSSLabelsLayer.d.ts:229
Whether scene depth participates in label occlusion testing.
Returns
boolean
true when scene depth checks are enabled.
Set Signature
set useSceneDepth(
value):void
Defined in: layers/labels/CSSLabelsLayer.d.ts:223
Enables or disables scene depth participation in occlusion testing.
Parameters
value
boolean
true to enable scene depth checks.
Returns
void
useVectorsDepth
Get Signature
get useVectorsDepth():
boolean
Defined in: layers/labels/CSSLabelsLayer.d.ts:241
Whether vector depth participates in label occlusion testing.
Returns
boolean
true when vector depth checks are enabled.
Set Signature
set useVectorsDepth(
value):void
Defined in: layers/labels/CSSLabelsLayer.d.ts:235
Enables or disables vector depth participation in occlusion testing.
Parameters
value
boolean
true to enable vector depth checks.
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/CSSLabelsLayer.d.ts:272
Attaches a vector layer as a source of labeled features.
Parameters
layer
any
Vector layer to observe for features and selection state.
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
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
invalidate()
invalidate(
uuidOrUUIDs):void
Defined in: layers/labels/CSSLabelsLayer.d.ts:294
Marks one or more feature labels dirty so they are regenerated on the next update.
Passing null, undefined, or an empty collection invalidates all labels.
Parameters
uuidOrUUIDs
One UUID or a list of UUIDs to invalidate.
string | number | (string | number)[] | null | undefined
Returns
void
raycast()
raycast():
never[]
Defined in: layers/labels/CSSLabelsLayer.d.ts:265
Returns intersection results for raycasting against this layer.
CSS labels are not raycastable, so this always returns an empty array.
Returns
never[]
Always an empty list.
Overrides
refresh()
refresh():
void
Defined in: layers/labels/CSSLabelsLayer.d.ts:285
Marks all generated labels dirty so their content, measurements, and terrain anchors refresh.
Returns
void
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/CSSLabelsLayer.d.ts:279
Detaches a previously attached vector layer and disposes its generated labels.
Parameters
layer
any
Vector layer to remove.
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