KnowledgeGraphSublayer

//to access individual sublayers in a KnowledgeGraphLayer
knowledgeGraphLayer.layers.items.forEach((sublayer)=>{
 sublayer.popupTemplate = new PopupTemplate({
  title: "{common_name}",
  content: [{
    type: "text",
    text: "Scientific Name: {name}"
  }]
 });
})

属性概述

属性详细信息

blendMode String

混合模式用于将图层混合在一起，以便在图层中创建有趣的效果，甚至生成一个看起来像新图层的图层。与使用透明度 (透明度可能会导致顶部图层褪色) 的方法不同，混合模式通过将图层与其下方的图层进行混合来创建各种生动有趣的结果。

混合图层时，top layer 是应用了混合模式的图层。顶部图层下的所有层都是 background layers。默认的混合模式是 normal，其中顶部图层简单地显示在背景图层之上。虽然这种默认行为是完全可以接受的，但在图层上使用混合模式可为生成创意地图开辟了无限可能。

GroupLayer 中的图层混合在一起，与地图的其余部分隔离开。

已知限制

• 3D SceneViews 中的 blendMode 在 BaseTileLayer、ImageryTileLayer 、TileLayer、VectorTileLayer、WCSLayer、WebTileLayer、WMTSLayer 和 GroupLayer 中受支持。
• Legend 不支持 blendMode。
• 请参阅打印以了解已知的打印限制。

以下因素会影响混合结果：

• 所有图层的顺序
• 图层不透明度
• 图层中要素的不透明度
• 图层的可见性
• 默认情况下，地图的最底图层绘制在透明背景上。您可以更改 MapView 的背景色。

混合模式	描述
normal	顶部图层显示在背景图层上方。在重叠部分，顶部图层数据会遮挡背景图层数据。
average	使用顶部图层和背景图层的数学平均值。average 混合模式的结果通常类似于将图层不透明度设置为 50% 的效果。

亮色混合模式：

以下混合模式会创建比所有图层更亮的结果。在亮色混合模式下，顶部图层中的纯黑色变得透明，从而使背景图层能够透出来。顶部图层的白色将保持不变。任何比纯黑色更亮的颜色都会在不同程度上使顶部图层的颜色变亮，直至纯白色。

亮色混合模式在淡化顶部图层的深色或从结果中移除黑色时非常有用。plus、lighten 和 screen 模式可用于使深色背景上褪色或深色的图层变亮。

混合模式	描述
lighten	比较顶部图层和背景图层并保留浅色。如果顶部图层中的颜色比背景图层中的重叠颜色更暗，则顶部图层中的颜色将变为透明，从而使背景图层完全显示出来。可认为是 darken 混合模式的反面。
lighter	顶部图层和背景图层的颜色乘以它们的 alpha 值 (图层不透明度和图层数据的不透明度)。再将生成的颜色相加。所有重叠的中间颜色在顶部图层变亮。图层和图层数据的不透明度将影响混合结果。
plus	顶部图层和背景图层中的颜色将相加。所有重叠的中间颜色在顶部图层变亮。此模式也称为 add 或 linear-dodge。
screen	将顶部图层和背景图层中的反转颜色相乘，然后再次反转颜色。生成的颜色将比原始颜色更亮，对比度更小。屏幕可以产生多种不同程度的亮度，具体取决于顶部图层的亮度值。可以认为是 multiply 模式的反面。
color-dodge	将背景图层中的颜色除以倒置的顶部图层。这将根据顶部图层的值使背景图层变亮。顶部图层越亮，其颜色对背景图层的影响就越大。降低顶部图层和背景图层之间的对比度，从而产生饱和的中间色调和高光。

暗色混合模式：

以下混合模式会创建比所有图层更暗的结果。在暗色混合模式下，顶部图层中的纯白色将变得透明，从而使背景图层能够显示出来。顶部图层的黑色将保持不变。任何比纯白色更深的颜色都会在不同程度上使顶部图层的颜色变暗，直至纯黑色。

multiply 混合模式通常用于突出阴影、显示对比度或突出地图的某个方面。例如，当您希望通过地形图层显示高程时，可以在显示在山体阴影上的地形图上使用 multiply 混合模式。

multiply 和 darken 模式可用于将底图的深色标注显示在顶部图层。

color-burn 模式适用于彩色顶部图层和背景图层，因为它增加了中间色调的饱和度。它通过使顶部图层和底部图层重叠区域中的像素更接近顶部图层的颜色来增加对比度。当您想要一个对比度大于 multiply 或 darken 的效果时，请使用此混合模式。

以下屏幕截图显示了如何使用 multiply 混合模式来创建一个显示边界和高程的世界物理地图。

混合模式	描述
darken	强调重叠图层中的最暗部分。如果顶部图层中的颜色比背景图层中的重叠颜色更亮，则顶部图层中的颜色将变为透明，从而使背景图层完全显示出来。
multiply	通过将顶部图层和背景图层的颜色相乘来强调重叠图层的最暗部分。顶部图层和背景图层的中间颜色可以更均匀地混合在一起。
color-burn	强化所有图层中的暗色区域。通过将重叠区域中的颜色朝向顶部颜色着色，该模式可增加顶部图层和背景图层之间的对比度。为此，它会反转背景图层的颜色，将结果除以顶部图层的颜色，然后再反转结果。

对比度混合模式：

