wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/Cesium3DTileStyle.html

2865 lines
104 KiB
HTML
Raw Normal View History

first commit
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>Cesium3DTileStyle - 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>
Cesium3DTileStyle
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Cesium3DTileStyle">
<a href="#Cesium3DTileStyle" class="doc-link"></a>
new Cesium.Cesium3DTileStyle<span class="signature">(<span class="optional">style</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L45">Scene/Cesium3DTileStyle.js 45</a>
</div>
</h4>
</div>
<div class="description">
A style that is applied to a <a href="Cesium3DTileset.html"><code>Cesium3DTileset</code></a>.
<p>
Evaluates an expression defined using the
<a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling">3D Tiles Styling language</a>.
</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>style</code></td>
<td class="type">
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
<span class="param-type">String</span>
|
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The url of a style or an object defining a style.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">tileset.style = new Cesium.Cesium3DTileStyle({
color : {
conditions : [
['${Height} >= 100', 'color("purple", 0.5)'],
['${Height} >= 50', 'color("red")'],
['true', 'color("blue")']
]
},
show : '${Height} > 0',
meta : {
description : '"Building id ${id} has height ${Height}."'
}
});</code></pre>
<pre><code class="language-javascript">tileset.style = new Cesium.Cesium3DTileStyle({
color : 'vec4(${Temperature})',
pointSize : '${Temperature} * 2.0'
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling">3D Tiles Styling language</a></li>
</ul>
</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="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1276">Scene/Cesium3DTileStyle.js 1276</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>anchorLineColor</code> property. Alternatively a string or object defining a color style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Color</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override anchorLineColor expression with a string
style.anchorLineColor = 'color("blue")';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override anchorLineColor expression with a condition
style.anchorLineColor = {
conditions : [
['${height} > 2', 'color("cyan")'],
['true', 'color("blue")']
]
};</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 class="nameContainer">
<h4 class="name" id="anchorLineEnabled">
<a href="#anchorLineEnabled" class="doc-link"></a>
anchorLineEnabled<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1223">Scene/Cesium3DTileStyle.js 1223</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>anchorLineEnabled</code> property. Alternatively a string or object defining a boolean style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Boolean</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override anchorLineEnabled expression with a string
style.anchorLineEnabled = 'true';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override anchorLineEnabled expression with a condition
style.anchorLineEnabled = {
conditions : [
['${height} > 2', 'true'],
['true', 'false']
]
};</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 class="nameContainer">
<h4 class="name" id="backgroundColor">
<a href="#backgroundColor" class="doc-link"></a>
backgroundColor<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L890">Scene/Cesium3DTileStyle.js 890</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>backgroundColor</code> property. Alternatively a string or object defining a color style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Color</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override backgroundColor expression with a string
style.backgroundColor = 'color("blue")';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override backgroundColor expression with a condition
style.backgroundColor = {
conditions : [
['${height} > 2', 'color("cyan")'],
['true', 'color("blue")']
]
};</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 class="nameContainer">
<h4 class="name" id="backgroundEnabled">
<a href="#backgroundEnabled" class="doc-link"></a>
backgroundEnabled<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L987">Scene/Cesium3DTileStyle.js 987</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>backgroundEnabled</code> property. Alternatively a string or object defining a boolean style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Boolean</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override backgroundEnabled expression with a string
style.backgroundEnabled = 'true';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override backgroundEnabled expression with a condition
style.backgroundEnabled = {
conditions : [
['${height} > 2', 'true'],
['true', 'false']
]
};</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 class="nameContainer">
<h4 class="name" id="backgroundPadding">
<a href="#backgroundPadding" class="doc-link"></a>
backgroundPadding<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L934">Scene/Cesium3DTileStyle.js 934</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>backgroundPadding</code> property. Alternatively a string or object defining a vec2 style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Cartesian2</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override backgroundPadding expression with a string
style.backgroundPadding = 'vec2(5.0, 7.0)';
style.backgroundPadding.evaluate(feature); // returns a Cartesian2</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 class="nameContainer">
<h4 class="name" id="color">
<a href="#color" class="doc-link"></a>
color<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L352">Scene/Cesium3DTileStyle.js 352</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>color</code> property. Alternatively a string or object defining a color style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Color</code>.
</p>
<p>
This expression is applicable to all tile formats.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
color : '(${Temperature} > 90) ? color("red") : color("white")'
});
style.color.evaluateColor(feature, result); // returns a Cesium.Color object</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override color expression with a custom function
style.color = {
evaluateColor : function(feature, result) {
return Cesium.Color.clone(Cesium.Color.WHITE, result);
}
};</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override color expression with a string
style.color = 'color("blue")';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override color expression with a condition
style.color = {
conditions : [
['${height} > 2', 'color("cyan")'],
['true', 'color("blue")']
]
};</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="disableDepthTestDistance">
<a href="#disableDepthTestDistance" class="doc-link"></a>
disableDepthTestDistance<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1371">Scene/Cesium3DTileStyle.js 1371</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>disableDepthTestDistance</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Number</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override disableDepthTestDistance expression with a string
style.disableDepthTestDistance = '1000.0';
style.disableDepthTestDistance.evaluate(feature); // returns a Number</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 class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1119">Scene/Cesium3DTileStyle.js 1119</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>distanceDisplayCondition</code> property. Alternatively a string or object defining a vec2 style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Cartesian2</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override distanceDisplayCondition expression with a string
style.distanceDisplayCondition = 'vec2(0.0, 5.5e6)';
style.distanceDisplayCondition.evaluate(feature); // returns a Cartesian2</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 class="nameContainer">
<h4 class="name" id="font">
<a href="#font" class="doc-link"></a>
font<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L737">Scene/Cesium3DTileStyle.js 737</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>font</code> property. Alternatively a string or object defining a string style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>String</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
font : '(${Temperature} > 90) ? "30px Helvetica" : "24px Helvetica"'
});
style.font.evaluate(feature); // returns a String</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override font expression with a custom function
style.font = {
evaluate : function(feature) {
return '24px Helvetica';
}
};</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 class="nameContainer">
<h4 class="name" id="heightOffset">
<a href="#heightOffset" class="doc-link"></a>
heightOffset<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1172">Scene/Cesium3DTileStyle.js 1172</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>heightOffset</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Number</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override heightOffset expression with a string
style.heightOffset = '2.0';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override heightOffset expression with a condition
style.heightOffset = {
conditions : [
['${height} > 2', '4.0'],
['true', '2.0']
]
};</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 class="nameContainer">
<h4 class="name" id="horizontalOrigin">
<a href="#horizontalOrigin" class="doc-link"></a>
horizontalOrigin<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1424">Scene/Cesium3DTileStyle.js 1424</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>horizontalOrigin</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>HorizontalOrigin</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
horizontalOrigin : HorizontalOrigin.LEFT
});
style.horizontalOrigin.evaluate(feature); // returns a HorizontalOrigin</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override horizontalOrigin expression with a custom function
style.horizontalOrigin = {
evaluate : function(feature) {
return HorizontalOrigin.CENTER;
}
};</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 class="nameContainer">
<h4 class="name" id="image">
<a href="#image" class="doc-link"></a>
image<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1329">Scene/Cesium3DTileStyle.js 1329</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>image</code> property. Alternatively a string or object defining a string style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>String</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
image : '(${Temperature} > 90) ? "/url/to/image1" : "/url/to/image2"'
});
style.image.evaluate(feature); // returns a String</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override image expression with a custom function
style.image = {
evaluate : function(feature) {
return '/url/to/image';
}
};</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 class="nameContainer">
<h4 class="name" id="labelColor">
<a href="#labelColor" class="doc-link"></a>
labelColor<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L580">Scene/Cesium3DTileStyle.js 580</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>labelColor</code> property. Alternatively a string or object defining a color style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Color</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelColor expression with a string
style.labelColor = 'color("blue")';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelColor expression with a condition
style.labelColor = {
conditions : [
['${height} > 2', 'color("cyan")'],
['true', 'color("blue")']
]
};</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 class="nameContainer">
<h4 class="name" id="labelHorizontalOrigin">
<a href="#labelHorizontalOrigin" class="doc-link"></a>
labelHorizontalOrigin<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1528">Scene/Cesium3DTileStyle.js 1528</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>labelHorizontalOrigin</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>HorizontalOrigin</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
labelHorizontalOrigin : HorizontalOrigin.LEFT
});
style.labelHorizontalOrigin.evaluate(feature); // returns a HorizontalOrigin</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelHorizontalOrigin expression with a custom function
style.labelHorizontalOrigin = {
evaluate : function(feature) {
return HorizontalOrigin.CENTER;
}
};</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 class="nameContainer">
<h4 class="name" id="labelOutlineColor">
<a href="#labelOutlineColor" class="doc-link"></a>
labelOutlineColor<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L631">Scene/Cesium3DTileStyle.js 631</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>labelOutlineColor</code> property. Alternatively a string or object defining a color style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Color</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelOutlineColor expression with a string
style.labelOutlineColor = 'color("blue")';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelOutlineColor expression with a condition
style.labelOutlineColor = {
conditions : [
['${height} > 2', 'color("cyan")'],
['true', 'color("blue")']
]
};</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 class="nameContainer">
<h4 class="name" id="labelOutlineWidth">
<a href="#labelOutlineWidth" class="doc-link"></a>
labelOutlineWidth<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L684">Scene/Cesium3DTileStyle.js 684</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>labelOutlineWidth</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Number</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelOutlineWidth expression with a string
style.labelOutlineWidth = '5';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelOutlineWidth expression with a condition
style.labelOutlineWidth = {
conditions : [
['${height} > 2', '5'],
['true', '0']
]
};</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 class="nameContainer">
<h4 class="name" id="labelStyle">
<a href="#labelStyle" class="doc-link"></a>
labelStyle<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L788">Scene/Cesium3DTileStyle.js 788</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>label style</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>LabelStyle</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
labelStyle : '(${Temperature} > 90) ? ' + LabelStyle.FILL_AND_OUTLINE + ' : ' + LabelStyle.FILL
});
style.labelStyle.evaluate(feature); // returns a LabelStyle</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelStyle expression with a custom function
style.labelStyle = {
evaluate : function(feature) {
return LabelStyle.FILL;
}
};</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 class="nameContainer">
<h4 class="name" id="labelText">
<a href="#labelText" class="doc-link"></a>
labelText<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L839">Scene/Cesium3DTileStyle.js 839</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>labelText</code> property. Alternatively a string or object defining a string style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>String</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
labelText : '(${Temperature} > 90) ? ">90" : "&lt;=90"'
});
style.labelText.evaluate(feature); // returns a String</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelText expression with a custom function
style.labelText = {
evaluate : function(feature) {
return 'Example label text';
}
};</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 class="nameContainer">
<h4 class="name" id="labelVerticalOrigin">
<a href="#labelVerticalOrigin" class="doc-link"></a>
labelVerticalOrigin<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1581">Scene/Cesium3DTileStyle.js 1581</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>labelVerticalOrigin</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>VerticalOrigin</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
labelVerticalOrigin : VerticalOrigin.TOP
});
style.labelVerticalOrigin.evaluate(feature); // returns a VerticalOrigin</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override labelVerticalOrigin expression with a custom function
style.labelVerticalOrigin = {
evaluate : function(feature) {
return VerticalOrigin.CENTER;
}
};</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 class="nameContainer">
<h4 class="name" id="meta">
<a href="#meta" class="doc-link"></a>
meta<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1619">Scene/Cesium3DTileStyle.js 1619</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the object containing application-specific expression that can be explicitly
evaluated, e.g., for display in a UI.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
meta : {
description : '"Building id ${id} has height ${Height}."'
}
});
style.meta.description.evaluate(feature); // returns a String with the substituted variables</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="pointOutlineColor">
<a href="#pointOutlineColor" class="doc-link"></a>
pointOutlineColor<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L474">Scene/Cesium3DTileStyle.js 474</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>pointOutlineColor</code> property. Alternatively a string or object defining a color style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Color</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointOutlineColor expression with a string
style.pointOutlineColor = 'color("blue")';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointOutlineColor expression with a condition
style.pointOutlineColor = {
conditions : [
['${height} > 2', 'color("cyan")'],
['true', 'color("blue")']
]
};</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 class="nameContainer">
<h4 class="name" id="pointOutlineWidth">
<a href="#pointOutlineWidth" class="doc-link"></a>
pointOutlineWidth<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L527">Scene/Cesium3DTileStyle.js 527</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>pointOutlineWidth</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Number</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointOutlineWidth expression with a string
style.pointOutlineWidth = '5';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointOutlineWidth expression with a condition
style.pointOutlineWidth = {
conditions : [
['${height} > 2', '5'],
['true', '0']
]
};</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 class="nameContainer">
<h4 class="name" id="pointSize">
<a href="#pointSize" class="doc-link"></a>
pointSize<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L422">Scene/Cesium3DTileStyle.js 422</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>pointSize</code> property. Alternatively a string or object defining a point size style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Number</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile or a Point Cloud tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
pointSize : '(${Temperature} > 90) ? 2.0 : 1.0'
});
style.pointSize.evaluate(feature); // returns a Number</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointSize expression with a custom function
style.pointSize = {
evaluate : function(feature) {
return 1.0;
}
};</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointSize expression with a number
style.pointSize = 1.0;</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointSize expression with a string
style.pointSize = '${height} / 10';</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override pointSize expression with a condition
style.pointSize = {
conditions : [
['${height} > 2', '1.0'],
['true', '2.0']
]
};</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="ready">
<a href="#ready" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> ready<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L214">Scene/Cesium3DTileStyle.js 214</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, the style is ready and its expressions can be evaluated. When
a style is constructed with an object, as opposed to a url, this is <code>true</code> immediately.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="readyPromise">
<a href="#readyPromise" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> readyPromise<span class="type-signature"> : Promise.&lt;<a href="Cesium3DTileStyle.html">Cesium3DTileStyle</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L228">Scene/Cesium3DTileStyle.js 228</a>
</div>
</h4>
</div>
<div class="description">
Gets the promise that will be resolved when the the style is ready and its expressions can be evaluated.
</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="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1031">Scene/Cesium3DTileStyle.js 1031</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>scaleByDistance</code> property. Alternatively a string or object defining a vec4 style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Cartesian4</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override scaleByDistance expression with a string
style.scaleByDistance = 'vec4(1.5e2, 2.0, 1.5e7, 0.5)';
style.scaleByDistance.evaluate(feature); // returns a Cartesian4</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 class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L287">Scene/Cesium3DTileStyle.js 287</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>show</code> property. Alternatively a boolean, string, or object defining a show style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return or convert to a <code>Boolean</code>.
</p>
<p>
This expression is applicable to all tile formats.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
show : '(regExp("^Chest").test(${County})) &amp;&amp; (${YearBuilt} >= 1970)'
});
style.show.evaluate(feature); // returns true or false depending on the feature's properties</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override show expression with a custom function
style.show = {
evaluate : function(feature) {
return true;
}
};</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override show expression with a boolean
style.show = true;
};</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override show expression with a string
style.show = '${Height} > 0';
};</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override show expression with a condition
style.show = {
conditions: [
['${height} > 2', 'false'],
['true', 'true']
];
};</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="style">
<a href="#style" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> style<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L189">Scene/Cesium3DTileStyle.js 189</a>
</div>
</h4>
</div>
<div class="description">
Gets the object defining the style using the
<a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling">3D Tiles Styling language</a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">{}</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="translucencyByDistance">
<a href="#translucencyByDistance" class="doc-link"></a>
translucencyByDistance<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1075">Scene/Cesium3DTileStyle.js 1075</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>translucencyByDistance</code> property. Alternatively a string or object defining a vec4 style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>Cartesian4</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override translucencyByDistance expression with a string
style.translucencyByDistance = 'vec4(1.5e2, 1.0, 1.5e7, 0.2)';
style.translucencyByDistance.evaluate(feature); // returns a Cartesian4</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 class="nameContainer">
<h4 class="name" id="verticalOrigin">
<a href="#verticalOrigin" class="doc-link"></a>
verticalOrigin<span class="type-signature"> : <a href="StyleExpression.html">StyleExpression</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileStyle.js#L1477">Scene/Cesium3DTileStyle.js 1477</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="StyleExpression.html"><code>StyleExpression</code></a> object used to evaluate the style's <code>verticalOrigin</code> property. Alternatively a string or object defining a number style can be used.
The getter will return the internal <a href="Expression.html"><code>Expression</code></a> or <a href="ConditionsExpression.html"><code>ConditionsExpression</code></a>, which may differ from the value provided to the setter.
<p>
The expression must return a <code>VerticalOrigin</code>.
</p>
<p>
This expression is only applicable to point features in a Vector tile.
</p>
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const style = new Cesium3DTileStyle({
verticalOrigin : VerticalOrigin.TOP
});
style.verticalOrigin.evaluate(feature); // returns a VerticalOrigin</code></pre>
<pre><code class="language-javascript">const style = new Cesium.Cesium3DTileStyle();
// Override verticalOrigin expression with a custom function
style.verticalOrigin = {
evaluate : function(feature) {
return VerticalOrigin.CENTER;
}
};</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>
</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>