Map

查阅Cesium API

继承

• BaseClass

成员(属性)

继承自:

• BaseClass#enabledEvent

默认值: true

这个可以设置到显存的50% 左右，合理设置此值可以有效的减少甚至避免 WebGL 由于爆显存而导致的报错。

值得注意的是：
   这里设置的最大使用显存并不是一个强制性的值，它仅仅起到一个阈值的作用。
   也就是当场景中 3DTiles 使用的显存超过该值时，才会触发缓存回收机制。
   而缓存回收后，使用的总显存并不一定会降到该值以下。
   比如，在当前相机视角下，3DTiles 需要 200MB 才能达到对应的显示精度，
   而最大使用显存设置到 100MB 时，最终使用的显存将以 Cesium 需要的显存为准，也就是 200MB。

默认值: 3.0

方法

返回值:

返回值:

返回值:

继承自:

• BaseClass#addEventParent

返回值:

返回值:

返回值:

使用示例:

//内置的默认右键菜单获取方法
    var defaultContextmenuItems =map.getDefaultContextMenu()
    map.bindContextMenu(defaultContextmenuItems)

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

继承自:

• BaseClass#fire

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

继承自:

• BaseClass#hasEventParent

返回值:

返回值:

返回值:

返回值:

继承自:

• BaseClass#listens

返回值:

继承自:

• BaseClass#off

返回值:

继承自:

• BaseClass#on

返回值:

继承自:

• BaseClass#once

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

继承自:

• BaseClass#removeEventParent

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

返回值:

定义的类型

属性:

属性名称	类型	可选	描述信息
type	string | LayerType		图层类型
多个参数	*	<可选>	每种不同type都有自己的不同属性，具体参考LayerType找到type对应的BaseTileLayer子类图层类,查看其构造参数

参考:

• LayerType

属性:

属性名称	类型	可选	默认值	描述信息
homeButton	boolean	<可选>	false	视角复位按钮，是否显示
zoom	object	<可选>		放大缩小按钮 , 对应 Zoom构造参数
sceneModePicker	boolean	<可选>	false	二三维切换按钮，是否显示二维、三维、2.5D视图切换按钮
projectionPicker	boolean	<可选>	false	投影切换按钮, 是否显示用于在透视和正投影之间进行切换按钮
fullscreenButton	boolean	<可选>	false	全屏按钮，是否显示
fullscreenElement	Element | string	<可选>	document.body	当按下全屏按钮时，要置于全屏模式的元素或id
vrButton	boolean	<可选>	false	VR效果按钮，是否显示
geocoder	boolean | Array.<Cesium.GeocoderService>	<可选>	false	是否显示 地名查找按钮 控件，是Cesium原生控件
navigationHelpButton	boolean	<可选>	false	帮助按钮，是否显示
navigationInstructionsInitiallyVisible	boolean	<可选>	true	帮助按钮 在用户明确单击按钮之前是否自动显示
baseLayerPicker	boolean	<可选>	false	是否显示 底图切换 按钮，是Cesium原生控件, 如果true底图是Cesium机制控制，Map内的basemaps相关获取和控制将会无效。
imageryProviderViewModels	Array.<Cesium.ProviderViewModel>	<可选>	[]	baseLayerPicker底图切换面板中，用于图像的ProviderViewModel实例数组，默认自动根据basemaps数组生成。
selectedImageryProviderViewModel	Cesium.ProviderViewModel	<可选>		baseLayerPicker底图切换面板中，如果没有提供当前基本图像层的视图模型，则使用第一个可用的图像层。默认为show:true的basemaps图层
terrainProviderViewModels	Array.<Cesium.ProviderViewModel>	<可选>	[]	baseLayerPicker底图切换面板中，用于地形的ProviderViewModel实例数组。默认自动使用terrain配置+无地形。
selectedTerrainProviderViewModel	Cesium.ProviderViewModel	<可选>		baseLayerPicker底图切换面板中，如果没有提供当前基础地形层的视图模型，则使用第一个可用的地形层。
compass	object	<可选>		导航球, 对应 Compass构造参数
locationBar	object	<可选>		状态栏, 对应 LocationBar构造参数 Properties 属性 属性名称 类型 可选 描述信息 fps boolean <可选> 是否显示实时FPS帧率 format string | function <可选> 显示内容的格式化html展示的内容格式化字符串。 支持以下模版配置：【鼠标所在位置】 经度:{lng}， 纬度:{lat}， 海拔：{alt}米， 【相机的】 方向角度：{heading}， 俯仰角度：{pitch}， 视高：{cameraHeight}米， 【地图的】 层级：{level}，
distanceLegend	object	<可选>		比例尺, 对应 DistanceLegend构造参数
clockAnimate	object	<可选>		时钟控制, 对应ClockAnimate构造参数
animation	boolean	<可选>	true	时钟仪表控制(Cesium原生)
animationTicks	Array.<number>	<可选>		时钟仪表控制(Cesium原生)的可选步长
timeline	boolean	<可选>	true	时间线, 是否创建下侧时间线控件面板
overviewMap	object	<可选>		鹰眼地图, 对应OverviewMap构造参数
mapSplit	object	<可选>		卷帘对比, 对应MapSplit构造参数
keyboardRoam	object	<可选>		键盘漫游, 对应KeyboardRoam构造参数
mouseDownView	boolean	<可选>		鼠标滚轮缩放美化样式(指示图标), 对应 MouseDownView构造参数
infoBox	boolean	<可选>	true	信息面板，是否显示点击要素之后显示的信息，是Cesium原生控件
selectionIndicator	boolean	<可选>	true	选中框，是否显示选择模型时的绿色框，是Cesium原生控件
showRenderLoopErrors	boolean	<可选>	true	如果为true，则在发生渲染循环错误时，此小部件将自动向包含错误的用户显示HTML面板，是Cesium原生控件
contextmenu	object	<可选>		内置 右键菜单 控制参数, 对应ContextMenu构造参数 Properties 属性 属性名称 类型 可选 默认值 描述信息 preventDefault boolean <可选> true 是否取消右键菜单 hasDefault boolean <可选> true 是否绑定默认的地图右键菜单
popup	object	<可选>		内置 Popup 控制参数 Properties 属性 属性名称 类型 可选 默认值 描述信息 depthTest boolean <可选> true 是否打开深度判断（true时判断是否在球背面）
tooltip	object	<可选>		内置 Tooltip 控制参数 Properties 属性 属性名称 类型 可选 默认值 描述信息 cacheTime number <可选> 20 延迟缓存的时间，单位：毫秒

