jukaifeng
/
cesium-examples
mirror of https://github.com/zhangti0708/cesium-examples.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cesium-examples/map/3d/static/Cesium/Build/Documentation/PolylineGraphics.html

1783 lines
70 KiB
HTML
Raw Permalink Normal View History

删除不必要的冗余文件,上传部分示例数据
2020-06-29 11:14:44 +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>PolylineGraphics - 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>
PolylineGraphics
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="PolylineGraphics">
<a href="#PolylineGraphics" class="doc-link"></a>
new Cesium.PolylineGraphics<span class="signature">(<span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L46">DataSources/PolylineGraphics.js 46</a>
</div>
</h4>
</div>
<div class="description">
Describes a polyline. The first two positions define a line segment, and each additional position defines a line segment from the previous position. The segments can be linear connected points, great arcs, or clamped to terrain.
</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>positions</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A Property specifying the array of <a href="Cartesian3.html"><code>Cartesian3</code></a> positions that define the line strip.</td>
</tr>
<tr>
<td class="name"><code>arcType</code></td>
<td class="type">
<span class="param-type"><a href="ArcType.html">ArcType</a></span>
</td>
<td class="default">
<code class="language-javascript">ArcType.GEODESIC</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The type of line the polyline segments must follow.</td>
</tr>
<tr>
<td class="name"><code>clampToGround</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A boolean Property specifying whether the Polyline should be clamped to the ground.</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A numeric Property specifying the width in pixels.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A boolean Property specifying the visibility of the polyline.</td>
</tr>
<tr>
<td class="name"><code>material</code></td>
<td class="type">
<span class="param-type"><a href="MaterialProperty.html">MaterialProperty</a></span>
</td>
<td class="default">
<code class="language-javascript">Color.WHITE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A Property specifying the material used to draw the polyline.</td>
</tr>
<tr>
<td class="name"><code>depthFailMaterial</code></td>
<td class="type">
<span class="param-type"><a href="MaterialProperty.html">MaterialProperty</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A property specifying the material used to draw the polyline when it is below the terrain.</td>
</tr>
<tr>
<td class="name"><code>granularity</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
<code class="language-javascript">Cesium.Math.RADIANS_PER_DEGREE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE.</td>
</tr>
<tr>
<td class="name"><code>shadows</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
<code class="language-javascript">ShadowMode.DISABLED</code>
</td>
<td class="description last">
<span class="optional">optional</span>
An enum Property specifying whether the polyline casts or receives shadows from each light source.</td>
</tr>
<tr>
<td class="name"><code>distanceDisplayCondition</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A Property specifying at what distance from the camera that this polyline will be displayed.</td>
</tr>
<tr>
<td class="name"><code>classificationType</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
<code class="language-javascript">ClassificationType.BOTH</code>
</td>
<td class="description last">
<span class="optional">optional</span>
An enum Property specifying whether this polyline will classify terrain, 3D Tiles, or both when on the ground.</td>
</tr>
<tr>
<td class="name"><code>zIndex</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A Property specifying the zIndex used for ordering ground geometry. Only has an effect if `clampToGround` is true and polylines on terrain is supported.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=Polyline.html">Cesium Sandcastle Polyline Demo</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Entity.html">Entity</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="arcType">
<a href="#arcType" class="doc-link"></a>
arcType<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L142">DataSources/PolylineGraphics.js 142</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="ArcType.html"><code>ArcType</code></a> Property specifying whether the line segments should be great arcs, rhumb lines or linearly connected.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">ArcType.GEODESIC</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="clampToGround">
<a href="#clampToGround" class="doc-link"></a>
clampToGround<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L151">DataSources/PolylineGraphics.js 151</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying whether the polyline should be clamped to the ground.
</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="classificationType">
<a href="#classificationType" class="doc-link"></a>
classificationType<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L183">DataSources/PolylineGraphics.js 183</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="ClassificationType.html"><code>ClassificationType</code></a> Property specifying whether this polyline will classify terrain, 3D Tiles, or both when on the ground.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">ClassificationType.BOTH</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="definitionChanged">
<a href="#definitionChanged" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>definitionChanged<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L86">DataSources/PolylineGraphics.js 86</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that is raised whenever a property or sub-property is changed or modified.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="depthFailMaterial">
<a href="#depthFailMaterial" class="doc-link"></a>
depthFailMaterial<span class="type-signature"> : <a href="MaterialProperty.html">MaterialProperty</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L118">DataSources/PolylineGraphics.js 118</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the material used to draw the polyline when it fails the depth test. <p> Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported, there may be artifacts. </p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L175">DataSources/PolylineGraphics.js 175</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="DistanceDisplayCondition.html"><code>DistanceDisplayCondition</code></a> Property specifying at what distance from the camera that this polyline will be displayed.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="granularity">
<a href="#granularity" class="doc-link"></a>
granularity<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L159">DataSources/PolylineGraphics.js 159</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE and clampToGround is false.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Cesium.Math.RADIANS_PER_DEGREE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="material">
<a href="#material" class="doc-link"></a>
material<span class="type-signature"> : <a href="MaterialProperty.html">MaterialProperty</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L106">DataSources/PolylineGraphics.js 106</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the material used to draw the polyline.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Color.WHITE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="positions">
<a href="#positions" class="doc-link"></a>
positions<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L126">DataSources/PolylineGraphics.js 126</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the array of <a href="Cartesian3.html"><code>Cartesian3</code></a> positions that define the line strip.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="shadows">
<a href="#shadows" class="doc-link"></a>
shadows<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L168">DataSources/PolylineGraphics.js 168</a>
</div>
</h4>
</div>
<div class="description">
Get or sets the enum Property specifying whether the polyline casts or receives shadows from each light source.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">ShadowMode.DISABLED</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L98">DataSources/PolylineGraphics.js 98</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying the visibility of the polyline.
</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="width">
<a href="#width" class="doc-link"></a>
width<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L134">DataSources/PolylineGraphics.js 134</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the width in pixels.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="zIndex">
<a href="#zIndex" class="doc-link"></a>
zIndex<span class="type-signature"> : <a href="ConstantProperty.html">ConstantProperty</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L191">DataSources/PolylineGraphics.js 191</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the zIndex Property specifying the ordering of the polyline. Only has an effect if `clampToGround` is true and polylines on terrain is supported.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0</code>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="clone">
<a href="#clone" class="doc-link"></a>
clone<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="PolylineGraphics.html">PolylineGraphics</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L200">DataSources/PolylineGraphics.js 200</a>
</div>
</h4>
</div>
<div class="description">
Duplicates this instance.
</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>result</code></td>
<td class="type">
<span class="param-type"><a href="PolylineGraphics.html">PolylineGraphics</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if one was not provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="merge">
<a href="#merge" class="doc-link"></a>
merge<span class="signature">(source)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/PolylineGraphics.js#L226">DataSources/PolylineGraphics.js 226</a>
</div>
</h4>
</div>
<div class="description">
Assigns each unassigned property on this object to the value of the same property on the provided source object.
</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>source</code></td>
<td class="type">
<span class="param-type"><a href="PolylineGraphics.html">PolylineGraphics</a></span>
</td>
<td class="description last">
The object to be merged into this object.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</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="ArcType"><a href="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</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="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-name="Cesium3DTileFeature"><a href="Cesium3DTileFeature.html">Cesium3DTileFeature</a></li><li data-name="Cesium3DTilePointFeature"><a href="Cesium3
</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>