Appearance
BillboardEntity (Icon Point Entity Object)
Create and manage icon point Entity objects.
Constructor
ts
new ge3d.feature.BillboardEntity(options?: {}): BillboardEntityParameters (StyleOptions)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image | string | HTMLCanvasElement | - | Image, URI or Canvas for vector objects |
| opacity | Number | 1.0 | Opacity, range 0.0-1.0 |
| scale | Number | 1 | Scale of image size |
| rotation | Number | 0 | Rotation angle (radians), 0 is north, counterclockwise |
| rotationDegree | Number | 0 | Rotation angle (degrees, 0-360), mutually exclusive with rotation |
| horizontalOrigin | Cesium.HorizontalOrigin | - | Horizontal positioning |
| verticalOrigin | Cesium.VerticalOrigin | - | Vertical positioning |
| width | Number | - | Specify billboard width (in pixels), overrides image's own size |
| height | Number | - | Specify billboard height (in pixels), overrides image's own size |
| hasPixelOffset | Boolean | false | Whether pixel offset exists |
| pixelOffsetX | Number | 0 | Horizontal offset pixels |
| pixelOffsetY | Number | 0 | Vertical offset pixels |
| pixelOffset | Cartesian2 | Number[] | Cartesian2.ZERO | Specify pixel offset |
| scaleByDistance | Boolean | Cesium.NearFarScalar | false | Whether to scale by distance or set point scaling based on camera distance |
| scaleByDistance_far | Number | 1000000 | Upper limit |
| scaleByDistance_farValue | Number | 0.1 | Scale value |
| scaleByDistance_near | Number | 1000 | Lower limit |
| scaleByDistance_nearValue | Number | 1 | Scale value |
| distanceDisplayCondition | Boolean | Cesium.DistanceDisplayCondition | false | Whether to display by distance or specify at what distance from camera the billboard will be displayed |
| distanceDisplayCondition_far | Number | 10000 | Maximum distance |
| distanceDisplayCondition_near | Number | 0 | Minimum distance |
| clampToGround | Boolean | false | Whether to clamp to ground |
| heightReference | Cesium.HeightReference | Cesium.HeightReference.NONE | Property specifying what the height is relative to |
| visibleDepth | Boolean | true | Whether to be occluded |
| disableDepthTestDistance | Number | - | Specify distance from camera to disable depth testing |
| color | Cesium.Color | Color.WHITE | Additional color |
| eyeOffset | Cesium.Cartesian3 | Cartesian3.ZERO | Eye offset |
| alignedAxis | Cesium.Cartesian3 | Cartesian3.ZERO | Specify unit rotation vector axis |
| sizeInMeters | boolean | - | Specify whether the billboard size should be measured in meters |
| translucencyByDistance | Cesium.NearFarScalar | - | Used to set translucency based on distance from camera |
| pixelOffsetScaleByDistance | Cesium.NearFarScalar | - | Used to set pixelOffset based on distance from camera |
| imageSubRegion | Cesium.BoundingRectangle | - | Define sub-region of image used for billboard |
| setHeight | Number | 0 | Specify coordinate height value (commonly used in layer configuration) |
| addHeight | Number | 0 | Height value added to existing coordinates (commonly used in layer configuration) |
| label | LabelEntity.StyleOptions | - | Support for additional text display |