XyzLayer

new mars3d.layer.XyzLayer(options)

标准xyz金字塔

参数名称 类型 描述信息
options object 可选

参数对象,包括以下:

参数名称 类型 默认值 描述信息
url Cesium.Resource | string

用于请求瓦片图块的URL模板。它具有以下关键字:

  • {z}: 切片方案中切片的级别。零级是四叉树金字塔的根。
  • {x}:切片方案中的图块X坐标,其中0是最西端的图块。
  • {y}: 切片方案中的图块Y坐标,其中0是最北的图块。
  • {s}:可用的子域之一,用于克服浏览器对每个主机的并发请求数的限制。
  • {reverseX}: 切片方案中的图块X坐标,其中0是最东的图块。
  • {reverseY}:切片方案中的图块Y坐标,其中0是最南端的图块,用于TMS服务。
  • {reverseZ}:在切片方案中切片的级别,其中级别0是四叉树金字塔的最大级别。为了使用reverseZ,必须定义maximumLevel。
  • {westDegrees}: 瓦片图块在测地角度上的西边缘。
  • {southDegrees}:瓦片图块在测地角度上的南边缘。
  • {eastDegrees}:以大地测量度表示的图块的东边缘。
  • {northDegrees}: 瓦片图块在测地角度上的北边缘。
  • {westProjected}:图块方案的墨卡托投影坐标中图块的西边缘。
  • {southProjected}: 图块方案的墨卡托投影坐标中图块的南边缘。
  • {eastProjected}: :图块方案的墨卡托投影坐标中图块的东边缘。
  • {northProjected}:图块方案的墨卡托投影坐标中图块的北边缘。
  • {width}:每个图块的宽度(以像素为单位)。
  • {height}: 每个图块的高度(以像素为单位)。
  • {scale}: z层级对应的scale值。
  • {origin}: 该坐标系对应的origin原点坐标。
urlSchemeZeroPadding object 可选

为每个图块坐标获取URL方案零填充。格式为' 000',其中每个坐标将在左侧用零填充,以匹配传递的零字符串的宽度。例如设置: urlSchemeZeroPadding:{'{x}':'0000'}将导致'x'值为12,以在生成的URL中返回{x}的字符串'0012'。传递的对象具有以下关键字:

  • {z}: 切片方案中图块级别的零填充。
  • {x}: 切片方案中图块X坐标的零填充。
  • {y}: 切片方案中图块Y坐标的零填充。
  • {reverseX}: 在平铺方案中图块reverseX坐标的零填充。
  • {reverseY}: 在切片方案中,图块反向Y坐标的零填充,用于TMS服务。
  • {reverseZ}: 在切片方案中,图块的reverseZ坐标的零填充。
subdomains string | Array.<string> 可选

URL模板中用于 {s} 占位符的子域。 如果此参数是单个字符串,则字符串中的每个字符都是一个子域。如果是一个数组,数组中的每个元素都是一个子域。

tms boolean 可选

如果此值为true,反转切片Y轴的编号(对于TMS服务需可将将此项打开)

assetId number 可选

ion资源时对应的assetId

ionToken string mars3d.Token.ion 可选

ion资源时对应的token

ionServer string | Cesium.Resource Cesium.Ion.defaultServer 可选

ion资源时对应的server

minimumLevel number 0 可选

瓦片所支持的最低层级,如果数据没有第0层,该参数必须配置,当地图小于该级别时,平台不去请求服务数据。

maximumLevel number 可选

瓦片所支持的最大层级,大于该层级时会显示上一层拉伸后的瓦片,当地图大于该级别时,平台不去请求服务数据。

minimumTerrainLevel number 可选

展示影像图层的最小地形细节级别,小于该级别时,平台不显示影像数据。

maximumTerrainLevel number 可选

展示影像图层的最大地形细节级别,大于该级别时,平台不显示影像数据。

rectangle object 可选

瓦片数据的矩形区域范围

参数名称 类型 描述信息
xmin number

最小经度值, -180 至 180

xmax number

最大经度值, -180 至 180

ymin number

最小纬度值, -90 至 90

ymax number

最大纬度值, -90 至 90

bbox Array.<number> 可选

bbox规范的瓦片数据的矩形区域范围,与rectangle二选一即可。

zIndex number 可选

控制图层的叠加层次,默认按加载的顺序进行叠加,但也可以自定义叠加顺序,数字大的在上面(只对同类型图层间有效)。

crs CRS mars3d.CRS.EPSG3857 可选

瓦片数据的坐标系信息,默认为墨卡托投影

chinaCRS ChinaCRS 可选

标识瓦片的国内坐标系(用于自动纠偏或加偏),自动将瓦片转为map对应的chinaCRS类型坐标系。

proxy string 可选

加载资源时要使用的代理服务url。

templateValues object 可选

一个对象,用于替换Url中的模板值的键/值对

queryParameters object 可选

一个对象,其中包含在检索资源时将发送的查询参数。比如:queryParameters: {'access_token': '123-435-456-000'},

