Cesium3DTileset.
Provides access to a feature's properties stored in the tile's batch table, as well
as the ability to show/hide a feature and change its highlight color via
Cesium3DTileFeature#show and Cesium3DTileFeature#color, respectively.
Modifications to a Cesium3DTileFeature object have the lifetime of the tile's
content. If the tile's content is unloaded, e.g., due to it going out of view and needing
to free space in the cache for visible tiles, listen to the Cesium3DTileset#tileUnload event to save any
modifications. Also listen to the Cesium3DTileset#tileVisible event to reapply any modifications.
Do not construct this directly. Access it through Cesium3DTileContent#getFeature
or picking using Scene#pick.
Example:
// On mouse over, display all the properties for a feature in the console log.
handler.setInputAction(function(movement) {
const feature = scene.pick(movement.endPosition);
if (feature instanceof Cesium.Cesium3DTileFeature) {
const propertyIds = feature.getPropertyIds();
const length = propertyIds.length;
for (let i = 0; i < length; ++i) {
const propertyId = propertyIds[i];
console.log(`{propertyId}: ${feature.getProperty(propertyId)}`);
}
}
}, Cesium.ScreenSpaceEventType.MOUSE_MOVE);Members
-
Default Value:
Color.WHITEExperimental
This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
Cesium3DTileset#vectorKeepDecodedPositions is false
or the feature is not a polyline in a vector tile.
Experimental
This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
readonly primitive : Cesium3DTileset
Scene#pick have a primitive property. This returns
the tileset containing the feature.
-
Default Value:
true
readonly tileset : Cesium3DTileset
Methods
- Batch table (structural metadata) property by semantic
- Batch table (structural metadata) property by property ID
- Content metadata property by semantic
- Content metadata property by property
- Tile metadata property by semantic
- Tile metadata property by property ID
- Subtree metadata property by semantic
- Subtree metadata property by property ID
- Group metadata property by semantic
- Group metadata property by property ID
- Tileset metadata property by semantic
- Tileset metadata property by property ID
- Otherwise, return undefined
For 3D Tiles Next details, see the 3DTILES_metadata Extension for 3D Tiles, as well as the EXT_structural_metadata Extension for glTF. For the legacy glTF extension, see EXT_feature_metadata Extension
| Name | Type | Description |
|---|---|---|
content |
Cesium3DTileContent | The content for accessing the metadata |
batchId |
number | The batch ID (or feature ID) of the feature to get a property for |
name |
string | The semantic or property ID of the feature. Semantics are checked before property IDs in each granularity of metadata. |
Returns:
undefined if the feature does not have this property.
Experimental
This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
| Name | Type | Description |
|---|---|---|
name |
string | The case-sensitive name of the property. |
Returns:
undefined if the feature does not have this property.
Example:
// Display all the properties for a feature in the console log.
const propertyIds = feature.getPropertyIds();
const length = propertyIds.length;
for (let i = 0; i < length; ++i) {
const propertyId = propertyIds[i];
console.log(`{propertyId}: ${feature.getProperty(propertyId)}`);
}See:
| Name | Type | Description |
|---|---|---|
results |
Array.<string> | optional An array into which to store the results. |
Returns:
| Name | Type | Description |
|---|---|---|
name |
string | The case-sensitive name of the property. |
Returns:
If a property with the given name doesn't exist, it is created.
| Name | Type | Description |
|---|---|---|
name |
string | The case-sensitive name of the property. |
value |
* | The value of the property that will be copied. |
Throws:
-
DeveloperError : Inherited batch table hierarchy property is read only.
Examples:
const height = feature.getProperty('Height'); // e.g., the height of a buildingconst name = 'clicked';
if (feature.getProperty(name)) {
console.log('already clicked');
} else {
feature.setProperty(name, true);
console.log('first click');
}