cesiumpy package

Submodules

class cesiumpy.base.RistrictedList(widget, allowed, propertyname)

Bases: cesiumpy.base._CesiumObject

add(item, **kwargs)
clear()
script

return list of scripts built from entities each script may be a list of comamnds also

widget

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

class cesiumpy.camera.Camera(widget)

Bases: cesiumpy.base._CesiumObject

destination

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

flyTo(destination, orientation=None)
class cesiumpy.constants.CornerType

Bases: cesiumpy.base._CesiumEnum

BEVELED = <CornerType.BEVELED: u'Cesium.CornerType.BEVELED'>
MITERED = <CornerType.MITERED: u'Cesium.CornerType.MITERED'>
ROUNDED = <CornerType.ROUNDED: u'Cesium.CornerType.ROUNDED'>
class cesiumpy.constants.HorizontalOrigin

Bases: cesiumpy.base._CesiumEnum

CENTER = <HorizontalOrigin.CENTER: u'Cesium.HorizontalOrigin.CENTER'>
LEFT = <HorizontalOrigin.LEFT: u'Cesium.HorizontalOrigin.LEFT'>
RIGHT = <HorizontalOrigin.RIGHT: u'Cesium.HorizontalOrigin.RIGHT'>
class cesiumpy.constants.Math

Bases: cesiumpy.base._CesiumEnum

DEGREES_PER_RADIAN = <Math.RADIANS_PER_DEGREE: u'Cesium.Math.RADIANS_PER_DEGREE'>
EPSILON1 = <Math.EPSILON1: u'Cesium.Math.EPSILON1'>
EPSILON10 = <Math.EPSILON10: u'Cesium.Math.EPSILON10'>
EPSILON11 = <Math.EPSILON11: u'Cesium.Math.EPSILON11'>
EPSILON12 = <Math.EPSILON12: u'Cesium.Math.EPSILON12'>
EPSILON13 = <Math.EPSILON13: u'Cesium.Math.EPSILON13'>
EPSILON14 = <Math.EPSILON14: u'Cesium.Math.EPSILON14'>
EPSILON15 = <Math.EPSILON15: u'Cesium.Math.EPSILON15'>
EPSILON16 = <Math.EPSILON16: u'Cesium.Math.EPSILON16'>
EPSILON17 = <Math.EPSILON17: u'Cesium.Math.EPSILON17'>
EPSILON18 = <Math.EPSILON18: u'Cesium.Math.EPSILON18'>
EPSILON19 = <Math.EPSILON19: u'Cesium.Math.EPSILON19'>
EPSILON2 = <Math.EPSILON2: u'Cesium.Math.EPSILON2'>
EPSILON20 = <Math.EPSILON20: u'Cesium.Math.EPSILON20'>
EPSILON3 = <Math.EPSILON3: u'Cesium.Math.EPSILON3'>
EPSILON4 = <Math.EPSILON4: u'Cesium.Math.EPSILON4'>
EPSILON5 = <Math.EPSILON5: u'Cesium.Math.EPSILON5'>
EPSILON6 = <Math.EPSILON6: u'Cesium.Math.EPSILON6'>
EPSILON7 = <Math.EPSILON7: u'Cesium.Math.EPSILON7'>
EPSILON8 = <Math.EPSILON8: u'Cesium.Math.EPSILON8'>
EPSILON9 = <Math.EPSILON9: u'Cesium.Math.EPSILON9'>
GRAVITATIONALPARAMETER = <Math.GRAVITATIONALPARAMETER: u'Cesium.Math.GRAVITATIONALPARAMETER'>
LUNAR_RADIUS = <Math.LUNAR_RADIUS: u'Cesium.Math.LUNAR_RADIUS'>
ONE_OVER_PI = <Math.ONE_OVER_PI: u'Cesium.Math.ONE_OVER_PI'>
ONE_OVER_TWO_PI = <Math.ONE_OVER_TWO_PI: u'Cesium.Math.ONE_OVER_TWO_PI'>
PI = <Math.PI: u'Cesium.Math.PI'>
PI_OVER_FOUR = <Math.PI_OVER_FOUR: u'Cesium.Math.PI_OVER_FOUR'>
PI_OVER_SIX = <Math.PI_OVER_SIX: u'Cesium.Math.PI_OVER_SIX'>
PI_OVER_THREE = <Math.PI_OVER_THREE: u'Cesium.Math.PI_OVER_THREE'>
PI_OVER_TWO = <Math.PI_OVER_TWO: u'Cesium.Math.PI_OVER_TWO'>
RADIANS_PER_ARCSECOND = <Math.RADIANS_PER_ARCSECOND: u'RADIANS_PER_ARCSECOND'>
RADIANS_PER_DEGREE = <Math.RADIANS_PER_DEGREE: u'Cesium.Math.RADIANS_PER_DEGREE'>
SIXTY_FOUR_KILOBYTES = <Math.SIXTY_FOUR_KILOBYTES: u'Cesium.Math.SIXTY_FOUR_KILOBYTES'>
SOLAR_RADIUS = <Math.SOLAR_RADIUS: u'Cesium.Math.SOLAR_RADIUS'>
THREE_PI_OVER_TWO = <Math.THREE_PI_OVER_TWO: u'Cesium.Math.THREE_PI_OVER_TWO'>
TWO_PI = <Math.TWO_PI: u'Cesium.Math.TWO_PI'>
class cesiumpy.constants.VerticalOrigin