以下混合模式通过调亮或调暗顶部图层中较亮或较暗的区域来创建对比，通过使用变亮或变暗混合模式来创建混合。对比度混合模式将使比 50% 灰色更亮的颜色变亮 ([128,128,128])，并将比 50% 灰色更深的颜色变暗。50% 的灰色在顶部图层是透明的。根据混合在一起的顶部图层和背景图层的颜色，每种模式都可创建各种结果。overlay 混合模式根据背景图层中颜色的亮度进行计算，而所有其他对比度混合模式根据顶部图层的亮度进行计算。其中一些模式旨在模拟光线穿过顶部图层，有效地投射到其下方图层上的效果。

对比度混合模式可用于增加对比度和饱和度，以拥有更鲜艳的色彩，并为您的图层带来冲击力。例如，您可以复制一个图层并在顶部图层上设置 overlay 混合模式，以增加图层的对比度和色调。您还可以在深色影像图层上添加具有白色填充符号的多边形图层，并应用 soft-light 混合模式来增加影像图层的亮度。

以下屏幕截图显示了 overlay 混合模式在 GraphicsLayer 上的效果。左图显示了缓冲区图形图层具有 normal 混合模式的情景。如您所见，灰色的缓冲区多边形遮挡了与人口普查区域相交的部分。右图显示了将 overlay 混合模式应用于缓冲区图形图层的情景。overlay 混合模式可根据背景图层的颜色使灰色缓冲区多边形变暗或变亮，而人口普查区域图层以亮色突显出来。

常规混合模式	叠加混合模式

混合模式	描述
overlay	结合使用 multiply 和 screen 模式，以使顶部图层中的颜色变暗和变亮，而背景图层始终发亮。结果是背景图层中较深的颜色值会强化顶部图层，而背景图层中较浅的颜色会清除顶部图层中的重叠区域。
soft-light	将半强度 screen 模式应用于较亮的区域，并将半强度 multiply 模式应用于顶部图层的暗色区域。您可以将 soft-light 视为 overlay 模式的更柔和版本。
hard-light	根据顶部图层的颜色，对颜色进行相乘或屏蔽。效果类似于在顶部图层上照射刺眼的聚光灯。
vivid-light	根据顶部图层中的颜色，通过增加或减少对比度来使用 color-burn 或 color-dodge 的组合。

分量混合模式：

以下混合模式使用原色成分，即色调、饱和度和亮度来混合上下图层。您可以在任何图层上添加具有简单渲染器的要素图层，并在此图层上设置 hue、saturation、color 或 luminosity 混合模式。使用这种技术，您可以创建一个全新的地图。

混合模式	描述
hue	使用顶部图层的色调和背景图层的亮度和饱和度创建效果。
saturation	使用顶部图层的饱和度和背景图层的色调和亮度创建效果。背景图层中没有饱和度的 50% 灰色不会产生任何变化。
luminosity	使用顶部图层的亮度和背景图层的色调和饱和度创建效果。可认为是 color 混合模式的反面。
color	使用顶部图层的色调和饱和度以及背景图层的亮度创建效果。可认为是 luminosity 混合模式的反面。

复合混合模式：

以下混合模式可用于掩膜顶部图层、背景图层或两者的内容。

• Destination 模式用于使用背景图层的数据掩膜顶部图层的数据。
• Source 模式用于使用顶部图层的数据掩膜背景图层的数据。

destination-in 混合模式可用于通过显示底层地图或提供现象的鸟瞰图来显示聚焦区域，例如地震、动物迁徙或点源污染。

混合模式	描述
destination-over	目标/背景图层可覆盖顶部图层。顶部图层绘制在目标图层下方。无论背景图层是透明的还是没有数据，您都会看到顶部图层。
destination-atop	仅当目标/背景图层与顶部图层重叠时，才会绘制目标/背景图层。顶部图层绘制在背景图层下方。无论背景图层是透明的还是没有数据，您都会看到顶部图层。
destination-in	仅当目标/背景图层与顶部图层重叠时，才会绘制目标/背景图层。其他一切都变得透明。
destination-out	目标/背景图层在不与顶部图层相重叠的位置处绘制。其他一切都变得透明。
source-atop	源/顶部图层仅在与背景图层相重叠的位置处绘制。在源图层透明或没有数据的位置处，您都会看到背景图层。
source-in	源/顶部图层仅在与背景图层相重叠的位置处绘制。其他一切都变得透明。
source-out	源/顶部图层在不与背景图层相重叠的位置处绘制。其他一切都变得透明。
xor	顶部图层和背景图层在重叠处变为透明。这两个图层在其他任何地方都是正常绘制的。

反转混合模式：

以下混合模式根据背景图层的颜色反转或抵消颜色。这些混合模式查找顶部图层和背景图层之间的差异。例如，您可以在森林覆盖的两个影像图层上使用 difference 或 exclusion 混合模式，以可视化森林覆盖从一年到另一年的变化。

invert 混合模式可用于将任何浅色底图转换为深色底图，以适应在弱光条件下工作的人。

混合模式	描述
difference	从较浅颜色中减去重叠颜色中的较深颜色。减去两个具有相同值的像素时，结果为黑色。与黑色混合不会产生任何变化。与白色混合可反转颜色。此混合模式对于对齐具有相似内容的图层非常有用。
exclusion	类似于 difference 混合模式，只是生成的图像整体更亮。具有较浅颜色值的重叠区域将变亮，而较暗的重叠颜色值将变为透明。
minus	从背景图层的颜色中减去顶部图层的颜色，使混合结果更暗。对于负值，将显示黑色。
invert	在顶部图层和背景图层相重叠的任何位置处，反转背景色。反转混合模式可反转类似于照相底片的图层。
reflect	此混合模式创建的效果就像在图层中添加了闪亮物体或光线区域一样。背景图层中的黑色像素将被忽略，就好像它们是透明的一样。

