org.cesiumjs.cs.datasources

Class GeoJsonDataSource

java.lang.Object

org.cesiumjs.cs.datasources.GeoJsonDataSource

All Implemented Interfaces:

DataSource

@JsType(isNative=true,
        namespace="Cesium",
        name="GeoJsonDataSource")
public class GeoJsonDataSource
extends Object
implements DataSource

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeoJsonDataSource.discribe This callback is displayed as part of the GeoJsonDataSource class.

Field Summary

Fields

Modifier and Type	Field and Description
Event	changedEvent Gets an event that will be raised when the underlying data changes.
static boolean	clampToGround Gets or sets default of whether to clamp to the ground.
DataSourceClock	clock This DataSource only defines static data, therefore this property is always undefined.
EntityCluster	clustering Gets or sets the clustering options for this data source.
static Object	crsLinkHrefs 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.
static Object	crsLinkTypes 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.
static Object	crsNames 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.
EntityCollection	entities Gets the collection of Entity instances.
Event	errorEvent Gets an event that will be raised if an error is encountered during processing.
static Color	fill Gets or sets default color for polygon interiors.
boolean	isLoading Gets a value indicating if the data source is currently loading data.
Event	loadingEvent Gets an event that will be raised when the data source either starts or stops loading.
static Color	markerColor Gets or sets the default color of the map pin created for each point.
static int	markerSize Gets or sets the default size of the map pin created for each point, in pixels.
static String	markerSymbol Gets or sets the default symbol of the map pin created for each point.
String	name Gets a human-readable name for this instance.
boolean	show Gets whether or not this data source should be displayed.
static Color	stroke Gets or sets the default color of polylines and polygon outlines.
static double	strokeWidth Gets or sets the default width of polylines and polygon outlines.

Constructor Summary

Constructors

Constructor and Description
GeoJsonDataSource() A DataSource which processes both GeoJSON and TopoJSON data.
GeoJsonDataSource(String name) A DataSource which processes both GeoJSON and TopoJSON data.

Method Summary

Modifier and Type	Method and Description
static Promise<GeoJsonDataSource,String>	load(JsObject data) Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.
static Promise<GeoJsonDataSource,String>	load(JsObject data, GeoJsonDataSourceOptions options) Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.
static Promise<GeoJsonDataSource,String>	load(String data) Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.
static Promise<GeoJsonDataSource,String>	load(String data, GeoJsonDataSourceOptions options) Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.
boolean	update(JulianDate time) Updates the data source to the provided time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clampToGround

@JsProperty
public static boolean clampToGround

Gets or sets default of whether to clamp to the ground. Default: false

crsLinkHrefs

@JsProperty
public static Object crsLinkHrefs

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 crsLinkHrefs, assuming the link has a type specified.

crsLinkTypes

@JsProperty
public static Object crsLinkTypes

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 crsLinkHrefs take precedence over this object.

crsNames

@JsProperty
public static Object crsNames

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'.

fill

@JsProperty
public static Color fill

Gets or sets default color for polygon interiors. Default: Color.YELLOW()

markerColor

@JsProperty
public static Color markerColor

Gets or sets the default color of the map pin created for each point. Default: Color.ROYALBLUE()

markerSize

@JsProperty
public static int markerSize

Gets or sets the default size of the map pin created for each point, in pixels. Deafult: 48

markerSymbol

@JsProperty
public static String markerSymbol

Gets or sets the default symbol of the map pin created for each point. This can be any valid Maki identifier, any single character, or blank if no symbol is to be used.

stroke

@JsProperty
public static Color stroke

Gets or sets the default color of polylines and polygon outlines. Default: Color.BLACK()

strokeWidth

@JsProperty
public static double strokeWidth

Gets or sets the default width of polylines and polygon outlines. Default: 2.0

changedEvent

@JsProperty
public Event changedEvent

Gets an event that will be raised when the underlying data changes.

clock

@JsProperty
public DataSourceClock clock

This DataSource only defines static data, therefore this property is always undefined.

clustering