Bases: cesiumpy.base._CesiumEnum

BOTTOM = <VerticalOrigin.BOTTOM: u'Cesium.VerticalOrigin.BOTTOM'>
CENTER = <VerticalOrigin.CENTER: u'Cesium.VerticalOrigin.CENTER'>
TOP = <VerticalOrigin.TOP: u'Cesium.VerticalOrigin.TOP'>
class cesiumpy.datasource.CustomDataSource(sourceUri)

Bases: cesiumpy.datasource.DataSource

class cesiumpy.datasource.CzmlDataSource(sourceUri)

Bases: cesiumpy.datasource.DataSource

class cesiumpy.datasource.DataSource(sourceUri)

Bases: cesiumpy.base._CesiumObject

classmethod load(sourceUri, *args, **kwargs)
script
sourceUri
class cesiumpy.datasource.GeoJsonDataSource(sourceUri, describe=None, markerSize=None, markerSymbol=None, markerColor=None, stroke=None, strokeWidth=None, fill=None)

Bases: cesiumpy.datasource.DataSource

sourceUri : str
Overrides the url to use for resolving relative links.
describe : GeoJsonDataSource~describe, default GeoJsonDataSource.defaultDescribeProperty
A function which returns a Property object (or just a string), which converts the properties into an html description.
markerSize : int, default GeoJsonDataSource.markerSize
The default size of the map pin created for each point, in pixels.
markerSymbol : str, default GeoJsonDataSource.markerSymbol
The default symbol of the map pin created for each point.
markerColor : Color, default GeoJsonDataSource.markerColor
The default color of the map pin created for each point.
stroke : Color, default GeoJsonDataSource.stroke
The default color of polylines and polygon outlines.
strokeWidth : int, GeoJsonDataSource.strokeWidth
The default width of polylines and polygon outlines.
fill : Color, default GeoJsonDataSource.fill
The default color for polygon interiors.
fill
markerColor
markerSize

A float trait.

markerSymbol

A trait for unicode strings.

stroke
strokeWidth

A float trait.

class cesiumpy.datasource.KmlDataSource(sourceUri)

Bases: cesiumpy.datasource.DataSource

sourceUri : str
Overrides the url to use for resolving relative links and other KML network features.
class cesiumpy.provider.ArcGisImageServerTerrainProvider(url, token, proxy=None, tilingScheme=None, ellipsoid=None, credit=None)

Bases: cesiumpy.provider.TerrainProvider

url : str
The URL of the ArcGIS ImageServer service.
token : str
The authorization token to use to connect to the service.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
tilingScheme : TilingScheme, default new GeographicTilingScheme()
The tiling scheme specifying how the terrain is broken into tiles. If this parameter is not provided, a GeographicTilingScheme is used.
ellipsoid : Ellipsoid
The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme’s ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
credit : Credit or str
The credit, which will is displayed on the canvas.
token