可能值："average"|"color-burn"|"color-dodge"|"color"|"darken"|"destination-atop"|"destination-in"|"destination-out"|"destination-over"|"difference"|"exclusion"|"hard-light"|"hue"|"invert"|"lighten"|"lighter"|"luminosity"|"minus"|"multiply"|"normal"|"overlay"|"plus"|"reflect"|"saturation"|"screen"|"soft-light"|"source-atop"|"source-in"|"source-out"|"vivid-light"|"xor"

默认值：normal

另请参阅

• 图层混合示例

capabilities Capabilitiesreadonly

描述图层的受支持功能。

示例

// Once the layer loads, check if the
// supportsAdd operations is enabled on the layer
featureLayer.when(function(){
  if (featureLayer.capabilities.operations.supportsAdd) {
    // if new features can be created in the layer
    // set up the UI for editing
    setupEditing();
  }
});

declaredClass Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className。

defaultPopupTemplate PopupTemplatereadonly

子图层的默认弹出模板的定义。

definitionExpression String

用于过滤客户端中要素的 SQL where 子句。仅满足定义表达式的要素才会显示在 View 中。定义表达式不同于包含列表，因为它是在返回父级 KnowledgeGraphLayer 之后应用的。如果数据集很大，并且您不想将所有要素都提交给客户端以进行分析，则设置定义表达式是很有用的。

示例

// Set the definition expression directly on sublayer instance to only suppliers with more than 50 employees.
knowledgeGraphLayer.layers.items[0].definitionExpression = "employee_count > 50";

displayField String

子图层的主要显示字段的名称。此属性值与子图层的其中一个字段的名称相匹配。

effect Effectautocast

Effect 提供了可在图层上执行的各种过滤函数，以实现类似于图像过滤工作方式的不同视觉效果。这种强大的功能允许您将 css filter-like 函数应用于图层以创建自定义视觉效果，以提高地图的制图质量。这是通过将所需效果作为字符串或对象数组应用到图层的 effect 属性以设置与比例相关的效果来完成的。

注

• 如果需要对满足或不符合指定过滤器要素应用不同的效果，可设置 featureEffect 属性。
• 如果全部应用以下四个属性，则将按以下顺序应用：featureEffect、effect、opacity 和 blendMode。

已知限制

• 3D SceneViews 中不支持该效果。
• 此效果不能应用于具有热点图渲染器的图层。
• 启用 cluster 类型为 featureReduction 的图层不支持此效果。
• 请参阅打印以了解已知的打印限制。

默认值：null

另请参阅

• featureEffect

• 关于如何设置效果的更多信息

• 图层和图层视图效果示例

示例

// the following effect will be applied to the layer at all scales
// brightness will be applied first, then hue-rotate followed by contrast
// changing order of the effects will change the final result
layer.effect = "brightness(5) hue-rotate(270deg) contrast(200%)";

// set a scale dependent bloom effect on the layer
layer.effect = [
  {
    scale: 36978595,
    value: "drop-shadow(3px, 3px, 4px)"
  },
  {
    scale: 18489297,
    value: "drop-shadow(2px, 2px, 3px)"
  },
  {
    scale: 4622324,
    value: "drop-shadow(1px, 1px, 2px)"
  }
];

elevationInfo Object

指定要素在垂直轴 (z) 上的放置方式。此属性只能在 SceneView 中使用。

已知限制

KnowledgeGraphService 目前不支持 z 值。

属性

mode String 定义要素相对于地形表面或场景中 3D 对象的放置方式。如果几何由多个点 (例如线或多边形) 组成，则对每个点分别评估高程。有关可能值列表，请参见下表。 模式 描述 on-the-ground 要素与 Ground 对齐。如果场景包含 IntegratedMeshLayer，则要素将与 IntegratedMeshLayer 对齐。如果要素具有 z 值，则在此模式下会忽略 z 值。带有 2D 符号的要素叠加在 Ground 或 IntegratedMeshLayer 上。这是没有 z 值的图层的默认模式，其中包含使用 ObjectSymbol3DLayer 渲染的 Polyline、Polygon 要素或 Point 要素。 absolute-height 要素放置在海平面以上的绝对高程 (z 值) 处。此 z 值由几何的 z 值 (如果存在) 确定。如果定义了 featureExpressionInfo，则使用表达式的结果而不是几何的 z 值。此模式不考虑使用 Ground 或任何其他图层的高程。这是任何几何类型的要素的默认值，其中 hasZ 为 true。 relative-to-ground 要素放置在相对于 Ground 或 IntegratedMeshLayer 的高度上。要素的高程由 Ground 或 IntegratedMeshLayer 的高程和几何的 z 值 (如果存在) 的总和确定。如果定义了 featureExpressionInfo，则使用表达式的结果而不是几何的 z 值。如果几何没有 z 值，则 relative-to-ground 是使用 IconSymbol3DLayers 渲染的 Point 几何的默认值。 relative-to-scene 要素与拉伸多边形、3D Object SceneLayers 或 BuildingSceneLayers 对齐，具体取决于哪个高程更高。如果要素不在建筑物或任何其他要素的正上方，则将其与 Ground 或 IntegratedMeshLayer 的高程对齐。如果存在，则将几何的 z 值添加到高程中。如果定义了 featureExpressionInfo，则使用表达式的结果而不是几何的 z 值。 可能值："on-the-ground"|"relative-to-ground"|"absolute-height"|"relative-to-scene"