@JsProperty
public EntityCluster clustering

Gets or sets the clustering options for this data source. This object can be shared between multiple data sources.

entities

@JsProperty
public EntityCollection entities

Gets the collection of Entity instances.

errorEvent

@JsProperty
public Event errorEvent

Gets an event that will be raised if an error is encountered during processing.

isLoading

@JsProperty
public boolean isLoading

Gets a value indicating if the data source is currently loading data.

loadingEvent

@JsProperty
public Event loadingEvent

Gets an event that will be raised when the data source either starts or stops loading.

name

@JsProperty
public String name

Gets a human-readable name for this instance.

show

@JsProperty
public boolean show

Gets whether or not this data source should be displayed.

Constructor Detail

GeoJsonDataSource

@JsConstructor
public GeoJsonDataSource()

A DataSource which processes both GeoJSON and TopoJSON data. simplestyle-spec properties will also be used if they are present.

GeoJsonDataSource

@JsConstructor
public GeoJsonDataSource(String name)

A DataSource which processes both GeoJSON and TopoJSON data. simplestyle-spec properties will also be used if they are present.

Parameters:

name - The name of this data source. If undefined, a name will be taken from the name of the GeoJSON file.

Method Detail

load

@JsMethod
public static Promise<GeoJsonDataSource,String> load(JsObject data)

Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.

Parameters:

data - GeoJSON object, or TopoJSON object to be loaded.

Returns:

A promise that will resolve when the data is loaded. Example: JsObject jsonObject = JsJSON.parse("{"type":"MultiPolygon","coordinates":[[[[131.50108952,43.666989],[131.50109395,44.00032979],[132.00110764,44.00032626],[132.00110313,43.66698549],[131.50108952,43.666989]]]],"crs":{"type":"name","properties":{"name":"EPSG:4326"}}}"); GeoJsonDataSource.load(jsonObject).then( new Fulfill<GeoJsonDataSource>() { {@literal @}Override public void onFulfilled(GeoJsonDataSource value) { viewer.dataSources().add(value); } }, new Reject<String>() { {@literal @}Override public void onRejected(String value) { Cesium.log(value); } });

load

@JsMethod
public static Promise<GeoJsonDataSource,String> load(String data)

Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.

Parameters:

data - A url to be loaded.

Returns:

A promise that will resolve when the data is loaded.

load

@JsMethod
public static Promise<GeoJsonDataSource,String> load(JsObject data,
                                                               GeoJsonDataSourceOptions options)

Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.

Parameters:

data - A GeoJSON object, or TopoJSON object to be loaded.

options - Options

Returns:

A promise that will resolve when the data is loaded. Example: JsObject jsonObject = JsJSON.parse("{"type":"MultiPolygon","coordinates":[[[[131.50108952,43.666989],[131.50109395,44.00032979],[132.00110764,44.00032626],[132.00110313,43.66698549],[131.50108952,43.666989]]]],"crs":{"type":"name","properties":{"name":"EPSG:4326"}}}"); GeoJsonDataSource.load(jsonObject).then( new Fulfill<GeoJsonDataSource>() { {@literal @}Override public void onFulfilled(GeoJsonDataSource value) { viewer.dataSources().add(value); } }, new Reject<String>() { {@literal @}Override public void onRejected(String value) { Cesium.log(value); } });

load

@JsMethod
public static Promise<GeoJsonDataSource,String> load(String data,
                                                               GeoJsonDataSourceOptions options)

Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data.

Parameters:

data - A url to be loaded.

options - Options

Returns:

A promise that will resolve when the data is loaded.

update

@JsMethod
 @JsIgnore
public boolean update(JulianDate time)

Description copied from interface: DataSource

Updates the data source to the provided time. This function is optional and is not required to be implemented. It is provided for data sources which retrieve data based on the current animation time or scene state. If implemented, update will be called by DataSourceDisplay once a frame.

Specified by:

update in interface DataSource

Parameters:

time - The simulation time.

Returns:

True if this data source is ready to be displayed at the provided time, false otherwise.