A trait for unicode strings.

class cesiumpy.provider.ArcGisMapServerImageryProvider(url, token=None, usePreCachedTilesIfAvailable=None, layers=None, enablePickFeatures=None, rectangle=None, tillingScheme=None, ellipsoid=None, tileWidth=None, tileHeight=None, tileDiscardPolicy=None, minimumLevel=None, proxy=None)

Bases: cesiumpy.provider.ImageryProvider

ArcGisImageServerTerrainProvider

url : str
The URL of the ArcGIS MapServer service.
token : str
The ArcGIS token used to authenticate with the ArcGIS MapServer service.
usePreCachedTilesIfAvailable : bool, default True
If true, the server’s pre-cached tiles are used if they are available. If false, any pre-cached tiles are ignored and the ‘export’ service is used.
layers : str
A comma-separated list of the layers to show, or undefined if all layers should be shown.
enablePickFeatures : bool, default True
If true, ArcGisMapServerImageryProvider#pickFeatures will invoke the Identify service on the MapServer and return the features included in the response. If false, ArcGisMapServerImageryProvider#pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you don’t want this provider’s features to be pickable.
rectangle : Rectangle, default Rectangle.MAX_VALUE
The rectangle of the layer. This parameter is ignored when accessing a tiled layer.
tilingScheme : TilingScheme, default new GeographicTilingScheme()
The tiling scheme to use to divide the world into tiles. This parameter is ignored when accessing a tiled server.
ellipsoid : Ellipsoid
The ellipsoid. If the tilingScheme is specified and used, this parameter is ignored and the tiling scheme’s ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
tileWidth : int, default 256
The width of each tile in pixels. This parameter is ignored when accessing a tiled server.
tileHeight : int, default 256
The height of each tile in pixels. This parameter is ignored when accessing a tiled server.
tileDiscardPolicy : TileDiscardPolicy
The policy that determines if a tile is invalid and should be discarded. If this value is not specified, a default DiscardMissingTileImagePolicy is used for tiled map servers, and a NeverTileDiscardPolicy is used for non-tiled map servers. In the former case, we request tile 0,0 at the maximum tile level and check pixels (0,0), (200,20), (20,200), (80,110), and (160, 130). If all of these pixels are transparent, the discard check is disabled and no tiles are discarded. If any of them have a non-transparent color, any tile that has the same values in these pixel locations is discarded. The end result of these defaults should be correct tile discarding for a standard ArcGIS Server. To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter.
maximumLevel : int
The maximum tile level to request, or undefined if there is no maximum. This parameter is ignored when accessing a tiled server.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
enablePickFeatures

A boolean (True, False) trait.

layers

A trait for unicode strings.

token

A trait for unicode strings.

usePreCachedTilesIfAvailable

A boolean (True, False) trait.

class cesiumpy.provider.BingMapsImageryProvider(url, key, tileProtocol, mapStyle=None, culture=None, ellipsoid=None, tileDiscardPolicy=None, proxy=None)

Bases: cesiumpy.provider.ImageryProvider

url : str
The url of the Bing Maps server hosting the imagery.
key : str
The Bing Maps key for your application, which can be created at https://www.bingmapsportal.com/. If this parameter is not provided, BingMapsApi.defaultKey is used. If BingMapsApi.defaultKey is undefined as well, a message is written to the console reminding you that you must create and supply a Bing Maps key as soon as possible. Please do not deploy an application that uses Bing Maps imagery without creating a separate key for your application.
tileProtocol : str
The protocol to use when loading tiles, e.g. ‘http:’ or ‘https:’. By default, tiles are loaded using the same protocol as the page.
mapStyle : str, default BingMapsStyle.AERIAL
The type of Bing Maps imagery to load.
culture : str, default ‘’
The culture to use when requesting Bing Maps imagery. Not all cultures are supported. See http://msdn.microsoft.com/en-us/library/hh441729.aspx for information on the supported cultures.
ellipsoid : Ellipsoid
The ellipsoid. If not specified, the WGS84 ellipsoid is used.
tileDiscardPolicy : TileDiscardPolicy
The policy that determines if a tile is invalid and should be discarded. If this value is not specified, a default DiscardMissingTileImagePolicy is used which requests tile 0,0 at the maximum tile level and checks pixels (0,0), (120,140), (130,160), (200,50), and (200,200). If all of these pixels are transparent, the discard check is disabled and no tiles are discarded. If any of them have a non-transparent color, any tile that has the same values in these pixel locations is discarded. The end result of these defaults should be correct tile discarding for a standard Bing Maps server. To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
culture

