查阅Cesium API

分析模块。

Author:
  • 金磊、张丹钊、张恒、薛鹏

方法

添加视域。

add3DViewshed(option)
Analysis/Analysis.js 810

参数描述:
名称 类型 描述
option Object 可选 参数。
名称 类型 默认值 描述
lon Number 可选 经度。
lat Number 可选 纬度。
height Number 可选 高度。
distance Number 1000 可选 可视距离。
heading Number 0 可选 水平视角。
pitch Number 0 可选 垂直视角。
color Object 可选 颜色，rgb对象(0-1)，可选。
名称 类型 默认值 描述
Back Object { r: 1.0, g: 0.0, b: 0.0 } 可选 不可见颜色。
Fore Object { r: 0.0, g: 1.0, b: 0.0 } 可选 可见颜色。
default Object { r: 0.0, g: 0.0, b: 0.0 } 可选 默认阴影颜色。
向三维场景中添加视频。

add3DViewshedPoss(options) → ViewshedPoss
Analysis/Analysis.js 790

参数描述:
名称 类型 描述
options Object 可选 参数。
名称 类型 默认值 描述
cameraPosition Cesium.Cartesian3 可选 相机位置
position Cesium.Cartesian3 可选 投射位置
alpha Number 0.7 可选 透明度
url String 可选 视频地址
type String 'mp4' 可选 视频类型
video DOM 可选 视频容器，(可选)
horizonAngle Number 60 可选 相机水平视角
verticalAngle Number 30 可选 相机垂直视角
offset Number 0.1 可选 视频四周羽化比例
angleZ Number 0 可选 视频在投影面上得旋转角度
near Number 1 可选 最近投射面距离
far Number 30 可选 最远投射面距离
useLine Boolean true 可选 是否试用辅助线
返回:
海拔高度

altitude(option, callback)
Analysis/Analysis.js 103

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 描述
point Cesium.Color 可选 点颜色
callback function 回调函数
体积方量

analysisVolume(option, callback)
Analysis/Analysis.js 163

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 默认值 描述
polygon Cesium.Color 可选 面颜色
onlyTerrain Boolean true 可选 是否只测量精确地形
tin Boolean true 可选 是否显示三角网
selectDatum Boolean true 可选 是否开启基准面选择
spacing Number 'auto' 可选 间距，默认间距为多边形范围的1/20
callback function 回调函数
关闭卷帘对比

clearCurtainContrast()
Analysis/Analysis.js 687

清除测量

clearMeasure(id)
Analysis/Analysis.js 71

参数描述:
名称 类型 描述
id String 可选 id，未指定id则清除所有
清除天际线分析

clearSkylineAnalysis()
Analysis/Analysis.js 294

Analysis.close3DViewshed() 删除视域分析

close3DViewshed()
Analysis/Analysis.js 829

Version:
  • 3.1.0 删除视域分析 分析 Success-Response: { item:{} } {json} 异常: { exception:{} }
室内模式关闭

closeIndoormode()
Analysis/Analysis.js 632

调用方法:
sgworld.Analysis.closeIndoormode()
绘制视域。

create3DViewshed(options) → Viewshed
Analysis/Analysis.js 738

调用方法:
sgworld.Analysis.create3DViewshed({
        height: 1.8,
    });
参数描述:
名称 类型 描述
options Object 可选 参数。
名称 类型 默认值 描述
name String 可选 名称。
height Number 1.6 可选 视角相对高度。
color Object 可选 颜色，rgb对象(0-1)，可选。
名称 类型 默认值 描述
Back Object { r: 1.0, g: 0.0, b: 0.0 } 可选 不可见颜色。
Fore Object { r: 0.0, g: 1.0, b: 0.0 } 可选 可见颜色。
default Object { r: 0.0, g: 0.0, b: 0.0 } 可选 默认阴影颜色。
返回:
绘制视域。

create3DViewshedPoss(options) → ViewshedPoss
Analysis/Analysis.js 765

调用方法:
sgworld.Analysis.create3DViewshedPoss({
        height: 1.8,
    });
