Scenelayer

关系

Extends

SceneLayer Extends Layer

继承: Layer

构造函数

SceneLayer是专为按需流式传输和显示大量3D数据而设计的图层类型。

new SceneLayer(properties?)

参数

properties?: SceneLayerProperties

返回：SceneLayer SceneLayer对象

属性

capabilities

描述图层支持的功能。

capabilities: SceneLayerCapabilities

类型: SceneLayerCapabilities

customParameters

附加到图层获取的所有资源URL的自定义参数列表。

customParameters: any

类型: any

definitionExpression

用于过滤要素的SQL where子句。

definitionExpression: string

类型: string

effectiveCapabilities

描述图层的有效功能，考虑当前登录用户的权限。

effectiveCapabilities: SceneLayerCapabilities

类型: SceneLayerCapabilities

fields

图层中可访问的字段数组。

fields: Field

类型: Field

fieldsIndex

便于按名称进行不区分大小写字段查找的属性。

fieldsIndex: FieldsIndex

类型: FieldsIndex

geometryType

图层中要素的几何类型。

geometryType: "point" | "mesh"

类型: "point" | "mesh"

id

分配给图层的唯一ID。

id: string

类型: string

labelsVisible

指示是否为此图层显示标签。

labelsVisible: boolean

类型: boolean

layerId

场景服务图层的图层ID或图层索引。

layerId: number

类型: number

legendEnabled

指示图层是否包含在图例中。

legendEnabled: boolean

类型: boolean

listMode

指示图层在LayerList小部件中的显示方式。

listMode: "show" | "hide" | "hide-children"

类型: "show" | "hide" | "hide-children"

loaded

指示图层的资源是否已加载。

loaded: boolean

类型: boolean

loadError

加载时发生错误时返回的Error对象。

loadError: Error

类型: Error

loadStatus

表示加载操作的状态。

loadStatus: "not-loaded" | "loading" | "failed" | "loaded"

类型: "not-loaded" | "loading" | "failed" | "loaded"

loadWarnings

加载时发生的警告列表。

loadWarnings: any[]

类型: any[]

maxScale

图层在视图中可见的最大比例尺（最大放大级别）。

maxScale: number

类型: number

minScale

图层在视图中可见的最小比例尺（最大缩小级别）。

minScale: number

类型: number

objectIdField

包含每个图形对象ID的字段名称。

objectIdField: string

类型: string

opacity

图层的不透明度。

opacity: number

类型: number

outFields

服务中要包含在每个要素中的字段名称数组。

outFields: string[]

类型: string[]

parent

图层所属的父级。

parent: Basemap | Map | Ground

类型: Basemap | Map | Ground

persistenceEnabled

当为true时，图层可以被持久化。

persistenceEnabled: boolean

类型: boolean

relationships

为图层设置的关系数组。

relationships: Relationship

类型: Relationship

screenSizePerspectiveEnabled

在3D场景中对屏幕大小的点符号应用透视缩放。

screenSizePerspectiveEnabled: boolean

类型: boolean

title

图层的标题，用于在LayerList小部件等地方标识图层。

title: string

类型: string

type

图层类型提供了一种便捷的方式来检查图层类型，无需导入特定的图层模块。

type: "scene"

类型: "scene"

url

图层或场景服务的REST端点URL。

url: string

类型: string

useViewTime

确定图层是否基于视图的时间范围更新其时态数据。

useViewTime: boolean

类型: boolean

version

此服务使用的场景服务规范版本。

version: SceneServiceVersion

类型: SceneServiceVersion

visible

指示图层在视图中是否可见。

visible: boolean

类型: boolean

访问器

elevationInfo

指定要素在垂直轴（z轴）上的放置方式。

get elevationInfo(): SceneLayerElevationInfo

返回: SceneLayerElevationInfo 指定要素在垂直轴（z轴）上的放置方式。

set elevationInfo(value: SceneLayerElevationInfoProperties): void

参数

value: SceneLayerElevationInfoProperties