A trait for unicode strings.

key

A trait for unicode strings.

mapStyle

A trait for unicode strings.

tileProtocol

A trait for unicode strings.

class cesiumpy.provider.CesiumTerrainProvider(url, proxy=None, requestVertexNormals=None, requestWaterMask=None, ellipsoid=None, credit=None)

Bases: cesiumpy.provider.TerrainProvider

url : str
The URL of the Cesium terrain server.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
requestVertexNormals : bool, default False
Flag that indicates if the client should request additional lighting information from the server, in the form of per vertex normals if available.
requestWaterMask : bool, default False
Flag that indicates if the client should request per tile water masks from the server, if available.
ellipsoid : Ellipsoid
The ellipsoid. If not specified, the WGS84 ellipsoid is used.
credit : Credit or str
A credit for the data source, which is displayed on the canvas.
requestVertexNormals

A boolean (True, False) trait.

requestWaterMask

A boolean (True, False) trait.

class cesiumpy.provider.EllipsoidTerrainProvider(tilingScheme=None, ellipsoid=None)

Bases: cesiumpy.provider.TerrainProvider

tilingScheme : TilingScheme, default new GeographicTilingScheme()
The tiling scheme specifying how the ellipsoidal surface is broken into tiles. If this parameter is not provided, a GeographicTilingScheme is used.
ellipsoid : Ellipsoid
The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme’s ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
url

A trait for unicode strings.

class cesiumpy.provider.GoogleEarthImageryProvider(url, channel, path=None, ellipsoid=None, tileDiscardPolicy=None, maximumLevel=None, proxy=None)

Bases: cesiumpy.provider.ImageryProvider

url : str
The url of the Google Earth server hosting the imagery.
channel : int
The channel (id) to be used when requesting data from the server. The channel number can be found by looking at the json file located at: earth.localdomain/default_map/query?request=Json&vars=geeServerDefs The /default_map path may differ depending on your Google Earth Enterprise server configuration. Look for the “id” that is associated with a “ImageryMaps” requestType. There may be more than one id available. Example: { layers: [ { id: 1002, requestType: “ImageryMaps” }, { id: 1007, requestType: “VectorMapsRaster” } ] }
path : str, default “/default_map”
The path of the Google Earth server hosting the imagery.
ellipsoid : Ellipsoid
The ellipsoid. If not specified, the WGS84 ellipsoid is used.
tileDiscardPolicy : TileDiscardPolicy
The policy that determines if a tile is invalid and should be discarded. To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter.
maximumLevel : int
The maximum level-of-detail supported by the Google Earth Enterprise server, or undefined if there is no limit.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
channel

A float trait.

path

A trait for unicode strings.

class cesiumpy.provider.GridImageryProvider

Bases: cesiumpy.provider.ImageryProvider

class cesiumpy.provider.ImageryProvider(url=None, fileExtension=None, rectangle=None, tillingScheme=None, ellipsoid=None, tileWidth=None, tileHeight=None, tileDiscardPolicy=None, minimumLevel=None, maximumLevel=None, credit=None, proxy=None, subdomains=None)

Bases: cesiumpy.provider._CesiumProvider

credit

A trait for unicode strings.

fileExtension

A trait for unicode strings.

maximumLevel

A float trait.

minimumLevel

A float trait.

rectangle
tileHeight

A float trait.

tileWidth

A float trait.

url

A trait for unicode strings.

class cesiumpy.provider.MapboxImageryProvider(url, mapId, accessToken, format=None, rectangle=None, ellipsoid=None, minimumLevel=None, maximumLevel=None, credit=None, proxy=None)

Bases: cesiumpy.provider.ImageryProvider