offset Number optional 高程偏移，将其添加到要素的垂直位置。如果未定义 unit，则偏移量以 meters 为单位。当 mode = "on-the-ground" 时，则此属性无效。

featureExpressionInfo Object optional 定义如何根据其属性覆盖要素的 Z 值。 规范 expression String optional 遵循 Arcade 要素 Z 配置文件定义的规范的 Arcade 表达式。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回一个表示要素 z 值的数字。当 mode = "on-the-ground" 时，则此属性无效。对于线和多边形几何，表达式的结果对于要素的所有折点都是相同的。

unit String optional featureExpressionInfo 和 offset 值的单位。 可能值："feet"|"meters"|"kilometers"|"miles"|"us-feet"|"yards"

featureReduction FeatureReductionBinning|FeatureReductionCluster|FeatureReductionSelectionautocast

配置减少视图中点要素数量的方法。默认情况下，该属性为 null，表示图层视图应绘制每个要素。

要素缩减有三种类型：selection、cluster 和 binning。

• Selection 仅适用于 SceneView 中的点，并包括减少重叠要素，因此屏幕上没有相交要素。从版本 4.4 开始提供此功能。
• Cluster 将 MapView 中的点分组为屏幕空间中定义的聚类。每个聚类都是一个点，其大小与聚类内要素的数量成比例。从版本 4.14 开始提供此功能。
• Binning 可在空间上将 MapView 中的点分组到图格中，这些图格清楚地定义了地图空间中聚合要素的区域。从版本 4.24 开始提供此功能。

另请参阅

• 示例 - 点聚类

• 示例 - 具有视觉变量的点聚类

• 示例 - 过滤聚类点

• 示例 - 用于城市的点样式

示例

// clusters points based on their spatial proximity to other points
layer.featureReduction = {
  type: "cluster",
  clusterRadius: 100
};

// thins features in the view
layer.featureReduction = {
  type: "selection"
};

// Aggregates features to bins
layer.featureReduction = {
  type: "binning",
  renderer: {
    type: "simple",  // autocasts as new SimpleRenderer()
    symbol: {
      type: "simple-fill",  // autocasts as new SimpleFillSymbol()
      outline: {  // autocasts as new SimpleLineSymbol()
        width: 0.5,
        color: "white"
      }
    },
    visualVariables: [{
      type: "color",
      field: "aggregateCount",
      stops: [
        { value: 1, color: "white" },
        { value: 1000, color: "blue" }
      ]
    }]
  },
  popupTemplate: {
    content: "This bin contains <b>{aggregateCount}</b> features.",
    fieldInfos: [{
      fieldName: "aggregateCount",
      format: {
        digitSeparator: true,
        places: 0
      }
    }]
  }
};

fullExtent Extentautocast inherited

图层的完整范围。默认情况下，这是全球范围的。可使用此属性设置视图的范围以匹配图层的范围，以便其要素出现在视图中。请参阅以下示例片段。

示例

// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
  view.extent = layer.fullExtent;
});

geometryFieldName String

子图层的几何字段的名称。

geometryType String

子图层中要素的几何类型。

可能值："point"|"multipoint"|"polyline"|"polygon"

graphType String

指定子图层是表示实体类型还是关系类型。

可能值："entity"|"relationship"|"both”

hasM Boolean

指示子图层中的要素是否具有 M (测量值) 值。使用 KnowledgeGraphSublayer 的 capabilities.data 对象中的 supportsM 属性验证是否支持 M 值。

默认值：false

hasZ Boolean

指示图层中的要素是否具有 Z (高程) 值。有关在 3D SceneViews 中放置和渲染具有 z 值的要素的详细信息，请请参阅 elevationInfo。使用 KnowledgeGraphSublayer 的 capabilities.data 对象中的 supportsZ 属性验证是否支持 Z 值。

已知限制

KnowledgeGraphService 目前不支持 z 值。

默认值：false

id String inherited

分配给图层的唯一 ID。如果不是开发人员设置的，它将在加载图层时自动生成。

labelingInfo LabelClass[]autocast

自动转换自 Object[]

此子图层的标注定义，指定为标注类的数组。使用此属性可以指定子图层的标注属性，例如标注表达式、放置和大小。

具有不同 where 子句的多个标注类可用于在同一要素上定义具有不同样式的多个标注。同样，可以使用多个标注类来标注不同类型的要素 (例如，湖泊的蓝色标注和公园的绿色标注)。

请参阅标注指南页面，了解更多信息和已知限制。

另请参阅

• 示例：将多个标注类添加至图层

• 示例：多行标注

• 示例：平面 vs. 立体 3D 符号图层

示例

const statesLabelClass = new LabelClass({
  labelExpressionInfo: { expression: "$feature.NAME" },
  symbol: {
    type: "text",  // autocasts as new TextSymbol()
    color: "black",
    haloSize: 1,
    haloColor: "white"
  }
});

knowledgeGraphLayer.layers.items[0].labelingInfo = [ statesLabelClass ];

labelsVisible Boolean

指示是否显示此子图层的标注。如果为 true，标注将按 labelingInfo 属性中定义的方式显示。

已知限制

3D SceneViews 仅支持为每个要素显示一个 LabelClass。

默认值：true

listMode String inherited

指示图层在 LayerList 微件中的显示方式。下面列出了可能的值。

值	描述
show	图层在内容列表中可见。
hide	图层在内容列表中隐藏。
hide-children	如果图层是 GroupLayer、BuildingSceneLayer、KMLLayer、MapImageLayer、TileLayer 或 WMSLayer，则从内容列表中隐藏子图层。

可能值："show"|"hide"|"hide-children"

默认值："show"

loaded Booleanreadonly inherited

指示图层的资源是否已加载。如果为 true，则可访问对象的所有属性。

默认值：false

loadError Errorreadonly inherited

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

默认值：null

loadStatus Stringreadonly inherited

load 操作的状态

值	描述
not-loaded	尚未加载
loading	正在加载
loaded	对象已加载且未出现错误
failed	无法加载对象的资源。有关更多详情，请参阅 loadError。

可能值："not-loaded"|"loading"|"failed"|"loaded"

默认值：not-loaded

loadWarnings Object[]readonly inherited

加载时发生的警告列表

objectIdField String

oid 的名称，其中包含子图层中每个要素的唯一值或标识符。

objectType GraphObjectType

概述由子图层表示的命名类型的类型定义。

opacity Number inherited

图层的不透明度。此值的范围在 1 和 0 之间，其中 0 是 100% 透明，而 1 为完全不透明。

默认值：1

示例

// Makes the layer 50% transparent
layer.opacity = 0.5;

parent Map|Basemap|Ground|GroupLayer inherited

起始版本：GeoScene Maps SDK for JavaScript 4.27

图层所属的父图层。

parentCompositeLayer KnowledgeGraphLayer

特定实体或关系类型的子图层的 KnowledgeGraphLayer。

popupTemplate PopupTemplateautocast

子图层的弹出模板。在子图层上设置时，popupTemplate 允许用户在使用文本和/或图表选择要素时访问属性并在视图的弹出窗口中显示其值。。

当 Popup.defaultPopupTemplateEnabled 设置为 true 时，如果未定义 popupTemplate，则自动使用默认弹出模板。

另请参阅

• createPopupTemplate

• View

renderer Rendererautocast

分配给子图层的渲染器。渲染器定义如何可视化子图层中的每个要素。根据渲染器类型，可以使用相同的符号或基于提供的属性字段或函数的值使用不同的符号来可视化要素。

另请参阅

• 样式和数据可视化

示例

// all features in the sublayer will be visualized with
// a 6pt black marker symbol and a thin, white outline

//Apply renderer to the first sublayer of the KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];
sublayer.renderer = {
  type: "simple",  // autocasts as new SimpleRenderer()
  symbol: {
    type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
    size: 6,
    color: "black",
    outline: {  // autocasts as new SimpleLineSymbol()
      width: 0.5,
      color: "white"
    }
  }
};

title String inherited

用于在某些地方标识它的图层标题，例如 LayerList 微件。

如果图层是从门户项目加载的，则将使用门户项目的标题。如果图层作为 webmap 或 webscene 的一部分加载，则将使用存储在 webmap/webscene 中的图层标题。

type Stringreadonly

对于 KnowledgeGraphSublayer，类型总是 "knowledge-graph-sublayer”。

visible Boolean inherited

指示图层在 View 中是否可见。当为 false 时，图层仍可能添加到视图引用的 Map 实例中，但其要素将在视图中不可见。

默认值：true

示例

// The layer is no longer visible in the view
layer.visible = false;

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

cancelLoad()inherited

如果 load() 操作已在进行中，则取消它。

createLayerView(view, options){Promise<LayerView>}inherited

将图层添加到 Map.layers 集合并且必须为其创建图层视图时，由视图调用，例如 MapView 和 SceneView。此方法在内部使用，没有直接调用它的用例。

参数

view * 父视图。

options Object optional 指定附加选项的对象。有关此对象所需的属性，请参阅下面的对象规范表。 规范 signal AbortSignal optional 中止 layerview 创建的信号。

返回

类型	描述
Promise<LayerView>	使用 LayerView 实例解析。

另请参阅

• 示例 - 自定义 WebGL 图层视图

createPopupTemplate(options){PopupTemplate}

为图层创建一个弹出模板，使用图层的所有字段进行填充。

参数

options CreatePopupTemplateOptions optional 用于创建弹出模板的选项。

返回

类型	描述
PopupTemplate	弹出模板，如果图层没有任何字段，则为 null。

destroy()inherited

销毁图层和任何相关资源 (包括其 portalItem，如果它是图层上的属性)。一旦图层被破坏，则无法再使用。

被破坏的图层将从其父对象中移除，例如 Map、WebMap、WebScene、Basemap、Ground 或 GroupLayer。

另请参阅

• Map.destroy()
• WebMap.destroy()
• WebScene.destroy()
• Basemap.destroy()
• Ground.destroy()
• PortalItem.destroy()

emit(type, event){Boolean}inherited

在实例上触发事件。仅当创建此类的子类时，才应使用此方法。

参数

type String 事件的名称。

event Object optional 事件有效负载。

返回

类型	描述
Boolean	true 如果监听器收到通知，则为