参数描述:
名称 类型 描述
options Object 可选 参数。
名称 类型 默认值 描述
visible String #00ff00 可选 可视颜色。
unvisible String #ff0000 可选 不可视颜色。
height Number 1.7 可选 相对高度
alpha Number 0.5 可选 透明度。
horizonAngle Number 60 可选 相机水平视角
verticalAngle Number 60 可选 相机垂直视角
返回:
添加扩散圆扫描线

createCircleScan(position, maxRadius, scanColor, duration, clampToGround) → Scan
Analysis/Analysis.js 345

调用方法:
sgworld.Analysis.createCircleScan({ lon: 110, lat: 30 }, 600, '#ff0000', 3000, true);
参数描述:
名称 类型 默认值 描述
position Object 可选 扫描中心。
maxRadius Object 1500 可选 最大半径 米。
scanColor Object #ff0000 可选 扫描颜色。
duration Object 4000 可选 持续时间 毫秒。
clampToGround Boolean true 可选 是否贴地。
返回:
卷帘对比(影像)

createCurtainContrast(leftIndex, rightIndex) → curtaincontrast
Analysis/Analysis.js 665

调用方法:
sgworld.Analysis.createCurtainContrast(0, 1);
参数描述:
名称 类型 描述
leftIndex number 左侧图层索引。
rightIndex number 右侧图层索引。
返回:
创建描边特效

createEdgeStage(option)
Analysis/Analysis.js 287

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 默认值 描述
width Number 2 可选 描边宽度
thresholdAngle Number 10 可选 描边阈值（法线角度大于该值才有描边）
visibleColor String #00a8e0 可选 可视颜色
hiddenColor String #4d4d4d 可选 不可视颜色
showGlow Boolean true 可选 是否发光
edgeGlow Number 1 可选 发光强度
创建等高线。

createElevationContour()
Analysis/Analysis.js 709

室内模式

deprecated createindoormode()
Analysis/Analysis.js 605

已弃用: true

室内模式开启

createIndoormode()
Analysis/Analysis.js 623

调用方法:
sgworld.Analysis.createIndoormode()
创建一个通视分析

createlineOfSight(name, vsPositionCarto, FOVX, FOVY, hpra, 名称)
Analysis/Analysis.js 841

参数描述:
名称 类型 描述
name String 名称
vsPositionCarto object 位置
FOVX float FOVX
FOVY float FOVY
hpra float hpra
名称 object
这个方法用于添加扩散圆扫描线（三环）

createMultiCircleScan(position, maxRadius, scanColor, duration, clampToGround)
Analysis/Analysis.js 357

参数描述:
名称 类型 默认值 描述
position Object 可选 扫描中心。
maxRadius Object 1500 可选 最大半径 米。
scanColor Object #ff0000 可选 扫描颜色。
duration Object 4000 可选 持续时间 毫秒。
clampToGround Boolean true 可选 是否贴地。
这个方法用于添加粒子特效

createParticleEffect(type, PositionOrEntity, option, callback)
Analysis/Analysis.js 555

参数描述:
名称 类型 描述
type string 可选 类型（烟花/烟雾/喷泉/火焰）。(fireworks/smog/fountain/flame)
PositionOrEntity Object 可选 位置或entity。
option Object 可选 参数。
callback function 可选 回调。
这个方法用于添加雷达扫描线

createRadarScan(position, maxRadius, scanColor, duration, clampToGround) → Scan
Analysis/Analysis.js 390

调用方法:
sgworld.Analysis.createRadarScan({ lon: 110, lat: 30 }, 600, '#ff0000', 3000, true);
参数描述:
名称 类型 默认值 描述
position Object 可选 扫描中心。
maxRadius Object 1500 可选 最大半径 米。
scanColor Object #ff0000 可选 扫描颜色。
duration Object 4000 可选 持续时间 毫秒。
clampToGround Boolean true 可选 是否贴地。
返回:
这个方法三维球面截图

createScreenshot()
Analysis/Analysis.js 302

添加扩散扇形扫描线（五环）

createSectorScan(position, maxRadius, scanColor, angle, yaw, duration, clampToGround) → Scan
Analysis/Analysis.js 375