返回: void

excludeObjectIds

视图中不显示的对象ID列表。

get excludeObjectIds(): Collection

返回: Collection 视图中不显示的对象ID列表。

set excludeObjectIds(value: CollectionProperties<number>): void

参数

value: CollectionProperties<number>

返回: void

featureReduction

配置视图中重叠要素的去重方法。

get featureReduction(): FeatureReductionSelection

返回: FeatureReductionSelection 配置视图中重叠要素的去重方法。

set featureReduction(value: FeatureReductionSelectionProperties & object): void

参数

value: FeatureReductionSelectionProperties & object

返回: void

filter

用于遮罩图层不同部分的多边形集合。

get filter(): SceneFilter

返回: SceneFilter 用于遮罩图层不同部分的多边形集合。

set filter(value: SceneFilterProperties): void

参数

value: SceneFilterProperties

返回: void

fullExtent

图层的完整范围。

get fullExtent(): Extent

返回: Extent 图层的完整范围。

set fullExtent(value: ExtentProperties): void

参数

value: ExtentProperties

返回: void

labelingInfo

此图层的标签定义，指定为标签类数组。

get labelingInfo(): LabelClass[]

返回: LabelClass 此图层的标签定义，指定为标签类数组。

set labelingInfo(value: LabelClassProperties[]): void

参数

value: LabelClassProperties

返回: void

renderer

分配给图层的渲染器。

get renderer(): RendererUnion

返回: RendererUnion 分配给图层的渲染器。

set renderer(value: HeatmapRendererProperties & object | SimpleRendererProperties & object | UniqueValueRendererProperties & object): void

参数

value: HeatmapRendererProperties & object | SimpleRendererProperties & object | UniqueValueRendererProperties & object

返回: void

spatialReference

图层的空间参考。

get spatialReference(): SpatialReference

返回: SpatialReference 图层的空间参考。

set spatialReference(value: SpatialReferenceProperties): void

参数

value: SpatialReferenceProperties

返回: void

方法

applyEdits

对关联要素服务中的要素应用编辑操作。

applyEdits(edits, options?): SceneLayerEditsResult

参数

edits: SceneLayerApplyEditsEdits 包含要更新的要素的对象。
options?: SceneLayerApplyEditsOptions 编辑要素时指定的其他编辑选项。

返回：Promise<SceneLayerEditsResult>

cancelLoad

如果加载操作正在进行中，则取消该操作。

cancelLoad(): void

返回：void

clone

创建此对象的深度克隆。

clone(): this

返回：this

convertMesh

将文件或文件列表转换为网格几何。

convertMesh(files, options?): Mesh

参数

files: File 用于创建网格的文件。
options?: ConvertMeshOptions 配置转换的选项。

返回：Promise<Mesh>

createLayerView

当图层添加到图层集合时，由视图（如MapView和SceneView）调用，必须为其创建图层视图。

createLayerView(view, options?): LayerView

参数

view: any 父视图。
options?: LayerCreateLayerViewOptions 指定附加选项的对象。

返回：Promise<LayerView>

createQuery

创建查询对象，可用于获取满足图层当前定义表达式的要素。

createQuery(): Query

返回：Query

destroy

销毁图层和任何关联的资源（包括其门户项目，如果它是图层的属性）。

destroy(): void

返回：void

emit

在实例上发出事件。

emit(type, event?): boolean

参数

type: string 事件名称。
event?: any 事件负载。

返回：boolean

fetchAttributionData

当图层的自定义归属数据可用时获取它。

fetchAttributionData(): Promise

返回：Promise

getField

返回字段名称对应的字段实例（不区分大小写）。

getField(fieldName): Field

参数

fieldName: string 字段名称。

返回：Field

getFieldDomain

返回与给定字段名称关联的域。

getFieldDomain(fieldName, options?): Domain

参数

fieldName: string 字段名称。
options?: SceneLayerGetFieldDomainOptions 指定其他选项的对象。

返回：Domain

getFieldUsageInfo