fetchAttributionData(){Promise<object>}inherited

在图层可用时，获取图层的自定义属性数据。

返回

类型	描述
Promise<Object>	解析为包含图层自定义属性数据的对象。

getField(fieldName){Field}

返回字段名称的 Field 实例 (不区分大小写)。

参数

fieldName String 字段名称。

返回

类型	描述
Field	匹配字段或 undefined

getFieldDomain(fieldName, options){Domain}

返回与给定字段名称相关联的 Domain。域可以是 CodedValueDomain 或 RangeDomain。

参数

fieldName String 字段名称。

options Object optional 指定附加选项的对象。有关此对象所需的属性，请参阅下面的对象规范表。 规范 feature Graphic 将 Domain 分配到的要素。

返回

类型	描述
Domain	与给定要素的给定字段名称相关联的 Domain 对象。

示例

// Get a range domain associated with the first feature
// returned from queryFeatures().
//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];
sublayer.queryFeatures(query).then(function(results){
  const domain = sublayer.getFieldDomain("Height", {feature: results.features[0]});
  console.log("domain", domain)
});

hasEventListener(type){Boolean}inherited

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

参数

type String 事件的名称。

返回

类型	描述
Boolean	如果类支持输入事件，则返回 true。

hasHandles(groupKey){Boolean}inherited

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled(){Boolean}inherited

isFulfilled() 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。如果满足，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已完成 (已解决或已拒绝)。

isRejected(){Boolean}inherited

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}inherited

isResolved() 可用于验证创建类的实例是否已解决。如果已解决，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已解决。

load(signal){Promise}inherited

加载此类引用的资源。如果视图是使用地图实例构造的，则此方法会自动为 View 及其在 Map 中引用的所有资源执行。

开发人员在访问不会在 View 中加载的资源时，必须调用此方法。

load() 方法仅在第一次调用时触发资源的加载。随后的调用将返回相同的 promise。

可以提供一个 signal 来停止对 Loadable 实例加载状态感兴趣。当信号中止时，实例不会停止其加载过程，只有 cancelLoad 可以中止它。

参数

signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise	资源已加载时解析。

on(type, listener){Object}inherited

在实例上注册事件处理程序。调用此方法将事件与监听器挂钩。

参数

type String|String[] 要监听的事件或事件数组。

listener Function 事件触发时要调用的函数。

返回

类型	描述
Object	返回一个具有 remove() 方法的事件处理程序，应该调用该方法以停止监听事件。 属性 类型 描述 remove Function 当调用时，将从事件中移除该监听器。

示例

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

queryExtent(query, options){Promise<object>}

对知识图谱服务执行查询，并返回满足查询条件的要素范围。如果未指定任何参数，则返回满足子图层配置/过滤器的所有要素的范围和计数。

参数

query Query autocast optional 自动转换自 Object 指定查询的属性和空间过滤器。如果未指定任何参数，则返回满足子图层配置/过滤器的所有要素的范围和计数。

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<Object>	解析后，返回满足输入查询的要素的范围和计数。有关详细信息，请参阅下面的对象规范表。 属性 类型 描述 count Number 满足输入查询的要素数量。 extent Extent 满足查询的要素范围。

示例

// Queries for the extent of all features matching the layer's configurations
// e.g. definitionExpression
//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];
sublayer.queryExtent().then(function(results){
  // go to the extent of the results satisfying the query
  view.goTo(results.extent);
});

//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];

const query = new Query();
query.where = "region = 'xxx'";

sublayer.queryExtent(query).then(function(results){
  view.goTo(results.extent);  // go to the extent of the results satisfying the query
});

queryFeatureCount(query, options){Promise<number>}

对知识图谱服务执行查询，并返回满足查询条件的要素数。如果未指定任何参数，则返回满足子图层配置/过滤器的要素总数。

参数

query Query autocast optional 自动转换自 Object 指定查询的属性和空间过滤器。如果未指定任何参数，则返回满足图层配置/过滤器的要素总数。

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<number>	解析后，可返回满足查询的要素数。

示例

// Queries for the count of all features matching the layer's configurations
// e.g. definitionExpression
//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];
sublayer.queryFeatureCount().then(function(numFeatures){
  // prints the total count to the console
  console.log(numFeatures);
});

//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];

const query = new Query();
query.where = "region = 'xxx'";

sublayer.queryFeatureCount(query).then(function(numResults){
  console.log(numResults);  // prints the number of results satisfying the query
});

queryFeatures(query, options){Promise<FeatureSet>}

对要素服务执行查询并返回一个 FeatureSet，一旦 promise 解析，就可使用 .then() 方法访问该要素集。FeatureSet 包含一组 Graphic 要素。有关如何从图层查询要素的更多信息，请参阅 querying 部分。

要查询客户端 View 中可用或可见的要素/图形，而不是进行服务器端查询，您必须使用 FeatureLayerView.queryFeatures() 方法。

当查询具有 z 值且没有垂直坐标系信息的服务时，z 值将自动转换以匹配 outSpatialReference 单位。示例：服务具有一个水平空间参考 (以 feet 为单位)，并使用基于 meter 单位的 outSpatialReference 进行查询，然后 queryFeatures() 将自动将值从 feet 转换为 meter 单位。

参数

query Query autocast optional 自动转换自 Object 指定查询的属性和空间过滤器。如果未指定任何参数，则返回满足图层配置/过滤器的所有要素。

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<FeatureSet>	解析后，将返回包含图形要素数组的 FeatureSet。