调用方法:
sgworld.Analysis.createSectorScan({ lon: 118.82103909242193, lat: 31.870929674929533, height: 100 }, 400, '#ff0000', 90, 90)
参数描述:
名称 类型 默认值 描述
position Object 可选 扫描中心。
maxRadius Object 1500 可选 最大半径 米。
scanColor Object #ff0000 可选 扫描颜色。
angle float 90 可选 角度。
yaw float 0 可选 方向。
duration Object 4000 可选 持续时间 毫秒。
clampToGround Boolean true 可选 是否贴地。
返回:
创建通视分析

createSightLine(option) → SightLine
Analysis/Analysis.js 857

调用方法:
sgworld.Analysis.createSightLine();
参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 默认值 描述
type Object 'default' 可选 类型【default|circle】
height Number 1.8 可选 观察位置相对高度
steps Number 64 可选 圆形通视分析的精细度
返回:
创建天际线

createSkylineAnalysis(optionOrColor) → SkylineAnalysis
Analysis/Analysis.js 273

调用方法:
sgworld.Analysis.createSkylineAnalysis("#ff0")
或
sgworld.Analysis.createSkylineAnalysis({
   color: "#ff0"
})
参数描述:
名称 类型 描述
optionOrColor Object | String 可选 天际线颜色或参数
名称 类型 默认值 描述
color String #ff0000 可选 天际线颜色
scale Number 2 可选 粗细比例(1~10)
返回:
获取高程绘制剖面分析

deprecated createTerrainProfile(pIGeometry) → Promise.<Array>
Analysis/Analysis.js 718

参数描述:
名称 类型 描述
pIGeometry Array 可选 一个经纬度数组例如：[{x: 1241183.5017659152, y: -4980441.651928518, z: 3769366.996495204},{x: 1241183.5017659152, y: -4980441.651928518, z: 3769366.996495204}]。
返回:
返回一个高程数组例如：[1,1,2,2]。

已弃用: true

添加雨雪雾

createWeather(type, isOpen, value)
Analysis/Analysis.js 545

调用方法:
sgworld.Analysis.createWeather("snow", true)
参数描述:
名称 类型 描述
type String 可选 类型（雨雪雾晴）。(rain/snow/fog/sun)
isOpen Boolean 可选 是否开启。
value Object 可选 雨雪雾设置的参数。
名称 类型 默认值 描述
test1 Number 可选 雨0—10，雪0—10
test2 Number 可选 雨0—1，雪0—10
test3 Number 可选 雨-1—1，雪0—1
test4 Number 可选 雨0—1，雪0—1
distance Number 200 可选 雾可视距离
color String '#ffffff' 可选 雾颜色
卷帘对比(影像和模型)

curtainContrast(option) → curtaincontrast
Analysis/Analysis.js 680

调用方法:
sgworld.Analysis.curtainContrast({
        left: [0],
        right: [1],
    });
参数描述:
名称 类型 描述
option Object 参数
名称 类型 描述
left Array 左侧显示内容。
right Array 右侧显示内容。
返回:
开始拆迁

demolition(url, option)
Analysis/Analysis.js 589

参数描述:
名称 类型 描述
url String 拆迁模型
option Object 参数
名称 类型 默认值 描述
startPosition Array 可选 拆迁起点位置
endPosition Array 可选 拆迁终点位置
time Number 工期，拆除时间
attr String 工期对应的属性字段
attrType String 工期对应的属性字段的类型【string | number】
useColor Boolean false 可选 是否使用颜色区分进度
colors Array ['rgb(255,0,0)', 'rgb(255,152,0)', 'rgb(0,255,0)'] 可选 相应进度对应的颜色，分别为[未完成、正在进行、已完成]
开启深度检测

depthTestAgainstTerrain(show)
Analysis/Analysis.js 183

调用方法:
sgworld.Analysis.depthTestAgainstTerrain(true)
参数描述:
名称 类型 描述
show Boolean 是否开启。
点缓冲区

DrawPointBuffer(radiusOrOption, callback) → BufferAnalysis
Analysis/Analysis.js 199

