GeoJsonPrimitive

Lightweight GeoJSON loader that converts features directly into BufferPointCollection, BufferPolylineCollection, and BufferPolygonCollection. Unlike GeoJsonDataSource, this path does not create entities. Instead, it exposes high-throughput buffer primitive collections that can be added directly to Scene#primitives.

new Cesium.GeoJsonPrimitive(options)
engine/Source/Scene/GeoJsonPrimitive.js 54

Name Type Description
options GeoJsonPrimitiveConstructorOptions optional
Example:
const loader = await Cesium.GeoJsonPrimitive.fromUrl("./data.geojson");
viewer.scene.primitives.add(loader);

loader.points;     // BufferPointCollection | undefined
loader.polylines;  // BufferPolylineCollection | undefined
loader.polygons;   // BufferPolygonCollection | undefined
loader.ids;        // source feature IDs
loader.properties; // source feature properties
Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

Members

readonly featureCount : number
engine/Source/Scene/GeoJsonPrimitive.js 214

Feature count represented by the loaded collections.

readonly ids : Array.<(string|number|undefined)>
engine/Source/Scene/GeoJsonPrimitive.js 224

Lookup table from integer ID generated by GeoJsonPrimitive, to integer or string Feature ID from GeoJSON source.

readonly points : BufferPointCollection|undefined
engine/Source/Scene/GeoJsonPrimitive.js 244

Buffer point collection for point geometries.

readonly polygons : BufferPolygonCollection|undefined
engine/Source/Scene/GeoJsonPrimitive.js 264

Buffer polygon collection for polygon geometries.

readonly polylines : BufferPolylineCollection|undefined
engine/Source/Scene/GeoJsonPrimitive.js 254

Buffer polyline collection for linestring geometries.

readonly properties : Array.<Record.<string, unknown>>
engine/Source/Scene/GeoJsonPrimitive.js 234

Source GeoJSON properties, indexed by generated integer ID.

readonly url : string|undefined
engine/Source/Scene/GeoJsonPrimitive.js 200

Loader source URL when created via GeoJsonPrimitive.fromUrl.

Methods

static Cesium.GeoJsonPrimitive.fromGeoJson(geoJson, options) → GeoJsonPrimitive
engine/Source/Scene/GeoJsonPrimitive.js 303

Creates a loader directly from a parsed GeoJSON object.
Name Type Description
geoJson object
options GeoJsonPrimitiveConstructorOptions optional
Returns:

async static Cesium.GeoJsonPrimitive.fromUrl(url, options) → Promise.<GeoJsonPrimitive>
engine/Source/Scene/GeoJsonPrimitive.js 275

Loads GeoJSON from a URL or Resource.
Name Type Description
url Resource | string
options GeoJsonPrimitiveConstructorOptions optional
Returns:

getId(featureId)
engine/Source/Scene/GeoJsonPrimitive.js 313

Name Type Description
featureId number

getProperties(featureId)
engine/Source/Scene/GeoJsonPrimitive.js 324

Name Type Description
featureId number
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets