# Cesium3DTilePointFeature

#### new Cesium.Cesium3DTilePointFeature()
Scene/Cesium3DTilePointFeature.js 44

A point feature of a `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 point properties

Modifications to a `Cesium3DTilePointFeature` 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` and `Scene#pickPosition`.

##### Example:

    // On mouse over, display all the properties for a feature in the console log.
    handler.setInputAction(function(movement) {
        var feature = scene.pick(movement.endPosition);
        if (feature instanceof Cesium.Cesium3DTilePointFeature) {
            var propertyNames = feature.getPropertyNames();
            var length = propertyNames.length;
            for (var i = 0; i < length; ++i) {
                var propertyName = propertyNames[i];
                console.log(propertyName + ': ' + feature.getProperty(propertyName));
            }
        }
    }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);

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

#### anchorLineColor : Color
Scene/Cesium3DTilePointFeature.js 452

Gets or sets the color for the anchor line.

Only applied when `heightOffset` is defined.

#### anchorLineEnabled : Boolean
Scene/Cesium3DTilePointFeature.js 433

Gets or sets whether the anchor line is displayed.

Only applied when `heightOffset` is defined.

#### backgroundColor : Color
Scene/Cesium3DTilePointFeature.js 297

Gets or sets the background color of the text for this feature.

Only applied when `labelText` is defined.

#### backgroundEnabled : Boolean
Scene/Cesium3DTilePointFeature.js 335

Gets or sets whether to display the background of the text for this feature.

Only applied when `labelText` is defined.

#### backgroundPadding : Cartesian2
Scene/Cesium3DTilePointFeature.js 316

Gets or sets the background padding of the text for this feature.

Only applied when `labelText` is defined.

#### color : Color
Scene/Cesium3DTilePointFeature.js 102

Gets or sets the color of the point of this feature.

Only applied when `image` is `undefined`.

#### disableDepthTestDistance : Number
Scene/Cesium3DTilePointFeature.js 488

Gets or sets the distance where depth testing will be disabled.

#### distanceDisplayCondition : DistanceDisplayCondition
Scene/Cesium3DTilePointFeature.js 385

Gets or sets the condition specifying at what distance from the camera that this feature will be displayed.

#### font : String
Scene/Cesium3DTilePointFeature.js 240

Gets or sets the font of this feature.

Only applied when the `labelText` is defined.

#### heightOffset : Number
Scene/Cesium3DTilePointFeature.js 403

Gets or sets the height offset in meters of this feature.

#### horizontalOrigin : HorizontalOrigin
Scene/Cesium3DTilePointFeature.js 506

Gets or sets the horizontal origin of this point, which determines if the point is to the left, center, or right of its anchor position.

#### image : String
Scene/Cesium3DTilePointFeature.js 468

Gets or sets the image of this feature.

#### labelColor : Color
Scene/Cesium3DTilePointFeature.js 182

Gets or sets the label color of this feature.

The color will be applied to the label if `labelText` is defined.

#### labelHorizontalOrigin : HorizontalOrigin
Scene/Cesium3DTilePointFeature.js 540

Gets or sets the horizontal origin of this point's text, which determines if the point's text is to the left, center, or right of its anchor position.

#### labelOutlineColor : Color
Scene/Cesium3DTilePointFeature.js 202

Gets or sets the label outline color of this feature.

The outline color will be applied to the label if `labelText` is defined.

#### labelOutlineWidth : Number
Scene/Cesium3DTilePointFeature.js 221

Gets or sets the outline width in pixels of this feature.

The outline width will be applied to the point if `labelText` is defined.

#### labelStyle : LabelStyle
Scene/Cesium3DTilePointFeature.js 259

Gets or sets the fill and outline style of this feature.

Only applied when `labelText` is defined.

#### labelText : String
Scene/Cesium3DTilePointFeature.js 275

Gets or sets the text for this feature.

#### labelVerticalOrigin : VerticalOrigin
Scene/Cesium3DTilePointFeature.js 557

Get or sets the vertical origin of this point's text, which determines if the point's text is to the bottom, center, top, or baseline of it's anchor point.

#### pointOutlineColor : Color
Scene/Cesium3DTilePointFeature.js 142

Gets or sets the point outline color of this feature.

Only applied when `image` is `undefined`.

#### pointOutlineWidth : Number
Scene/Cesium3DTilePointFeature.js 162

Gets or sets the point outline width in pixels of this feature.

Only applied when `image` is `undefined`.

#### pointSize : Number
Scene/Cesium3DTilePointFeature.js 122

Gets or sets the point size of this feature.

Only applied when `image` is `undefined`.

#### readonly primitive : Cesium3DTileset
Scene/Cesium3DTilePointFeature.js 607

All objects returned by `Scene#pick` have a `primitive` property. This returns the tileset containing the feature.

#### scaleByDistance : NearFarScalar
Scene/Cesium3DTilePointFeature.js 351

Gets or sets the near and far scaling properties for this feature.

#### show : Boolean
Scene/Cesium3DTilePointFeature.js 81

Gets or sets if the feature will be shown. This is set for all features when a style's show is evaluated.

Default Value: `true`

#### readonly tileset : Cesium3DTileset
Scene/Cesium3DTilePointFeature.js 591

Gets the tileset containing the feature.

#### translucencyByDistance : NearFarScalar
Scene/Cesium3DTilePointFeature.js 368

Gets or sets the near and far translucency properties for this feature.

#### verticalOrigin : VerticalOrigin
Scene/Cesium3DTilePointFeature.js 523

Gets or sets the vertical origin of this point, which determines if the point is to the bottom, center, or top of its anchor position.

### Methods

#### getProperty(name) → *
Scene/Cesium3DTilePointFeature.js 719

Returns a copy of the value of the feature's property with the given name. This includes properties from this feature's class and inherited classes when using a batch table hierarchy.

Name | Type | Description
--- | --- | ---
`name` | String | The case-sensitive name of the property.

##### Returns:

The value of the property or `undefined` if the feature does not have this property.

##### Example:

    // Display all the properties for a feature in the console log.
    var propertyNames = feature.getPropertyNames();
    var length = propertyNames.length;
    for (var i = 0; i < length; ++i) {
        var propertyName = propertyNames[i];
        console.log(propertyName + ': ' + feature.getProperty(propertyName));
    }

##### See:

- https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy

#### getPropertyNames(results) → Array.<String>
Scene/Cesium3DTilePointFeature.js 697

Returns an array of property names for the feature. This includes properties from this feature's class and inherited classes when using a batch table hierarchy.

Name | Type | Description
--- | --- | ---
`results` | Array.<String> | optional An array into which to store the results.

##### Returns:

The names of the feature's properties.

##### See:

- https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy

#### hasProperty(name) → Boolean
Scene/Cesium3DTilePointFeature.js 684

Returns whether the feature contains this property. This includes properties from this feature's class and inherited classes when using a batch table hierarchy.

Name | Type | Description
--- | --- | ---
`name` | String | The case-sensitive name of the property.

##### Returns:

Whether the feature contains this property.

##### See:

- https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy

#### setProperty(name, value)
Scene/Cesium3DTilePointFeature.js 766

Sets the value of the feature's property with the given name.

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:

    var height = feature.getProperty('Height'); // e.g., the height of a building

    var name = 'clicked';
    if (feature.getProperty(name)) {
        console.log('already clicked');
    } else {
        feature.setProperty(name, true);
        console.log('first click');
    }