调用方法:
sgworld.Analysis.DrawPointBuffer(100);
参数描述:
名称 类型 描述
radiusOrOption Number | Object 半径或参数
名称 类型 描述
radius Number 半径
material Cesium.Color 可选 缓冲区颜色
callback function 可选 回调函数
返回:
面缓冲区

DrawPolygonBuffer(radiusOrOption, callback) → BufferAnalysis
Analysis/Analysis.js 229

调用方法:
sgworld.Analysis.DrawPolygonBuffer(100);
参数描述:
名称 类型 描述
radiusOrOption Number | Object 半径或参数
名称 类型 描述
radius Number 半径
material Cesium.Color 可选 缓冲区颜色
callback function 可选 回调函数
返回:
线缓冲区

DrawPolylineBuffer(radiusOrOption, callback) → BufferAnalysis
Analysis/Analysis.js 214

调用方法:
sgworld.Analysis.DrawPolylineBuffer(100);
参数描述:
名称 类型 描述
radiusOrOption Number | Object 半径或参数
名称 类型 描述
radius Number 半径
material Cesium.Color 可选 缓冲区颜色
callback function 可选 回调函数
返回:
退出街景

ExitStreetView()
Analysis/Analysis.js 526

淹没分析

floodAnalysis(parameter, method) → Polygon
Analysis/Analysis.js 882

调用方法:
sgworld.Analysis.floodAnalysis({
     pointSelect: true
})
参数描述:
名称 类型 默认值 描述
parameter Object 可选 参数
名称 类型 默认值 描述
rectangle Boolean false 可选 是否绘制矩形区域
pointSelect Boolean false 可选 是否点选高度
spood Number 10 可选 淹没深度
waterHeight Number 0 可选 水面起始高度，pointSelect为false有效
targetHeight Number 1000 可选 淹没最大高度，pointSelect为false有效
url String 可选 水面贴图
watherColor Cesium.Color 可选 水面颜色
option.frequency Number 1000 可选 水波数。
option.watherSpeed Number 0.01 可选 流速(m/s)。
option.amplitude Number 10 可选 水波幅度。
method function 回调函数
返回:
水平距离测量

horizontalDistance(option, callback)
Analysis/Analysis.js 82

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 描述
point Cesium.Color 可选 点颜色
polyline Cesium.Color 可选 线颜色
callback function 回调函数
角度测量

measureAngle(option, callback)
Analysis/Analysis.js 149

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 描述
point Cesium.Color 可选 点颜色
polyline Cesium.Color 可选 线颜色
polygon Cesium.Color 可选 面颜色
callback function 回调函数
测量水平面积

deprecated measureTerrainArea()
Analysis/Analysis.js 695

已弃用: true

测量高度

deprecated measureTerrainHeight()
Analysis/Analysis.js 598

已弃用: true

测量空间距离

deprecated measureTerrainkPerimeter()
Analysis/Analysis.js 703

已弃用: true

测量水平距离

deprecated measureTerrainPerimeter()
Analysis/Analysis.js 173

已弃用: true

平面面积

planeArea(option, callback)
Analysis/Analysis.js 137

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 描述
polygon Cesium.Color 可选 面颜色
callback function 回调函数
这个方法用于移除粒子特效

removeParticleEffect()
Analysis/Analysis.js 568

这个方法创建截图对比

ScreenshotCompared()
Analysis/Analysis.js 309

定点绕飞

setPointFly(option) → PointFly
Analysis/Analysis.js 331

调用方法:
sgworld.Analysis.setPointFly()
参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 默认值 描述
time Number 30 可选 飞行一周所需时间
pitch Number 可选 俯仰角
distance Number 可选 飞行距离
position Cartesian3 可选 中心坐标
limitAngel Number 360 可选 限制旋转角度，默认360度，仅limitTime为true时有效
limitTime Boolean false 可选 是否限制绕飞时间
hideImage Boolean false 可选 隐藏中心图标
scale Number 1 可选 中心图标比例
image String 可选 中心图标路径
end function 可选 结束回调
返回:
设置场景时间

setTime(time)
Analysis/Analysis.js 645