获取字段使用信息。

getFieldUsageInfo(fieldName): any

参数

fieldName: string 要获取使用信息的字段名称。

返回：any

hasEventListener

指示实例上是否有与提供的事件名称匹配的事件监听器。

hasEventListener(type): boolean

参数

type: string 事件名称。

返回：boolean

isFulfilled

可用于验证类实例的创建是否已完成（已解决或已拒绝）。

isFulfilled(): boolean

返回：boolean

isRejected

可用于验证类实例的创建是否已被拒绝。

isRejected(): boolean

返回：boolean

isResolved

可用于验证类实例的创建是否已解决。

isResolved(): boolean

返回：boolean

load

加载此类引用的资源。

load(options?): Promise

参数

options?: LoadableLoadOptions 附加选项。

返回：Promise

on

on(name, eventHandler): IHandle

参数

name: "edits" SceneLayerEditsEventHandler ###### eventHandler

返回：IHandle

queryAttachments

查询与要素关联的附件信息。

queryAttachments(attachmentQuery, options?): Promise

参数

attachmentQuery: AttachmentQueryProperties 指定查询的附件参数。
options?: SceneLayerQueryAttachmentsOptions 具有以下属性的对象。

返回：Promise

queryCachedStatistics

从服务查询给定字段的缓存统计信息。

queryCachedStatistics(fieldName, options?): any

参数

fieldName: string 要查询统计信息的字段名称。
options?: SceneLayerQueryCachedStatisticsOptions 具有以下属性的对象。

返回：any

queryExtent

对关联的要素服务执行查询并返回满足查询条件的要素的2D范围。

queryExtent(query?, options?): Promise

参数

query?: QueryProperties 指定查询参数。
options?: SceneLayerQueryExtentOptions 具有以下属性的对象。

返回：Promise

queryFeatureCount

对关联的要素服务执行查询并返回满足查询条件的要素数量。

queryFeatureCount(query?, options?): Promise

参数

query?: QueryProperties 指定查询参数。
options?: SceneLayerQueryFeatureCountOptions 具有以下属性的对象。

返回：Promise

queryFeatures

对关联的要素服务执行查询并返回要素集。

queryFeatures(query?, options?): FeatureSet

参数

query?: QueryProperties 指定查询参数。
options?: SceneLayerQueryFeaturesOptions 具有以下属性的对象。

返回：Promise<FeatureSet>

queryObjectIds

对关联的要素服务执行查询并返回满足输入查询条件的要素的ObjectID数组。

queryObjectIds(query?, options?): Promise

参数

query?: QueryProperties 指定查询参数。
options?: SceneLayerQueryObjectIdsOptions 具有以下属性的对象。

返回：Promise

queryRelatedFeatures

对与场景图层关联的要素服务执行关系查询，并返回按源图层或表对象ID分组的相关要素。

queryRelatedFeatures(relationshipQuery, options?): Promise

参数

relationshipQuery: RelationshipQueryProperties 指定从图层或表查询相关要素或记录的关系参数。
options?: SceneLayerQueryRelatedFeaturesOptions 具有以下属性的对象。

返回：Promise

queryRelatedFeaturesCount

对与场景图层关联的要素服务执行关系查询，解析后返回包含键值对的对象。

queryRelatedFeaturesCount(relationshipQuery, options?): Promise

参数

relationshipQuery: RelationshipQueryProperties 指定从图层或表查询相关要素或记录的关系参数。
options?: SceneLayerQueryRelatedFeaturesCountOptions 具有以下属性的对象。

返回：Promise

when

在创建类实例后可以使用when()方法。

when(callback?, errback?): Promise

参数

callback?: Function Promise解决时调用的函数。
errback?: Function Promise失败时执行的函数。

返回：Promise

Relationship

构造函数

Subtype

构造函数

SceneLayer

name: "edits" SceneLayerEditsEventHandler ###### eventHandler

name: `"edits"` `SceneLayerEditsEventHandler` ###### eventHandler