url : str, default ‘//api.mapbox.com/v4/’
The Mapbox server url.
mapId : str
The Mapbox Map ID.
accessToken : str
The public access token for the imagery.
format : str, default ‘png’
The format of the image request.
rectangle : Rectangle, default Rectangle.MAX_VALUE
The rectangle, in radians, covered by the image.
ellipsoid : Ellipsoid
The ellipsoid. If not specified, the WGS84 ellipsoid is used.
minimumLevel : int, default 0
The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
maximumLevel : int, default 0
The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
credit : Credit or str
A credit for the data source, which is displayed on the canvas.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
accessToken

A trait for unicode strings.

format

A trait for unicode strings.

mapId

A trait for unicode strings.

url

A trait for unicode strings.

class cesiumpy.provider.OpenStreetMapImageryProvider(url=None, fileExtension=None, rectangle=None, ellipsoid=None, minimumLevel=None, maximumLevel=None, credit=None, proxy=None)

Bases: cesiumpy.provider.ImageryProvider

url : str, default ‘//a.tile.openstreetmap.org’
The OpenStreetMap server url.
fileExtension : str, default ‘png’
The file extension for images on the server.
rectangle : Rectangle, default Rectangle.MAX_VALUE
The rectangle of the layer.
ellipsoid : Ellipsoid
The ellipsoid. If not specified, the WGS84 ellipsoid is used.
minimumLevel : int, default 0
The minimum level-of-detail supported by the imagery provider.
maximumLevel : int
The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
credit : Credit or str, default ‘MapQuest, Open Street Map and contributors, CC-BY-SA’
A credit for the data source, which is displayed on the canvas.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
class cesiumpy.provider.SingleTileImageryProvider(url, rectangle=None, ellipsoid=None, credit=None, proxy=None)

Bases: cesiumpy.provider.ImageryProvider

url : str
The url for the tile.
rectangle : Rectangle, default Rectangle.MAX_VALUE
The rectangle, in radians, covered by the image.
ellipsoid : Ellipsoid
The ellipsoid. If not specified, the WGS84 ellipsoid is used.
credit : Credit or str
A credit for the data source, which is displayed on the canvas.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
class cesiumpy.provider.TerrainProvider(url=None, proxy=None, tilingScheme=None, ellipsoid=None, credit=None)

Bases: cesiumpy.provider._CesiumProvider

credit

A trait for unicode strings.

url

A trait for unicode strings.

class cesiumpy.provider.TileCoordinatesImageryProvider(color=None, tillingScheme=None, ellipsoid=None, tileWidth=None, tileHeight=None)

Bases: cesiumpy.provider.ImageryProvider

color : cesiumpy.color.Color, default YELLOW
The color to draw the tile box and label.
tilingScheme : TilingScheme, default new GeographicTilingScheme()
The tiling scheme for which to draw tiles.
ellipsoid : Ellipsoid
The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme’s ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
tileWidth : int, default 256
The width of the tile for level-of-detail selection purposes.
tileHeight : int, default 256
The height of the tile for level-of-detail selection purposes.
class cesiumpy.provider.TileMapServiceImageryProvider(url=None, fileExtension=None, rectangle=None, tillingScheme=None, ellipsoid=None, tileWidth=None, tileHeight=None, minimumLevel=None, maximumLevel=None, credit=None, proxy=None)

Bases: cesiumpy.provider.ImageryProvider

url : str, default ‘.’
Path to image tiles on server.
fileExtension : default ‘png’
The file extension for images on the server.
rectangle : Rectangle, default Rectangle.MAX_VALUE
The rectangle, in radians, covered by the image.
tilingScheme : TilingScheme, default new GeographicTilingScheme()
The tiling scheme specifying how the ellipsoidal surface is broken into tiles. If this parameter is not provided, a WebMercatorTilingScheme is used.
ellipsoid : Ellipsoid
The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme’s ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
tileWidth : int, default 256
Pixel width of image tiles.
tileHeight : int, default 256
Pixel height of image tiles.
minimumLevel : int, default 0
The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
maximumLevel : int
The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
credit : Credit or str, default ‘’
A credit for the data source, which is displayed on the canvas.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
class cesiumpy.provider.UrlTemplateImageryProvider