渲染效果:
调用方法:
sgworld.Analysis.setTime(18.5)
参数描述:
名称 类型 默认值 描述
time Number 9 可选 时间，24小时
Analysis.ShadowsAnalysis() 创建阴影分析

ShadowsAnalysis()
Analysis/Analysis.js 256

Version:
  • 3.1.0 创建阴影分析 分析 {json} 异常: exception
空间距离测量

spaceDistance(option, callback)
Analysis/Analysis.js 93

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 描述
point Cesium.Color 可选 点颜色
polyline Cesium.Color 可选 线颜色
callback function 回调函数
Analysis.StreetViewOpen(position,option,callback) 开启街景

StreetViewOpen()
Analysis/Analysis.js 520

调用方法:
参数说明
   position：{lon:经度，lat:纬度}
   option：{
 getInitImageByPosition: 根据经纬度获取街景信息接口
 getInitImageInfoById: 根据id获取街景信息接口
 getInitImageById: 根据id获取一级街景图接口
 getSecondImageById: 根据id获取二级街景图接口
 getThirdImageById: 根据id获取三级街景图接口
 getInitImageByPositionCallBack: 根据经纬度获取街景信息回调 function(StreetViewData,data){
     StreetViewData.getImageTileID = ImageID;
     StreetViewData.lon = Lon;
     StreetViewData.lat = Lat;
     StreetViewData.height = height;
     StreetViewData.HeadingPitchRoll = HeadingPitchRoll;
     StreetViewData.linkImagesData=[{ImageID: LinkImageID, NavigationAngle: LinkAngle, Position: LinkPosition}];
}
   callback：function () {}
Success-Response:
   {}
{json} 异常:
   exception
Version:
  • 3.1.0 开启街景 分析 param {object} position 选项参数 param {object} option 街景参数 param {object} callback 是否开启室内模式，默认否
日照分析（点分析）

SunshineAnalysisPoint(名称)
Analysis/Analysis.js 891

参数描述:
名称 类型 描述
名称 object
日照分析(面)

SunshineAnalysisPolygon(option, callBack)
Analysis/Analysis.js 907

参数描述:
名称 类型 描述
option Object 可选 参数{ start: '2019-09-17 13:00', //开始时间 end: '2019-09-17 15:00', //结束时间 interval: 60, //时间间隔(分钟) spacing: 10, //空间间距(米) startHeight: 0, //起始高度，默认第一个点的海拔(米) endHeight: 40, //终止高度(米) }
callBack function 可选 回调
表面面积

surfaceArea(option, callback)
Analysis/Analysis.js 127

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 默认值 描述
polygon Cesium.Color 可选 面颜色
tin Boolean 可选 是否显示三角网
distance Number 可选 采样间距（米），默认使用多边形边界框宽度的1/20
onlyTerrain Boolean false 可选 是否只测量高精度地形
callback function 回调函数
地形夸张

terrainExaggeration(numb)
Analysis/Analysis.js 654

参数描述:
名称 类型 描述
numb Number 可选 夸张比例
地形开挖

TerrainExcavation(height, option, callback)
Analysis/Analysis.js 243

调用方法:
sgworld.Analysis.TerrainExcavation(100)
参数描述:
名称 类型 默认值 描述
height Number 100 可选 开挖高度(米)
option Object 可选 开挖参数
callback function 回调函数
地下模式

UndergroundMode(show, alpha)
Analysis/Analysis.js 418

调用方法:
sgworld.Analysis.UndergroundMode(true, 0.5)
参数描述:
名称 类型 默认值 描述
show Boolean 是否开启
alpha Number 0.5 可选 地表透明度
地下模式关闭

deprecated UndergroundModelClose()
Analysis/Analysis.js 407

已弃用: true

地下模式开启

deprecated UndergroundModelOpen()
Analysis/Analysis.js 399

已弃用: true

垂直高度

verticalHeight(option, callback)
Analysis/Analysis.js 114

参数描述:
名称 类型 描述
option Object 可选 参数
名称 类型 描述
point Cesium.Color 可选 点颜色
polyline Cesium.Color 可选 线颜色
callback function 回调函数