参考:

• ControlType

属性:

属性名称	类型	可选	描述信息
bloom	object	<可选>	泛光,对应BloomEffect构造参数
brightness	object	<可选>	亮度,对应BrightnessEffect构造参数
rain	object	<可选>	雨天气,对应RainEffect构造参数
snow	object	<可选>	雪天气 ,对应SnowEffect构造参数
snowCover	object	<可选>	地面积雪,对应SnowCoverEffect构造参数
fog	object	<可选>	雾天气,对应FogEffect构造参数
depthOfField	object	<可选>	景深,对应DepthOfFieldEffect构造参数
mosaic	object	<可选>	马赛克,对应MosaicEffect构造参数
nightVision	object	<可选>	夜视,对应NightVisionEffect构造参数
blackAndWhite	object	<可选>	黑白,对应BlackAndWhiteEffect构造参数
outline	object	<可选>	对象轮廓描边,对应OutlineEffect构造参数
bloomTarget	object	<可选>	对象泛光,对应BloomTargetEffect构造参数

参考:

• EffectType

属性:

属性名称	类型	描述信息
load	string	地图初始化完成事件(地形、所有图层完成初始化)
addLayer	string	添加图层
removeLayer	string	移除图层
terrainChange	string	地形变化
tileLoadProgress	string	地图中瓦片加载进度变化
cameraMoveStart	string	相机开启移动前 场景事件
cameraMoveEnd	string	相机移动完成后 场景事件
cameraChanged	string	相机位置完成 场景事件
preUpdate	string	场景更新前 场景事件
postUpdate	string	场景更新后 场景事件
preRender	string	场景渲染前 场景事件
postRender	string	场景渲染后 场景事件
morphStart	string	场景模式(2D/3D/哥伦布)变换前 场景事件
morphComplete	string	完成场景模式(2D/3D/哥伦布)变换 场景事件
clockTick	string	时钟跳动 场景事件
renderError	string	场景渲染失败（需要刷新页面）
click	string	左键单击 鼠标事件
clickGraphic	string	左键单击到矢量或模型数据时 鼠标事件
clickTileGraphic	string	左键单击到wms或arcgis瓦片服务的对应矢量数据时
clickMap	string	左键单击地图空白（未单击到矢量或模型数据）时 鼠标事件
dblClick	string	左键双击 鼠标事件
leftDown	string	左键鼠标按下 鼠标事件
leftUp	string	左键鼠标按下后释放 鼠标事件
mouseMove	string	鼠标移动 鼠标事件
mouseMoveTarget	string	鼠标移动（拾取目标，并延迟处理） 鼠标事件
wheel	string	鼠标滚轮滚动 鼠标事件
rightClick	string	右键单击 鼠标事件
rightDown	string	右键鼠标按下 鼠标事件
rightUp	string	右键鼠标按下后释放 鼠标事件
middleClick	string	中键单击 鼠标事件
middleDown	string	中键鼠标按下 鼠标事件
middleUp	string	中键鼠标按下后释放 鼠标事件
pinchStart	string	在触摸屏上两指缩放开始 鼠标事件
pinchEnd	string	在触摸屏上两指缩放结束 鼠标事件
pinchMove	string	在触摸屏上两指移动 鼠标事件
mouseDown	string	鼠标按下 [左中右3键都触发] 鼠标事件
mouseUp	string	鼠标按下后释放 [左中右3键都触发] 鼠标事件
mouseOver	string	鼠标移入 鼠标事件
mouseOut	string	鼠标移出 鼠标事件
keydown	string	按键按下 键盘事件
keyup	string	按键按下后释放 键盘事件
popupOpen	string	popup弹窗打开后
popupClose	string	popup弹窗关闭
tooltipOpen	string	tooltip弹窗打开后
tooltipClose	string	tooltip弹窗关闭
contextMenuOpen	string	右键菜单 打开后
contextMenuClose	string	右键菜单 关闭
contextMenuClick	string	右键菜单 单击某一项后