Bases: cesiumpy.provider.ImageryProvider

class cesiumpy.provider.VRTheWorldTerrainProvider(url, proxy=None, ellipsoid=None, credit=None)

Bases: cesiumpy.provider.TerrainProvider

url : str
The URL of the VR-TheWorld TileMap.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
ellipsoid : Ellipsoid, default Ellipsoid.WGS84
The ellipsoid. If this parameter is not specified, the WGS84 ellipsoid is used.
credit : Credit or str
A credit for the data source, which is displayed on the canvas.
class cesiumpy.provider.WebMapServiceImageryProvider(url, layers, parameters=None, getFeatureInfoParameters=None, enablePickFeatures=None, getFeatureInfoFormats=None, rectangle=None, tillingScheme=None, ellipsoid=None, tileWidth=None, tileHeight=None, tileDiscardPolicy=None, minimumLevel=None, maximumLevel=None, credit=None, proxy=None, subdomains=None)

Bases: cesiumpy.provider.ImageryProvider

url : str
The URL of the WMS service. The URL supports the same keywords as the UrlTemplateImageryProvider.
layers : str
The layers to include, separated by commas.
parameters : Object, default WebMapServiceImageryProvider.DefaultParameters
Additional parameters to pass to the WMS server in the GetMap URL.
getFeatureInfoParameters : Object, default WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters
Additional parameters to pass to the WMS server in the GetFeatureInfo URL.
enablePickFeatures : bool, default True
If true, WebMapServiceImageryProvider#pickFeatures will invoke the GetFeatureInfo operation on the WMS server and return the features included in the response. If false, WebMapServiceImageryProvider#pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your WMS server does not support GetFeatureInfo or if you don’t want this provider’s features to be pickable.
getFeatureInfoFormats : list of GetFeatureInfoFormat, default WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats
The formats in which to try WMS GetFeatureInfo requests.
rectangle : Rectangle, default Rectangle.MAX_VALUE
The rectangle of the layer.
tilingScheme : TilingScheme, default new GeographicTilingScheme()
The tiling scheme to use to divide the world into tiles.
ellipsoid : Ellipsoid
The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme’s ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
tileWidth : int, default 256
The width of each tile in pixels.
tileHeight : int, default 256
The height of each tile in pixels.
minimumLevel : int, default 0
The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
maximumLevel : int
The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. If not specified, there is no limit.
credit : Credit or str
A credit for the data source, which is displayed on the canvas.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.

subdomains : str or list of str, default ‘abc’

enablePickFeatures

A boolean (True, False) trait.

layers

A trait for unicode strings.

class cesiumpy.provider.WebMapTileServiceImageryProvider(url, layer, style, format=None, tileMatrixSetID=None, tileMatrixLabels=None, rectangle=None, tillingScheme=None, ellipsoid=None, tileWidth=None, tileHeight=None, tileDiscardPolicy=None, minimumLevel=None, maximumLevel=None, credit=None, proxy=None, subdomains=None)

Bases: cesiumpy.provider.ImageryProvider

url : str
The base URL for the WMTS GetTile operation (for KVP-encoded requests) or the tile-URL template (for RESTful requests). The tile-URL template should contain the following variables: {style}, {TileMatrixSet}, {TileMatrix}, {TileRow}, {TileCol}. The first two are optional if actual values are hardcoded or not required by the server. The {s} keyword may be used to specify subdomains.
layer : str
The layer name for WMTS requests.
style : str
The style name for WMTS requests.
format : str, default ‘image/jpeg’
The MIME type for images to retrieve from the server.
tileMatrixSetID : str
The identifier of the TileMatrixSet to use for WMTS requests.
tileMatrixLabels : list
optional A list of identifiers in the TileMatrix to use for WMTS requests, one per TileMatrix level.
rectangle : Rectangle, default Rectangle.MAX_VALUE
The rectangle covered by the layer.
tilingScheme : TilingScheme, default new GeographicTilingScheme()
The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet.
ellipsoid : Ellipsoid
The ellipsoid. If not specified, the WGS84 ellipsoid is used.
tileWidth : int, default 256
optional The tile width in pixels.
tileHeight : int, default 256
The tile height in pixels.
minimumLevel : int, default 0
The minimum level-of-detail supported by the imagery provider.
maximumLevel : int
The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
credit : Credit or str
A credit for the data source, which is displayed on the canvas.
proxy : Proxy
A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
subdomains : str or list of str, default ‘abc’
The subdomains to use for the {s} placeholder in the URL template. If this parameter is a single string, each character in the string is a subdomain. If it is an array, each element in the array is a subdomain.
format

