MetadataClassProperty

new Cesium.MetadataClassProperty(options)
@cesium/engine/Source/Scene/MetadataClassProperty.js 47

A metadata property, as part of a MetadataClass.

See the 3D Metadata Specification for 3D Tiles

Name Type Description
options object Object with the following properties:
Name Type Default Description
id string The ID of the property.
type MetadataType The type of the property such as SCALAR, VEC2, VEC3.
componentType MetadataComponentType optional The component type of the property. This includes integer (e.g. INT8 or UINT16), and floating point (FLOAT32 and FLOAT64) values.
enumType MetadataEnum optional The enum type of the property. Only defined when type is ENUM.
isArray boolean false optional True if a property is an array (either fixed length or variable length), false otherwise.
isVariableLengthArray boolean false optional True if a property is a variable length array, false otherwise.
arrayLength number optional The number of array elements. Only defined for fixed length arrays.
normalized boolean false optional Whether the property is normalized.
min number | Array.<number> | Array.<Array.<number>> optional A number or an array of numbers storing the minimum allowable value of this property. Only defined when type is a numeric type.
max number | Array.<number> | Array.<Array.<number>> optional A number or an array of numbers storing the maximum allowable value of this property. Only defined when type is a numeric type.
offset number | Array.<number> | Array.<Array.<number>> optional The offset to be added to property values as part of the value transform.
scale number | Array.<number> | Array.<Array.<number>> optional The scale to be multiplied to property values as part of the value transform.
noData boolean | number | string | Array optional The no-data sentinel value that represents null values.
default boolean | number | string | Array optional A default value to use when an entity's property value is not defined.
required boolean false optional Whether the property is required.
name string optional The name of the property.
description string optional The description of the property.
semantic string optional An identifier that describes how this property should be interpreted.
extras * optional Extra user-defined properties.
extensions object optional An object containing extensions.
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.

Members

readonly arrayLength : number
@cesium/engine/Source/Scene/MetadataClassProperty.js 326

The number of array elements. Only defined for fixed-size arrays.

readonly componentType : MetadataComponentType
@cesium/engine/Source/Scene/MetadataClassProperty.js 269

The component type of the property. This includes integer (e.g. INT8 or UINT16), and floating point (FLOAT32 and FLOAT64) values

readonly default : boolean|number|string|Array
@cesium/engine/Source/Scene/MetadataClassProperty.js 391

A default value to use when an entity's property value is not defined.

readonly description : string
@cesium/engine/Source/Scene/MetadataClassProperty.js 229

The description of the property.

readonly enumType : MetadataEnum
@cesium/engine/Source/Scene/MetadataClassProperty.js 255

The enum type of the property. Only defined when type is ENUM.

readonly extensions : object
@cesium/engine/Source/Scene/MetadataClassProperty.js 484

An object containing extensions.

readonly extras : *
@cesium/engine/Source/Scene/MetadataClassProperty.js 471

Extra user-defined properties.

readonly id : string
@cesium/engine/Source/Scene/MetadataClassProperty.js 203

The ID of the property.

readonly isArray : boolean
@cesium/engine/Source/Scene/MetadataClassProperty.js 299

True if a property is an array (either fixed length or variable length), false otherwise.

readonly isVariableLengthArray : boolean
@cesium/engine/Source/Scene/MetadataClassProperty.js 312

True if a property is a variable length array, false otherwise.

readonly max : number|Array.<number>|Array.<Array.<number>>
@cesium/engine/Source/Scene/MetadataClassProperty.js 352

A number or an array of numbers storing the maximum allowable value of this property. Only defined when type is a numeric type.

readonly min : number|Array.<number>|Array.<Array.<number>>
@cesium/engine/Source/Scene/MetadataClassProperty.js 365

A number or an array of numbers storing the minimum allowable value of this property. Only defined when type is a numeric type.

readonly name : string
@cesium/engine/Source/Scene/MetadataClassProperty.js 216

The name of the property.

readonly noData : boolean|number|string|Array
@cesium/engine/Source/Scene/MetadataClassProperty.js 378

The no-data sentinel value that represents null values

readonly normalized : boolean
@cesium/engine/Source/Scene/MetadataClassProperty.js 339

Whether the property is normalized.

readonly offset : number|Array.<number>|Array.<Array.<number>>
@cesium/engine/Source/Scene/MetadataClassProperty.js 445

The offset to be added to property values as part of the value transform.

readonly required : boolean
@cesium/engine/Source/Scene/MetadataClassProperty.js 404

Whether the property is required.

readonly scale : number|Array.<number>|Array.<Array.<number>>
@cesium/engine/Source/Scene/MetadataClassProperty.js 458

The scale to be multiplied to property values as part of the value transform.

readonly semantic : string
@cesium/engine/Source/Scene/MetadataClassProperty.js 417

An identifier that describes how this property should be interpreted.

readonly type : MetadataType
@cesium/engine/Source/Scene/MetadataClassProperty.js 242

The type of the property such as SCALAR, VEC2, VEC3
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/ion-sdk-measurements
packages/ion-sdk-sensors
packages/ion-sdk-geometry
@cesium/engine
@cesium/widgets