使用示例:

//绑定监听事件
map.on(mars3d.EventType.click, function (event) {
  console.log('单击了地图对象', event)
})

参考:

• BaseClass#on
• BaseClass#off

属性:

属性名称	类型	可选	默认值	描述信息
type	string | LayerType			图层类型
id	string | number	<可选>		图层id标识
pid	string | number	<可选>	-1	图层父级的id，一般图层管理中使用
name	string	<可选>	''	图层名称
show	boolean	<可选>	true	图层是否显示
center	object	<可选>		图层自定义定位视角，默认根据数据情况自动定位。
popup	object	<可选>		当图层支持popup弹窗时，绑定的值
popupOptions	Popup.StyleOptions	<可选>		popup弹窗时的配置参数
tooltip	object	<可选>		当图层支持tooltip弹窗时，绑定的值
tooltipOptions	Tooltip.StyleOptions	<可选>		tooltip弹窗时的配置参数
多个参数	*	<可选>		每种type都有自己的不同属性，具体参考LayerType找到type对应的图层类,查看其构造参数

参考:

• LayerType

属性:

属性名称	类型	可选	默认值	描述信息
enabledMoveTarget	boolean	<可选>	true	是否开启鼠标移动事件的拾取矢量数据
moveDelay	number	<可选>	30	鼠标移动事件的延迟毫秒数
pickWidth	number	<可选>	4	拾取时所选矩形的宽度，单位：像素
pickHeight	number	<可选>	4	拾取时所选矩形的高度，单位：像素
pickLimit	number	<可选>	9	在允许allowDrillPick穿透拾取时，限制拾取的对象个数。
transform	function	<可选>		在body或地图DIV上设置了scale等css缩放时，需要该方法转换像素坐标值。如： transform: function (position) { return new Cesium.Cartesian2(position.x / 0.5, position.y / 0.5); }

参考:

• MouseEvent

属性:

属性名称	类型	可选	默认值	描述信息
center	object	<可选>		默认相机视角 Properties 属性 属性名称 类型 可选 描述信息 lng number 经度值, 180 - 180 lat number 纬度值, -90 - 90 alt number 高度值 heading number <可选> 方向角度值，绕垂直于地心的轴旋转角度, 0至360 pitch number <可选> 俯仰角度值，绕纬度线旋转角度,-90至90 roll number <可选> 翻滚角度值，绕经度线旋转角度, -90至90
extent	object	<可选>		矩形范围 相机视角,与center二选一 Properties 属性 属性名称 类型 描述信息 xmin number 最小经度值, -180 至 180 xmax number 最大经度值, -180 至 180 ymin number 最小纬度值, -90 至 90 ymax number 最大纬度值, -90 至 90
removeDblClick	boolean	<可选>	false	是否移除Cesium默认的双击事件
ionToken	string	<可选>		Cesium Ion服务的 Token令牌
resolutionScale	number	<可选>	1.0	获取或设置渲染分辨率的缩放比例。小于1.0的值可以改善性能不佳的设备上的性能，而值大于1.0则将以更高的速度呈现分辨率，然后缩小比例，从而提高视觉保真度。例如，如果窗口小部件的尺寸为640x480，则将此值设置为0.5将导致场景以320x240渲染，然后在设置时按比例放大设置为2.0将导致场景以1280x960渲染，然后按比例缩小。 以下是Cesium.Scene对象相关参数
showSun	boolean	<可选>		是否显示太阳，如修改对象可以用 map.scene.sun
showMoon	boolean	<可选>		是否显示月亮，如修改对象可以用 map.scene.moon
showSkyBox	boolean	<可选>		是否显示天空盒，如修改对象可以用 map.scene.skyBox
showSkyAtmosphere	boolean	<可选>		是否显示地球大气层外光圈，如修改对象可以用 map.scene.skyAtmosphere
fog	boolean	<可选>		是否启用雾化效果，如修改对象可以用 map.scene.fog
fxaa	boolean	<可选>		是否开启快速抗锯齿
highDynamicRange	boolean	<可选>		是否关闭高动态范围渲染(不关闭时地图会变暗)
backgroundColor	string	<可选>		空间背景色 ，css颜色值 以下是Cesium.Viewer所支持的options【控件相关的写在另外的control属性中】
sceneMode	Cesium.SceneMode	<可选>	Cesium.SceneMode.SCENE3D	初始场景模式。可以设置进入场景后初始是2D、2.5D、3D 模式。
scene3DOnly	boolean	<可选>	false	为 true 时，每个几何实例将仅以3D渲染以节省GPU内存。
mapProjection	Cesium.MapProjection	<可选>	new Cesium.GeographicProjection()	在二维模式下时，地图的呈现坐标系，默认为EPSG4326坐标系，如果需要EPSG3857墨卡托坐标系展示，传 new Cesium.WebMercatorProjection() 即可
mapMode2D	Cesium.MapMode2D	<可选>	Cesium.MapMode2D.INFINITE_SCROLL	在二维模式下时，地图是可旋转的还是可以在水平方向无限滚动。
shouldAnimate	boolean	<可选>	true	是否开启时钟动画
shadows	boolean	<可选>	false	是否启用日照阴影
useDefaultRenderLoop	boolean	<可选>	true	如果此小部件应控制渲染循环，则为true，否则为false。
targetFrameRate	number	<可选>		使用默认渲染循环时的目标帧速率。
useBrowserRecommendedResolution	boolean	<可选>	true	如果为true，则以浏览器建议的分辨率渲染，并忽略 window.devicePixelRatio 。
automaticallyTrackDataSourceClocks	boolean	<可选>	true	如果为true，则此小部件将自动跟踪新添加的数据源的时钟设置，并在数据源的时钟发生更改时进行更新。如果要独立配置时钟，请将其设置为false。
contextOptions	object	<可选>	{}	WebGL创建属性 传递给 Cesium.Scene 的 options 。Cesium.Scene Properties 属性 属性名称 类型 可选 默认值 描述信息 allowTextureFilterAnisotropic boolean <可选> true 允许纹理过滤各向异性 requestWebgl1 boolean <可选> false 是否启用webgl1，cesium v1.102起默认用webgl2渲染 webgl object <可选> WebGL画布,用于 canvas.getContext("webgl", webglOptions) Properties 属性 属性名称 类型 可选 默认值 描述信息 alpha boolean <可选> false 是否包含alpha缓冲区，如果需要DIV透明时，需要改为true antialias boolean <可选> 是否执行抗锯齿 failIfMajorPerformanceCaveat boolean <可选> 如果系统性能较低，是否创建上下文 depth boolean <可选> 绘图缓冲区的深度缓冲区至少为16位 stencil boolean <可选> true 绘图缓冲区具有至少8位的模板缓冲区 powerPreference string <可选> "high-performance" 对用户代理的提示，指示GPU的哪种配置适合WebGL上下文
orderIndependentTranslucency	boolean	<可选>	true	如果为true，并且配置支持它，则使用顺序无关的半透明性。
terrainShadows	Cesium.ShadowMode	<可选>	Cesium.ShadowMode.RECEIVE_ONLY	确定地形是否投射或接收来自光源的阴影。
requestRenderMode	boolean	<可选>	false	是否显式渲染，如果为真，渲染帧只会在需要时发生，这是由场景中的变化决定的。启用可以减少你的应用程序的CPU/GPU使用量，并且在移动设备上使用更少的电池，但是需要使用 Scene#requestRender 在这种模式下显式地渲染一个新帧。在许多情况下，在API的其他部分更改场景后，这是必要的。参见 Improving Performance with Explicit Rendering.
maximumRenderTimeChange	number	<可选>	0.0	如果requestRenderMode为true，这个值定义了在请求渲染之前允许的模拟时间的最大变化。参见 Improving Performance with Explicit Rendering. 以下是Cesium.Globe对象相关参数
globe	object	<可选>		globe地球相关参数 Properties 属性 属性名称 类型 可选 默认值 描述信息 show boolean <可选> true 是否显示地球 baseColor string <可选> '#546a53' 地球背景色 ，css颜色值 depthTestAgainstTerrain boolean <可选> false 是否启用深度监测,可以开启来测试矢量对象是否在地形下面或被遮挡。 showGroundAtmosphere boolean <可选> true 是否在地球上绘制的地面大气 enableLighting boolean <可选> false 是否显示晨昏线，可以看到地球的昼夜区域 tileCacheSize number <可选> 100 地形图块缓存的大小，表示为图块数。任何其他只要不需要渲染，就会释放超出此数目的图块这个框架。较大的数字将消耗更多的内存，但显示细节更快例如，当缩小然后再放大时。 terrainExaggeration number <可选> 1.0 地形夸张倍率，用于放大地形的标量。请注意，地形夸张不会修改其他相对于椭球的图元。 realAlt number <可选> false 地形夸张倍率，在测量高度和下侧提示的高度信息中是否转换为实际真实高度值。 terrainExaggerationRelativeHeight number <可选> 0.0 地形被夸大的高度。默认为0.0（相对于椭球表面缩放）。高于此高度的地形将向上缩放，低于此高度的地形将向下缩放。请注意，地形夸大不会修改任何其他图元，因为它们是相对于椭球体定位的。 以下是Cesium.ScreenSpaceCameraController对象相关参数
cameraController	object	<可选>		相机操作相关参数 Properties 属性 属性名称 类型 可选 默认值 描述信息 minimumZoomDistance number <可选> 1.0 相机最近视距，变焦时相机位置的最小量级（以米为单位），默认为1。该值是相机与地表(含地形)的相对距离。 maximumZoomDistance number <可选> 50000000.0 相机最远视距，变焦时相机位置的最大值（以米为单位）。该值是相机与地表(含地形)的相对距离。 zoomFactor number <可选> 3.0 滚轮放大倍数，控制鼠标滚轮操作的步长 minimumCollisionTerrainHeight number <可选> 80000 最小碰撞高度，低于此高度时绕鼠标键绕圈，大于时绕视图中心点绕圈。 constrainedAxis boolean <可选> true 南北极绕轴心旋转，为false时 解除在南北极区域鼠标操作限制 enableRotate boolean <可选> true 2D和3D视图下，是否允许用户旋转相机 enableTranslate boolean <可选> true 2D和哥伦布视图下，是否允许用户平移地图 enableTilt boolean <可选> true 3D和哥伦布视图下，是否允许用户倾斜相机 enableZoom boolean <可选> true 是否允许 用户放大和缩小视图 enableCollisionDetection boolean <可选> true 是否允许 地形相机的碰撞检测 以下是Cesium.Clock时钟相关参数
clock	object	<可选>		时钟相关参数 Properties 属性 属性名称 类型 可选 默认值 描述信息 currentTime string | Cesium.JulianDate <可选> 当前的时间 multiplier number <可选> 1.0 当前的速度

参考:

• Cesium.Scene

属性:

属性名称	类型	可选	默认值	描述信息
type	TerrainType	<可选>	"xyz"	地形类型
url	string | Cesium.Resource			地形服务地址
show	boolean	<可选>	false	是否启用显示地形
requestVertexNormals	boolean	<可选>	false	是否应该从服务器请求额外的光照信息，如果可用，以每个顶点法线的形式。
requestWaterMask	boolean	<可选>	false	是否应该向服务器请求每个瓦的水掩膜(如果有的话)。
requestMetadata	boolean	<可选>	true	是否应该从服务器请求每个块元数据(如果可用)。

参考:

• TerrainType

属性:

属性名称	类型	可选	描述信息
tianditu	string | Array.<string>	<可选>	天地图
gaode	string | Array.<string>	<可选>	高德
baidu	string | Array.<string>	<可选>	百度
ion	string	<可选>	Ion服务
mapbox	string	<可选>	mapbox地图
bing	string	<可选>	微软Bing地图