A trait for unicode strings.

layer

A trait for unicode strings.

style

A trait for unicode strings.

tileMatrixSetID

A trait for unicode strings.

class cesiumpy.scene.Scene(widget)

Bases: cesiumpy.base._CesiumObject

primitives
script
widget

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

class cesiumpy.viewer.Viewer(divid=None, width=u'100%', height=u'100%', animation=None, baseLayerPicker=None, fullscreenButton=None, geocoder=None, homeButton=None, infoBox=None, sceneModePicker=None, selectionIndicator=None, timeline=None, navigationHelpButton=None, navigationInstructionsInitiallyVisible=None, scene3DOnly=None, clock=None, selectedImageryProviderViewModel=None, imageryProviderViewModels=None, selectedTerrainProviderViewModel=None, terrainProviderViewModels=None, imageryProvider=None, terrainProvider=None, skyBox=None, skyAtmosphere=None, fullscreenElement=None, useDefaultRenderLoop=None, targetFrameRate=None, showRenderLoopErrors=None, automaticallyTrackDataSourceClocks=None, contextOptions=None, sceneMode=None, mapProjection=None, globe=None, orderIndependentTranslucency=None, creditContainer=None, dataSources=None, terrainExaggeration=None)

Bases: cesiumpy.base._CesiumBase

divid : str
id string used in div tag
width : str
width of div tag, should be provided as css format like “100%” or “100px”
height : str
height of div tag, should be provided as css format like “100%” or “100px”
animation : bool, default True
If set to false, the Animation widget will not be created.
baseLayerPicker : bool, default True
If set to false, the BaseLayerPicker widget will not be created.
fullscreenButton : bool, default True
If set to false, the FullscreenButton widget will not be created.
geocoder : bool, default True
If set to false, the Geocoder widget will not be created.
homeButton : bool, default True
If set to false, the HomeButton widget will not be created.
infoBox : bool, default True
If set to false, the InfoBox widget will not be created.
sceneModePicker : bool, default True
If set to false, the SceneModePicker widget will not be created.
selectionIndicator : bool, default True
If set to false, the SelectionIndicator widget will not be created.
timeline : bool, default True
If set to false, the Timeline widget will not be created.
navigationHelpButton : bool, default True
If set to the false, the navigation help button will not be created.
navigationInstructionsInitiallyVisible : bool, defaut True
True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button.
scene3DOnly : bool, default False
When true, each geometry instance will only be rendered in 3D to save GPU memory.
clock : Clock, default new Clock()
The clock to use to control current time.
selectedImageryProviderViewModel : ProviderViewModel
The view model for the current base imagery layer, if not supplied the first available base layer is used. This value is only valid if options.baseLayerPicker is set to true.
imageryProviderViewModels : list of ProviderViewModel, default createDefaultImageryProviderViewModels()
The list of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true.
selectedTerrainProviderViewModel : ProviderViewModel
The view model for the current base terrain layer, if not supplied the first available base layer is used. This value is only valid if options.baseLayerPicker is set to true.
terrainProviderViewModels : list of ProviderViewModel, default createDefaultTerrainProviderViewModels()
The list of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true.
imageryProvider : ImageryProvider, default new BingMapsImageryProvider()
The imagery provider to use. This value is only valid if options.baseLayerPicker is set to false.
terrainProvider : TerrainProvider, default new EllipsoidTerrainProvider()
The terrain provider to use
skyBox : SkyBox
The skybox used to render the stars. When undefined, the default stars are used.
skyAtmosphere : SkyAtmosphere
Blue sky, and the glow around the Earth’s limb. Set to false to turn it off.
fullscreenElement : Element or str, default document.body
The element or id to be placed into fullscreen mode when the full screen button is pressed.
useDefaultRenderLoop : bool, default True
True if this widget should control the render loop, false otherwise.
targetFrameRate : float
The target frame rate when using the default render loop.
showRenderLoopErrors : bool, default True
If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
automaticallyTrackDataSourceClocks : bool, default True
If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource’s clock changes. Set this to false if you want to configure the clock independently.
contextOptions : Object
Context and WebGL creation properties corresponding to options passed to Scene.
sceneMode : SceneMode, default SceneMode.SCENE3D
The initial scene mode.
mapProjection : MapProjection, default new GeographicProjection()
The map projection to use in 2D and Columbus View modes.
globe : Globe, default new Globe(mapProjection.ellipsoid)
The globe to use in the scene. If set to false, no globe will be added.
orderIndependentTranslucency : bool, default True
If true and the configuration supports it, use order independent translucency.
creditContainer : Element or str
The DOM element or ID that will contain the CreditDisplay. If not specified, the credits are added to the bottom of the widget itself.
dataSources : list of DataSource
The collection of data sources visualized by the widget. If this parameter is provided, the instance is assumed to be owned by the caller and will not be destroyed when the viewer is destroyed.
terrainExaggeration : float, default 1.
A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.
animation