示例

// Queries for all the features matching the layer's configurations
// e.g. definitionExpression
 //get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];
sublayer.queryFeatures().then(function(results){
  // prints the array of result graphics to the console
  console.log(results.features);
});

//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];

const query = new Query();
query.where = "STATE_NAME = 'xxx'";
query.outSpatialReference = { wkid: 102100 };
query.returnGeometry = true;
query.outFields = [ "CITY_NAME" ];

sublayer.queryFeatures(query).then(function(results){
  console.log(results.features);  // prints the array of features to the console
});

// Get a query object for the sublayer's current configuration
const queryParams = sublayer.createQuery();
// set a geometry for filtering features by a region of interest
queryParams.geometry = extentForRegionOfInterest;
// Add to the sublayer's current definitionExpression
queryParams.where = queryParams.where + " AND TYPE = 'Extreme'";

// query the sublayer with the modified params object
sublayer.queryFeatures(queryParams).then(function(results){
  // prints the array of result graphics to the console
  console.log(results.features);
});

//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];

// query all features from the layer and only return
// attributes specified in outFields.
const query = { // autocasts as Query
  where: "1=1", // select all features
  returnGeometry: false,
  outFields: ["State_Name", "City_Name", "pop2010"]
};

sublayer.queryFeatures(query).then(function(results){
  console.log(results.features);  // prints the array of features to the console
});

queryObjectIds(query, options){Promise<number[]>}

对知识图谱服务执行查询，并返回满足输入查询的要素的对象 ID 数组。如果未指定任何参数，则返回满足图层配置/过滤器的所有要素的对象 ID。

参数

query Query autocast optional 自动转换自 Object 指定查询的属性和空间过滤器。如果未指定任何参数，则返回满足子图层配置/过滤器的所有要素的对象 ID。

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<number[]>	解析后，返回一个数字数组，表示满足查询的要素的对象 ID。

示例

// Queries for all the Object IDs of features matching the layer's configurations
// e.g. definitionExpression
//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = knowledgeGraphLayer.layers.items[0];
sublayer.queryObjectIds().then(function(results){
  // prints the array of Object IDs to the console
  console.log(results);
});

//get the first sublayer from the parent KnowledgeGraphLayer
const sublayer = linkChartLayer.layers.items[0];

const query = new Query();
query.where = "region = 'xxx'";

sublayer.queryObjectIds(query).then(function(ids){
  console.log(ids);  // an array of object IDs
});

removeHandles(groupKey)inherited

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

when(callback, errback){Promise}inherited

when() 一旦创建了类的实例，就可以使用 。此方法接受两个输入参数：callback 函数和 errback 函数。callback 在类的实例加载时执行。errback 在类的实例无法加载时执行。

参数

callback Function optional 当 promise 解决时调用的函数。

errback Function optional 当 promise 失败时执行的函数。

返回

类型	描述
Promise	返回 callback 结果的新 promise，可用于链接其他函数。

示例

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

类型定义

Capabilities Object

描述图层的受支持功能。

属性

analytics Object 描述图层上启用了哪些分析功能。 规范 supportsCacheHint Boolean 指示要素服务是否支持缓存提示。

attachment Object 描述图层上启用了哪些附件功能。 规范 supportsCacheHint Boolean 指示附件操作是否支持缓存提示。这仅对托管要素服务有效。 supportsContentType Boolean 指示是否可按其内容类型查询附件。 supportsExifInfo Boolean 指示附件查询是否支持 exifInfo。 supportsKeywords Boolean 指示是否可按其关键字查询附件。 supportsName Boolean 指示是否可按其名称查询附件。 supportsSize Boolean 指示是否可按其大小查询附件。 supportsResize Boolean 指示在要素图层中是否支持调整大小的附件。这对于在 Popups 中显示缩略图非常有用。

data Object 描述图层中数据的特征。 规范 isVersioned Boolean 指示要素服务是否已版本化。 supportsAttachment Boolean 指示是否在图层上启用了附件。 supportsM Boolean 指示图层中的要素是否支持 m 值。 supportsZ Boolean 指示图层中的要素是否支持 z 值。有关在 3D SceneViews 中放置和渲染具有 z 值的要素的详细信息，请参阅 elevationInfo。

editing Object 描述可对图层中的要素执行的编辑功能。 规范 supportsDeleteByAnonymous Boolean 指示匿名用户是否可以删除其他人创建的要素。 supportsDeleteByOthers Boolean 指示登录用户是否可以删除其他人创建的要素。 supportsGeometryUpdate Boolean 指示是否可以编辑图层中要素的几何。 supportsGlobalId Boolean 指示是否在编辑中使用客户端提供的 globalId 值。 supportsRollbackOnFailure Boolean 表示在编辑要素时，rollbackOnFailureEnabled 参数是否可以设置为 true 或 false。 supportsUpdateByAnonymous Boolean 指示匿名用户是否可以更新其他人创建的要素。 supportsUpdateByOthers Boolean 指示登录用户是否可以更新其他人创建的要素。 supportsUploadWithItemId Boolean 指示图层是否支持按 UploadId 上传附件。 supportsUpdateWithoutM Boolean 表示更新要素时是否必须提供 m-values。

metadata Object 描述图层中要素所包含的元数据。 规范 supportsAdvancedFieldProperties Boolean 指示是否提供用户定义的字段描述。

