MetadataClassProperty

new Cesium.MetadataClassProperty(options)

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

The number of array elements. Only defined for fixed-size arrays.
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

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

readonly description : string

The description of the property.
The enum type of the property. Only defined when type is ENUM.
An object containing extensions.
Extra user-defined properties.
The ID of the property.
True if a property is an array (either fixed length or variable length), false otherwise.

readonly isVariableLengthArray : boolean

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

readonly max : number|Array.<number>|Array.<Array.<number>>

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>>

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

readonly noData : boolean|number|string|Array

The no-data sentinel value that represents null values

readonly normalized : boolean

Whether the property is normalized.

readonly offset : number|Array.<number>|Array.<Array.<number>>

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

readonly scale : number|Array.<number>|Array.<Array.<number>>

The scale to be multiplied to property values as part of the value transform.
An identifier that describes how this property should be interpreted.
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.