qd-changjing/public/static/Build/Documentation/Cesium3DTilePointFeature.html

2581 lines
79 KiB
HTML
Raw Normal View History

2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Cesium3DTilePointFeature - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
Cesium3DTilePointFeature
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Cesium3DTilePointFeature">
<a href="#Cesium3DTilePointFeature" class="doc-link"></a>
new Cesium.Cesium3DTilePointFeature<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L44">Scene/Cesium3DTilePointFeature.js 44</a>
</div>
</h4>
</div>
<div class="description">
A point feature of a <a href="Cesium3DTileset.html"><code>Cesium3DTileset</code></a>.
<p>
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
</p>
<p>
Modifications to a <code>Cesium3DTilePointFeature</code> 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 <a href="Cesium3DTileset.html#tileUnload"><code>Cesium3DTileset#tileUnload</code></a> event to save any
modifications. Also listen to the <a href="Cesium3DTileset.html#tileVisible"><code>Cesium3DTileset#tileVisible</code></a> event to reapply any modifications.
</p>
<p>
Do not construct this directly. Access it through <a href="Cesium3DTileContent.html#getFeature"><code>Cesium3DTileContent#getFeature</code></a>
or picking using <a href="Scene.html#pick"><code>Scene#pick</code></a> and <a href="Scene.html#pickPosition"><code>Scene#pickPosition</code></a>.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// 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.Cesium3DTilePointFeature) {
const propertyNames = feature.getPropertyNames();
const length = propertyNames.length;
for (let i = 0; i &lt; length; ++i) {
const propertyName = propertyNames[i];
console.log(propertyName + ': ' + feature.getProperty(propertyName));
}
}
}, Cesium.ScreenSpaceEventType.MOUSE_MOVE);</code></pre>
<div class="tag-experimental">
<h5>Experimental</h5>
<p>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.</p>
</div>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="anchorLineColor">
<a href="#anchorLineColor" class="doc-link"></a>
anchorLineColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L461">Scene/Cesium3DTilePointFeature.js 461</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the color for the anchor line.
<p>
Only applied when <code>heightOffset</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="anchorLineEnabled">
<a href="#anchorLineEnabled" class="doc-link"></a>
anchorLineEnabled<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L442">Scene/Cesium3DTilePointFeature.js 442</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether the anchor line is displayed.
<p>
Only applied when <code>heightOffset</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="backgroundColor">
<a href="#backgroundColor" class="doc-link"></a>
backgroundColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L303">Scene/Cesium3DTilePointFeature.js 303</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the background color of the text for this feature.
<p>
Only applied when <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="backgroundEnabled">
<a href="#backgroundEnabled" class="doc-link"></a>
backgroundEnabled<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L341">Scene/Cesium3DTilePointFeature.js 341</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether to display the background of the text for this feature.
<p>
Only applied when <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="backgroundPadding">
<a href="#backgroundPadding" class="doc-link"></a>
backgroundPadding<span class="type-signature"> : <a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L322">Scene/Cesium3DTilePointFeature.js 322</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the background padding of the text for this feature.
<p>
Only applied when <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="color">
<a href="#color" class="doc-link"></a>
color<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L108">Scene/Cesium3DTilePointFeature.js 108</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the color of the point of this feature.
<p>
Only applied when <code>image</code> is <code>undefined</code>.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="disableDepthTestDistance">
<a href="#disableDepthTestDistance" class="doc-link"></a>
disableDepthTestDistance<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L500">Scene/Cesium3DTilePointFeature.js 500</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the distance where depth testing will be disabled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<span class="type-signature"> : <a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L391">Scene/Cesium3DTilePointFeature.js 391</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the condition specifying at what distance from the camera that this feature will be displayed.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="font">
<a href="#font" class="doc-link"></a>
font<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L246">Scene/Cesium3DTilePointFeature.js 246</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the font of this feature.
<p>
Only applied when the <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="heightOffset">
<a href="#heightOffset" class="doc-link"></a>
heightOffset<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L409">Scene/Cesium3DTilePointFeature.js 409</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the height offset in meters of this feature.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="horizontalOrigin">
<a href="#horizontalOrigin" class="doc-link"></a>
horizontalOrigin<span class="type-signature"> : <a href="global.html#HorizontalOrigin">HorizontalOrigin</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L518">Scene/Cesium3DTilePointFeature.js 518</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="image">
<a href="#image" class="doc-link"></a>
image<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L480">Scene/Cesium3DTilePointFeature.js 480</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the image of this feature.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="labelColor">
<a href="#labelColor" class="doc-link"></a>
labelColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L188">Scene/Cesium3DTilePointFeature.js 188</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the label color of this feature.
<p>
The color will be applied to the label if <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="labelHorizontalOrigin">
<a href="#labelHorizontalOrigin" class="doc-link"></a>
labelHorizontalOrigin<span class="type-signature"> : <a href="global.html#HorizontalOrigin">HorizontalOrigin</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L552">Scene/Cesium3DTilePointFeature.js 552</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="labelOutlineColor">
<a href="#labelOutlineColor" class="doc-link"></a>
labelOutlineColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L208">Scene/Cesium3DTilePointFeature.js 208</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the label outline color of this feature.
<p>
The outline color will be applied to the label if <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="labelOutlineWidth">
<a href="#labelOutlineWidth" class="doc-link"></a>
labelOutlineWidth<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L227">Scene/Cesium3DTilePointFeature.js 227</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the outline width in pixels of this feature.
<p>
The outline width will be applied to the point if <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="labelStyle">
<a href="#labelStyle" class="doc-link"></a>
labelStyle<span class="type-signature"> : <a href="global.html#LabelStyle">LabelStyle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L265">Scene/Cesium3DTilePointFeature.js 265</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the fill and outline style of this feature.
<p>
Only applied when <code>labelText</code> is defined.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="labelText">
<a href="#labelText" class="doc-link"></a>
labelText<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L281">Scene/Cesium3DTilePointFeature.js 281</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the text for this feature.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="labelVerticalOrigin">
<a href="#labelVerticalOrigin" class="doc-link"></a>
labelVerticalOrigin<span class="type-signature"> : <a href="global.html#VerticalOrigin">VerticalOrigin</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L569">Scene/Cesium3DTilePointFeature.js 569</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pointOutlineColor">
<a href="#pointOutlineColor" class="doc-link"></a>
pointOutlineColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L148">Scene/Cesium3DTilePointFeature.js 148</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the point outline color of this feature.
<p>
Only applied when <code>image</code> is <code>undefined</code>.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pointOutlineWidth">
<a href="#pointOutlineWidth" class="doc-link"></a>
pointOutlineWidth<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L168">Scene/Cesium3DTilePointFeature.js 168</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the point outline width in pixels of this feature.
<p>
Only applied when <code>image</code> is <code>undefined</code>.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pointSize">
<a href="#pointSize" class="doc-link"></a>
pointSize<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L128">Scene/Cesium3DTilePointFeature.js 128</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the point size of this feature.
<p>
Only applied when <code>image</code> is <code>undefined</code>.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="primitive">
<a href="#primitive" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> primitive<span class="type-signature"> : <a href="Cesium3DTileset.html">Cesium3DTileset</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L619">Scene/Cesium3DTilePointFeature.js 619</a>
</div>
</h4>
</div>
<div class="description">
All objects returned by <a href="Scene.html#pick"><code>Scene#pick</code></a> have a <code>primitive</code> property. This returns
the tileset containing the feature.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="scaleByDistance">
<a href="#scaleByDistance" class="doc-link"></a>
scaleByDistance<span class="type-signature"> : <a href="NearFarScalar.html">NearFarScalar</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L357">Scene/Cesium3DTilePointFeature.js 357</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the near and far scaling properties for this feature.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L87">Scene/Cesium3DTilePointFeature.js 87</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets if the feature will be shown. This is set for all features
when a style's show is evaluated.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileset">
<a href="#tileset" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tileset<span class="type-signature"> : <a href="Cesium3DTileset.html">Cesium3DTileset</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L603">Scene/Cesium3DTilePointFeature.js 603</a>
</div>
</h4>
</div>
<div class="description">
Gets the tileset containing the feature.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="translucencyByDistance">
<a href="#translucencyByDistance" class="doc-link"></a>
translucencyByDistance<span class="type-signature"> : <a href="NearFarScalar.html">NearFarScalar</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L374">Scene/Cesium3DTilePointFeature.js 374</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the near and far translucency properties for this feature.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="verticalOrigin">
<a href="#verticalOrigin" class="doc-link"></a>
verticalOrigin<span class="type-signature"> : <a href="global.html#VerticalOrigin">VerticalOrigin</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L535">Scene/Cesium3DTilePointFeature.js 535</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="getProperty">
<a href="#getProperty" class="doc-link"></a>
getProperty<span class="signature">(name)</span> &rarr; <span class="type-signature returnType">*</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L760">Scene/Cesium3DTilePointFeature.js 760</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The case-sensitive name of the property.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The value of the property or <code>undefined</code> if the feature does not have this property.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Display all the properties for a feature in the console log.
const propertyNames = feature.getPropertyNames();
const length = propertyNames.length;
for (let i = 0; i &lt; length; ++i) {
const propertyName = propertyNames[i];
console.log(propertyName + ': ' + feature.getProperty(propertyName));
}</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy">https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="getPropertyNames">
<a href="#getPropertyNames" class="doc-link"></a>
getPropertyNames<span class="signature">(<span class="optional">results</span>)</span> &rarr; <span class="type-signature returnType">Array.&lt;String></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L738">Scene/Cesium3DTilePointFeature.js 738</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>results</code></td>
<td class="type">
<span class="param-type">Array.&lt;String></span>
</td>
<td class="description last">
<span class="optional">optional</span>
An array into which to store the results.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The names of the feature's properties.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy">https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="hasProperty">
<a href="#hasProperty" class="doc-link"></a>
hasProperty<span class="signature">(name)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L725">Scene/Cesium3DTilePointFeature.js 725</a>
</div>
</h4>
</div>
<div class="description">
Returns whether the feature contains this property. This includes properties from this feature's
class and inherited classes when using a batch table hierarchy.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The case-sensitive name of the property.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Whether the feature contains this property.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy">https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="setProperty">
<a href="#setProperty" class="doc-link"></a>
setProperty<span class="signature">(name, value)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTilePointFeature.js#L811">Scene/Cesium3DTilePointFeature.js 811</a>
</div>
</h4>
</div>
<div class="description">
Sets the value of the feature's property with the given name.
<p>
If a property with the given name doesn't exist, it is created.
</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The case-sensitive name of the property.</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
The value of the property that will be copied.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: Inherited batch table hierarchy property is read only.
</div>
</li>
</ul>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const height = feature.getProperty('Height'); // e.g., the height of a building</code></pre>
<pre><code class="language-javascript">const name = 'clicked';
if (feature.getProperty(name)) {
console.log('already clicked');
} else {
feature.setProperty(name, true);
console.log('first click');
}</code></pre>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>