cesium-examples/map/3d/static/Cesium/Build/Documentation/GeoJsonDataSource.html

2576 lines
82 KiB
HTML
Raw Permalink Normal View History

<!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>GeoJsonDataSource - 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>
GeoJsonDataSource
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="GeoJsonDataSource">
<a href="#GeoJsonDataSource" class="doc-link"></a>
new Cesium.GeoJsonDataSource<span class="signature">(<span class="optional">name</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L504">DataSources/GeoJsonDataSource.js 504</a>
</div>
</h4>
</div>
<div class="description">
A <a href="DataSource.html"><code>DataSource</code></a> which processes both <a href="http://www.geojson.org/">GeoJSON</a> and <a href="https://github.com/mbostock/topojson">TopoJSON</a> data. <a href="https://github.com/mapbox/simplestyle-spec">simplestyle-spec</a> properties will also be used if they are present.
</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">
<span class="optional">optional</span>
The name of this data source. If undefined, a name will be taken from the name of the GeoJSON file.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">var viewer = new Cesium.Viewer('cesiumContainer'); viewer.dataSources.add(Cesium.GeoJsonDataSource.load('../../SampleData/ne_10m_us_states.topojson', { stroke: Cesium.Color.HOTPINK, fill: Cesium.Color.PINK, strokeWidth: 3, markerSymbol: '?' }));</code></pre>
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=GeoJSON%2520and%2520TopoJSON.html">Cesium Sandcastle GeoJSON and TopoJSON Demo</a></li>
<li><a href="https://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=GeoJSON%2520simplestyle.html">Cesium Sandcastle GeoJSON simplestyle Demo</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".clampToGround">
<a href="#.clampToGround" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.clampToGround<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L628">DataSources/GeoJsonDataSource.js 628</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets default of whether to clamp 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=".crsLinkHrefs">
<a href="#.crsLinkHrefs" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.crsLinkHrefs<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L660">DataSources/GeoJsonDataSource.js 660</a>
</div>
</h4>
</div>
<div class="description">
Gets an object that maps the href property of a crs link to a callback function which takes the crs properties object and returns a Promise that resolves to a function that takes a GeoJSON coordinate and transforms it into a WGS84 Earth-fixed Cartesian. Items in this object take precedence over those defined in <code>crsLinkHrefs</code>, assuming the link has a type specified.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".crsLinkTypes">
<a href="#.crsLinkTypes" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.crsLinkTypes<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L674">DataSources/GeoJsonDataSource.js 674</a>
</div>
</h4>
</div>
<div class="description">
Gets an object that maps the type property of a crs link to a callback function which takes the crs properties object and returns a Promise that resolves to a function that takes a GeoJSON coordinate and transforms it into a WGS84 Earth-fixed Cartesian. Items in <code>crsLinkHrefs</code> take precedence over this object.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".crsNames">
<a href="#.crsNames" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.crsNames<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L645">DataSources/GeoJsonDataSource.js 645</a>
</div>
</h4>
</div>
<div class="description">
Gets an object that maps the name of a crs to a callback function which takes a GeoJSON coordinate and transforms it into a WGS84 Earth-fixed Cartesian. Older versions of GeoJSON which supported the EPSG type can be added to this list as well, by specifying the complete EPSG name, for example 'EPSG:4326'.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".fill">
<a href="#.fill" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.fill<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L614">DataSources/GeoJsonDataSource.js 614</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets default color for polygon interiors.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Color.YELLOW</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".markerColor">
<a href="#.markerColor" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.markerColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L572">DataSources/GeoJsonDataSource.js 572</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the default color of the map pin created for each point.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Color.ROYALBLUE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".markerSize">
<a href="#.markerSize" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.markerSize<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L543">DataSources/GeoJsonDataSource.js 543</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the default size of the map pin created for each point, in pixels.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">48</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".markerSymbol">
<a href="#.markerSymbol" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.markerSymbol<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L558">DataSources/GeoJsonDataSource.js 558</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the default symbol of the map pin created for each point. This can be any valid <a href="http://mapbox.com/maki/">Maki</a> identifier, any single character, or blank if no symbol is to be used.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".stroke">
<a href="#.stroke" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.stroke<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L586">DataSources/GeoJsonDataSource.js 586</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the default color of polylines and polygon outlines.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Color.BLACK</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".strokeWidth">
<a href="#.strokeWidth" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.strokeWidth<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L600">DataSources/GeoJsonDataSource.js 600</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the default width of polylines and polygon outlines.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">2.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="changedEvent">
<a href="#changedEvent" class="doc-link"></a>
changedEvent<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/GeoJsonDataSource.js#L732">DataSources/GeoJsonDataSource.js 732</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that will be raised when the underlying data changes.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clock">
<a href="#clock" class="doc-link"></a>
clock<span class="type-signature"> : <a href="DataSourceClock.html">DataSourceClock</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L703">DataSources/GeoJsonDataSource.js 703</a>
</div>
</h4>
</div>
<div class="description">
This DataSource only defines static data, therefore this property is always undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clustering">
<a href="#clustering" class="doc-link"></a>
clustering<span class="type-signature"> : <a href="EntityCluster.html">EntityCluster</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L777">DataSources/GeoJsonDataSource.js 777</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the clustering options for this data source. This object can be shared between multiple data sources.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="entities">
<a href="#entities" class="doc-link"></a>
entities<span class="type-signature"> : <a href="EntityCollection.html">EntityCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L712">DataSources/GeoJsonDataSource.js 712</a>
</div>
</h4>
</div>
<div class="description">
Gets the collection of <a href="Entity.html"><code>Entity</code></a> instances.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="errorEvent">
<a href="#errorEvent" class="doc-link"></a>
errorEvent<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/GeoJsonDataSource.js#L742">DataSources/GeoJsonDataSource.js 742</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that will be raised if an error is encountered during processing.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isLoading">
<a href="#isLoading" class="doc-link"></a>
isLoading<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L722">DataSources/GeoJsonDataSource.js 722</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if the data source is currently loading data.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="loadingEvent">
<a href="#loadingEvent" class="doc-link"></a>
loadingEvent<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/GeoJsonDataSource.js#L752">DataSources/GeoJsonDataSource.js 752</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that will be raised when the data source either starts or stops loading.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="name">
<a href="#name" class="doc-link"></a>
name<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L687">DataSources/GeoJsonDataSource.js 687</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets a human-readable name for this instance.
</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/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L762">DataSources/GeoJsonDataSource.js 762</a>
</div>
</h4>
</div>
<div class="description">
Gets whether or not this data source should be displayed.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".load">
<a href="#.load" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GeoJsonDataSource.load<span class="signature">(data, <span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;<a href="GeoJsonDataSource.html">GeoJsonDataSource</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L532">DataSources/GeoJsonDataSource.js 532</a>
</div>
</h4>
</div>
<div class="description">
Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.
</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>data</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">
A url, GeoJSON object, or TopoJSON object to be loaded.</td>
</tr>
<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>
An 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>sourceUri</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Overrides the url to use for resolving relative links.</td>
</tr>
<tr>
<td class="name"><code>markerSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.markerSize</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default size of the map pin created for each point, in pixels.</td>
</tr>
<tr>
<td class="name"><code>markerSymbol</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.markerSymbol</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default symbol of the map pin created for each point.</td>
</tr>
<tr>
<td class="name"><code>markerColor</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.markerColor</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default color of the map pin created for each point.</td>
</tr>
<tr>
<td class="name"><code>stroke</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.stroke</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default color of polylines and polygon outlines.</td>
</tr>
<tr>
<td class="name"><code>strokeWidth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.strokeWidth</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default width of polylines and polygon outlines.</td>
</tr>
<tr>
<td class="name"><code>fill</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.fill</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default color for polygon interiors.</td>
</tr>
<tr>
<td class="name"><code>clampToGround</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.clampToGround</code>
</td>
<td class="description last">
<span class="optional">optional</span>
true if we want the geometry features (polygons or linestrings) clamped to the ground.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise that will resolve when the data is loaded.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="load">
<a href="#load" class="doc-link"></a>
load<span class="signature">(data, <span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;<a href="GeoJsonDataSource.html">GeoJsonDataSource</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L810">DataSources/GeoJsonDataSource.js 810</a>
</div>
</h4>
</div>
<div class="description">
Asynchronously loads the provided GeoJSON or TopoJSON data, replacing any existing data.
</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>data</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">
A url, GeoJSON object, or TopoJSON object to be loaded.</td>
</tr>
<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>
An 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>sourceUri</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Overrides the url to use for resolving relative links.</td>
</tr>
<tr>
<td class="name"><code>describe</code></td>
<td class="type">
<span class="param-type"><a href="GeoJsonDataSource.html#~describe">GeoJsonDataSource~describe</a></span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.defaultDescribeProperty</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A function which returns a Property object (or just a string), which converts the properties into an html description.</td>
</tr>
<tr>
<td class="name"><code>markerSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.markerSize</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default size of the map pin created for each point, in pixels.</td>
</tr>
<tr>
<td class="name"><code>markerSymbol</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.markerSymbol</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default symbol of the map pin created for each point.</td>
</tr>
<tr>
<td class="name"><code>markerColor</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.markerColor</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default color of the map pin created for each point.</td>
</tr>
<tr>
<td class="name"><code>stroke</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.stroke</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default color of polylines and polygon outlines.</td>
</tr>
<tr>
<td class="name"><code>strokeWidth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.strokeWidth</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default width of polylines and polygon outlines.</td>
</tr>
<tr>
<td class="name"><code>fill</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.fill</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The default color for polygon interiors.</td>
</tr>
<tr>
<td class="name"><code>clampToGround</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">GeoJsonDataSource.clampToGround</code>
</td>
<td class="description last">
<span class="optional">optional</span>
true if we want the features clamped to the ground.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
a promise that will resolve when the GeoJSON is loaded.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id="~describe">
<a href="#~describe" class="doc-link"></a>
describe<span class="signature">(properties, nameProperty)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/DataSources/GeoJsonDataSource.js#L921">DataSources/GeoJsonDataSource.js 921</a>
</div>
</h4>
</div>
<div class="description">
This callback is displayed as part of the GeoJsonDataSource class.
</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>properties</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
The properties of the feature.</td>
</tr>
<tr>
<td class="name"><code>nameProperty</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The property key that Cesium estimates to have the name of the feature.</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>