headers object 可选

一个对象,将发送的其他HTTP标头。比如:headers: { 'X-My-Header': 'valueOfHeader' },

enablePickFeatures boolean true 可选

如果为true,则 UrlTemplateImageryProvider#pickFeatures 请求 pickFeaturesUrl 并尝试解释响应中包含的功能。 如果为 falseUrlTemplateImageryProvider#pickFeatures 会立即返回未定义(表示没有可拾取的内容) 功能)而无需与服务器通信。如果您知道数据,则将此属性设置为false 源不支持选择功能,或者您不希望该提供程序的功能可供选择。注意 可以通过修改 UriTemplateImageryProvider#enablePickFeatures来动态覆盖 属性。

pickFeaturesUrl Cesium.Resource | string 可选

用于选择功能的URL模板。如果未指定此属性, Cesium.UrlTemplateImageryProvider#pickFeatures 会立即返回undefined,表示没有 功能选择。 网址模板支持 url参数支持的所有关键字参数,以及以下内容:

  • {i}: 所选位置的像素列(水平坐标),其中最西端的像素为0。
  • {j}: 所选位置的像素行(垂直坐标),其中最北端的像素为0。
  • {reverseI}: 所选位置的像素列(水平坐标),其中最东端的像素为0。
  • {reverseJ}: 所选位置的像素行(垂直坐标),其中最南端的像素为0。
  • {longitudeDegrees}: 所选位置的经度(以度为单位)。
  • {latitudeDegrees}: 所选位置的纬度(以度为单位)。
  • {longitudeProjected}:在平铺方案的投影坐标中所拾取位置的经度。
  • {latitudeProjected}: 在平铺方案的投影坐标中所拾取位置的纬度。
  • {format}: 获取功能信息的格式,如 GetFeatureInfoFormat中所指定。
getFeatureInfoFormats Array.<Cesium.GetFeatureInfoFormat> 可选

在某处获取功能信息的格式 调用 UrlTemplateImageryProvider#pickFeatures 的特定位置。如果这 参数未指定,功能选择已禁用。

opacity number 1.0 可选

透明度,取值范围:0.0-1.0。

alpha number | function 1.0 可选

同opacity。

nightAlpha number | function 1.0 可选

当 enableLighting 为 true 时 ,在地球的夜晚区域的透明度,取值范围:0.0-1.0。

dayAlpha number | function 1.0 可选

当 enableLighting 为 true 时,在地球的白天区域的透明度,取值范围:0.0-1.0。

brightness number | function 1.0 可选

亮度

contrast number | function 1.0 可选

对比度。 1.0使用未修改的图像颜色,小于1.0会降低对比度,而大于1.0则会提高对比度。

hue number | function 0.0 可选

色调。 0.0 时未修改的图像颜色。

saturation number | function 1.0 可选

饱和度。 1.0使用未修改的图像颜色,小于1.0会降低饱和度,而大于1.0则会增加饱和度。

gamma number | function 1.0 可选

伽马校正值。 1.0使用未修改的图像颜色。

invertColor boolean 可选

是否反向颜色,内部计算规则: color.r = 1.0 - color.r

filterColor string | Cesium.Color 可选

滤镜颜色,内部计算规则: color.r = color.r * filterColor.r

maximumAnisotropy number maximum supported 可选

使用的最大各向异性水平 用于纹理过滤。如果未指定此参数,则支持最大各向异性 将使用WebGL堆栈。较大的值可使影像在水平方向上看起来更好 视图。

cutoutRectangle Cesium.Rectangle 可选

制图矩形,用于裁剪此ImageryLayer的一部分。

colorToAlpha Cesium.Color 可选

用作Alpha的颜色。

colorToAlphaThreshold number 0.004 可选

颜色到Alpha的阈值。

hasAlphaChannel boolean true 可选

如果此图像提供者提供的图像为真 包括一个Alpha通道;否则为假。如果此属性为false,则为Alpha通道,如果 目前,将被忽略。如果此属性为true,则任何没有Alpha通道的图像都将 它们的alpha随处可见。当此属性为false时,内存使用情况 和纹理上传时间可能会减少。

tileWidth number 256 可选

图像图块的像素宽度。

tileHeight number 256 可选

图像图块的像素高度。

customTags object 可选

允许替换网址模板中的自定义关键字。该对象必须具有字符串作为键,并且必须具有值。

clampToTileset boolean 可选

是否进行贴模型,tip:目前不支持亮度等参数,不支持EPSG:3857坐标系。

id string | number mars3d.Util.createGuid() 可选

图层id标识

pid string | number -1 可选

图层父级的id,一般图层管理中使用

name string '' 可选

图层名称

show boolean true 可选

图层是否显示

eventParent BaseClass | boolean 可选

指定的事件冒泡对象,默认为map对象,false时不冒泡

center object 可选

图层自定义定位视角 Map#setCameraView

参数名称 类型 描述信息
lng number

经度值, 180 - 180

lat number