operations Object 描述可对图层中的要素执行的操作。 规范 supportsAdd Boolean 指示是否可将新要素添加到图层中。 supportsCalculate Boolean 指示是否可以更新图层中的一个或多个字段的值。 supportsDelete Boolean 指示是否可从图层中删除要素。 supportsEditing Boolean 指示是否可以编辑图层中的要素。使用 supportsAdd、supportsUpdate 和 supportsDelete 来确定支持哪些编辑操作。 supportsQuery Boolean 指示是否可以查询图层中的要素。 supportsQueryAttachments Boolean 指示图层是否支持 REST API queryAttachments 操作。如果为 false，则 queryAttachments() 方法一次只能返回一个要素的附件。如果为 true，则 queryAttachments() 可以返回 objectIds 数组的附件。 supportsResizeAttachments Boolean 已在 4.24 中弃用。请改为使用 attachment.supportsResize。指示在要素图层中是否支持调整大小的附件。这对于在 Popups 中显示缩略图非常有用。 supportsQueryTopFeatures Boolean 指示图层是否支持 REST API queryTopFeatures 操作。 supportsUpdate Boolean 指示是否可以更新图层中的要素。 supportsValidateSql Boolean 指示图层是否支持 SQL-92 表达式或 where 子句。

query Object 描述可对图层中的要素执行的查询操作。 属性 maxRecordCount Number 将为给定查询返回的最大记录数。 supportsCacheHint Boolean 指示查询操作是否支持缓存提示。这仅对托管要素服务有效。 supportsCentroid Boolean 指示是否可以返回与每个面要素相关联的几何质心。 supportsDisjointSpatialRelationship Boolean 指示查询操作是否支持 disjoint 空间关系。这仅对托管要素服务有效。 supportsDistance Boolean 指示图层的查询操作是否支持输入几何的缓冲距离。 supportsDistinct Boolean 指示图层是否支持根据 outFields 中指定的字段查询不同的值。 supportsExtent Boolean 指示图层的查询响应是否包括要素的范围。 supportsGeometryProperties Boolean 指示图层的查询响应是否包含几何属性，包括形状面积和长度属性。 supportsHavingClause Boolean 指示图层是否支持服务上的 having 子句。 supportsHistoricMoment Boolean 表示图层是否支持历史时刻查询。 supportsOrderBy Boolean 指示查询响应中返回的要素是否可以按一个或多个字段排序。 supportsPagination Boolean 指示查询响应是否支持分页。 supportsPercentileStatistics Boolean 表示图层是否支持百分位数统计类型。 supportsQuantization Boolean 指示查询操作是否支持将几何投影到虚拟网格上。 supportsQuantizationEditMode Boolean 指示查询操作是否支持旨在用于编辑模式的量化 (给定空间参考的最高分辨率)。 supportsQueryGeometry Boolean 表示查询响应是否包含查询几何。 supportsResultType Boolean 表示是否可以控制查询操作返回的要素数量。 supportsStandardizedQueriesOnly Boolean 指示图层是否支持使用标准化查询。 supportsStatistics Boolean 指示图层是否支持基于字段的统计函数。 supportsSqlExpression Boolean 表示图层是否支持 SQL 表达式。 supportsSpatialAggregationStatistics Boolean 指示图层是否支持在使用 groupByFieldsForStatistics 时为每个不同的组返回空间范围、中心或凸包。仅支持 GeoScene Online 托管要素服务。 supportedSpatialStatisticAggregations Object 使用 groupByFieldsForStatistics 时，为每个不同组返回的支持的聚合几何列表。 规范 centroid Boolean 指示图层是否可以为 groupByFieldsForStatistics 的每个不同组返回质心。 envelope Boolean 指示图层是否可以为 groupByFieldsForStatistics 的每个不同组返回范围。 convexHull Boolean 指示图层是否可以为 groupByFieldsForStatistics 的每个不同组返回质凸包。

queryRelated Object 表示图层的查询操作是否支持查询图层中的要素或与要素相关的记录。 规范 supportsCacheHint Boolean 指示关系查询操作是否支持缓存提示。这仅对托管要素服务有效。 supportsCount Boolean 指示图层的查询响应是否包含与图层中的要素相关的要素或记录数。 supportsOrderBy Boolean 表示查询响应中返回的相关要素或记录是否可以按一个或多个字段排序。 supportsPagination Boolean 指示查询响应是否支持相关要素或记录的分页。

queryTopFeatures Object 描述可对图层中的要素执行的顶部要素查询操作。 规范 supportsCacheHint Boolean 指示顶部查询操作是否支持缓存提示。这仅对托管要素服务有效。

事件概述

事件详细说明

layerview-createinherited

创建图层的 LayerView 并在视图中呈现后触发。

属性

view View 在其中创建 layerView 的视图。

layerView LayerView 在表示 layer 中图层的视图中进行渲染的 LayerView。

另请参阅

• View.whenLayerView()

示例

// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-create-errorinherited

将图层添加到地图后，在创建 LayerView 期间出现错误时触发。

属性

view View 为图层创建 layerview 失败触发此事件的视图。

error Error 描述图层视图创建失败原因的错误对象。

另请参阅

• View.whenLayerView()

示例

// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});

layerview-destroyinherited

销毁图层的 LayerView 并不再在视图中呈现后触发。

属性

view View 在其中销毁 layerView 的视图。

layerView LayerView 被销毁的表示图层的 LayerView。