A boolean (True, False) trait.

automaticallyTrackDataSourceClocks

A boolean (True, False) trait.

baseLayerPicker

A boolean (True, False) trait.

fullscreenButton

A boolean (True, False) trait.

geocoder

A boolean (True, False) trait.

homeButton

A boolean (True, False) trait.

infoBox

A boolean (True, False) trait.

navigationHelpButton

A boolean (True, False) trait.

navigationInstructionsInitiallyVisible

A boolean (True, False) trait.

plot
sceneModePicker

A boolean (True, False) trait.

selectionIndicator

A boolean (True, False) trait.

timeline

A boolean (True, False) trait.

class cesiumpy.widget.CesiumWidget(divid=None, width=u'100%', height=u'100%', clock=None, imageryProvider=None, terrainProvider=None, skyBox=None, skyAtmosphere=None, sceneMode=None, scene3DOnly=None, orderIndependentTranslucency=None, mapProjection=None, globe=None, useDefaultRenderLoop=None, targetFrameRate=None, showRenderLoopErrors=None, contextOptions=None, creditContainer=None, terrainExaggeration=None)

Bases: cesiumpy.base._CesiumBase

divid : str
id string used in div tag
width : str
width of div tag, should be provided as css format like “100%” or “100px”
height : str
height of div tag, should be provided as css format like “100%” or “100px”
clock : Clock, default new Clock()
The clock to use to control current time.
imageryProvider : ImageryProvider, default new BingMapsImageryProvider()
The imagery provider to serve as the base layer. If set to false, no imagery provider will be added.
terrainProvider : TerrainProvider, default new EllipsoidTerrainProvider()
The terrain provider.
skyBox : SkyBox
The skybox used to render the stars. When undefined, the default stars are used. If set to false, no skyBox, Sun, or Moon will be added.
skyAtmosphere : SkyAtmosphere
Blue sky, and the glow around the Earth’s limb. Set to false to turn it off.
sceneMode : SceneMode, default SceneMode.SCENE3D
The initial scene mode.
scene3DOnly : bool, default False
When true, each geometry instance will only be rendered in 3D to save GPU memory.
orderIndependentTranslucency : bool, default True
If true and the configuration supports it, use order independent translucency.
mapProjection : MapProjection, default new GeographicProjection()
The map projection to use in 2D and Columbus View modesself.
globe : Globe, default new Globe(mapProjection.ellipsoid)
The globe to use in the scene. If set to false, no globe will be added.
useDefaultRenderLoop : bool, default True
True if this widget should control the render loop, false otherwise.
targetFrameRate : int
The target frame rate when using the default render loop.
showRenderLoopErrors : bool, default True
If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
contextOptions : Object
Context and WebGL creation properties corresponding to options passed to Scene.
creditContainer : Element or str
The DOM element or ID that will contain the CreditDisplay. If not specified, the credits are added to the bottom of the widget itself.
terrainExaggeration : float, default 1.
A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.

Module contents