纬度值, -90 - 90

alt number 可选

高度值

heading number 可选

方向角度值,绕垂直于地心的轴旋转角度, 0至360

pitch number 可选

俯仰角度值,绕纬度线旋转角度, -90至90

roll number 可选

翻滚角度值,绕经度线旋转角度, -90至90

flyTo boolean 可选

加载完成数据后是否自动飞行定位到数据所在的区域。

flyToOptions object 可选

加载完成数据后是否自动飞行定位到数据所在的区域的对应 BaseLayer#flyTo方法参数。

参考:

继承

成员(属性)

alpha : number

透明度,同opacity。从0.0到1.0。

继承自:
默认值: 1.0

availability : Cesium.TimeIntervalCollection

指定时间范围内显示该对象 [提示:仅部分子类实现,非所有对象都支持]

继承自:
使用示例:
// cesium原生写法,单个
tilesetLayer.availability = new Cesium.TimeInterval({
  start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
  stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
  isStartIncluded: true,
  isStopIncluded: false
})

// cesium原生写法, 多个
tilesetLayer.availability = new Cesium.TimeIntervalCollection([
  new Cesium.TimeInterval({
    start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
    stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
    isStartIncluded: true,
    isStopIncluded: false
  }),

])

// 普通传值方式,多个
tilesetLayer.availability = [
  { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false },
  { start: "2017-08-25 09:00:00", stop: "2017-08-25 09:02:30" }
]

// 普通传值方式,单个
tilesetLayer.availability = { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false }

brightness : number

亮度,取值范围:0.0-1.0。

继承自:
默认值: 1.0

contrast : number

对比度。 1.0使用未修改的图像颜色,小于1.0会降低对比度,而大于1.0则会提高对比度。

继承自:
默认值: 1.0

readonly crs : CRS|string

坐标系

继承自:

enabledEvent : boolean

设置事件的启用和禁用状态

继承自:

gamma : number

伽马校正值。 1.0使用未修改的图像颜色。

继承自:
默认值: 1.0

readonly hasOpacity : boolean

是否可以调整透明度

继承自:

readonly hasZIndex : boolean

是否可以调整图层顺序(在同类型图层间)

继承自:

hue : number

色调。 0.0 时未修改的图像颜色。

继承自:
默认值: 0.0

id : string|number

对象的id标识

继承自:

readonly imageryProvider : Cesium.ImageryProvider

瓦片图层对应的内部ImageryProvider对象

继承自:

readonly isAdded : boolean

是否已添加到地图

继承自:

readonly isDestroy : boolean

是否已经销毁了

继承自:

readonly isPrivate : boolean

是否Mars3D内部的私有对象,如标绘拖拽点等

继承自:

readonly isTile : boolean

当前是否为瓦片图层

继承自:

readonly layer : Cesium.ImageryLayer

瓦片图层对应的内部ImageryLayer对象

继承自:

name : string

名称 标识

继承自:

opacity : number

透明度,取值范围:0.0-1.0

继承自:

readonly options : object

当前类的构造参数

继承自:

pid : string|number

对象的pid标识

继承自:

readonly readyPromise : Promise.<(BaseLayer|object)>

获取图层完成解析加载完成的Promise承诺, 等价于load事件(区别在于load事件必须在load完成前绑定才能监听)。

继承自:
使用示例:
tiles3dLayer.readyPromise.then(function(layer) {
    console.log("load完成", layer)
  })

rectangle : Cesium.Rectangle

瓦片数据范围

继承自:

saturation : number

饱和度。 1.0使用未修改的图像颜色,小于1.0会降低饱和度,而大于1.0则会增加饱和度。

继承自:
默认值: 1.0

show : boolean

显示隐藏状态

继承自:

splitDirection : Cesium.SplitDirection

卷帘对比时,设置所在的屏幕,NONE时不分屏

继承自:

readonly state : State

当前对象的状态

继承自:

readonly subdomainItem : string

取当前subdomains配置的随机1个值,用于URL模板中用于 {s} 占位符的子域

继承自:

templateValues : object

图层中统一的url模版,比如可以将服务url前缀统一使用模板,方便修改或动态配置。

继承自:

readonly type : string

图层类型

继承自:

zIndex : number

图层顺序,数字大的在上面。(当hasZIndex为true时)

继承自:

方法

static mars3d.layer.XyzLayer.createImageryProvider(options)*

创建用于图层的 ImageryProvider对象

参数名称 类型 描述信息
options object

Provider参数,同图层构造参数。

返回值:

ImageryProvider类

async abstract _createImageryProvider(options)Promise.<(Cesium.UrlTemplateImageryProvider|*)>

创建瓦片图层对应的ImageryProvider对象

参数名称 类型 默认值 描述信息
options object {} 可选

参数对象,具体每类瓦片图层都不一样。

返回值:

创建完成的 ImageryProvider 对象

继承自:

abstract _mountedHook()void

对象添加到地图前创建一些对象的钩子方法, 只会调用一次

返回值:

继承自: