SearchSource

属性概述

属性详细信息

autoNavigate Boolean

指示选择后是否自动导航到所选结果。

默认值：true

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

filter Object

起始版本：GeoScene Maps SDK for JavaScript 4.4

用于过滤建议或搜索结果。在此处设置值优先于 withinViewEnabled。有关详细信息，请参阅下面的对象规格表。

属性

where String optional 为过滤建议或搜索结果指定的 where 子句。

geometry Geometry optional 建议或搜索结果的过滤器几何。Extent 是使用 locator 源时唯一支持的几何图形。

示例

const theExtent = new Extent({
  xmin: 11376463,
  ymin: -5163501,
  xmax: 18890529,
  ymax: -662888,
  spatialReference: {
    wkid: 3857
  }
});

const searchExtent = {
  geometry: theExtent,
  where: "TERRITORY = 'Northern Territory'"
};

const sources = [{
  layer: featureLayerTourism,
  placeholder: "Darwin",
  maxResults: 5,
  searchFields: ["POI"],
  displayField: "POI",
  name: "In a Sunburned Country",
  filter: searchExtent
}];

const searchWidget = new Search({
  view: view,
  sources: sources
});

getResults GetResultsHandler

用于获取搜索结果的函数。有关函数定义，请参阅 GetResultsHandler。解析后，返回一个包含搜索结果数组的对象。

getSuggestions GetSuggestionsParameters

用于获取搜索建议的函数。有关函数定义，请参阅 GetSuggestionsParameters。解析后，返回一个包含建议结果数组的对象。

maxResults Number

指示要返回的最大搜索结果数。

默认值：6

maxSuggestions Number

指示为微件的输入返回的最大建议数。

默认值：6

minSuggestCharacters Number

指示查询建议之前所需的最少字符数。

默认值：1

outFields String[]

指定与搜索结果一起返回的字段。

placeholder String

用作源输入文本的提示。

popupEnabled Boolean

指示单击选定结果时是否显示弹出窗口。

popupTemplate PopupTemplate

用于显示搜索结果的弹出模板。如果不需要弹出窗口，请将源的 popupTemplate 设置为 null。

此属性应在没有配置现有 PopupTemplate 的情况下设置。例如，要素源将默认为图层上配置的任何现有 popupTemplate。

prefix String

指定此项为用户输入的搜索文本添加前缀。

resultGraphicEnabled Boolean

指示是否使用 resultSymbol 在地图上显示所选源的图形。

resultSymbol Symbol

用于显示结果的符号。

已知限制

此属性仅在 layer/locator/source 不是地图的一部分时适用。

suffix String

指定此项可为用户输入的搜索值添加后缀。

suggestionsEnabled Boolean

指示当用户在微件中输入输入文本时是否显示建议。

默认值：true

withinViewEnabled Boolean

指示是否将搜索结果限制在视图的范围内。

默认值：false

zoomScale Number

生成搜索结果的设置缩放比例。此比例是自动实现的。

默认值：null

示例

let searchWidget = new Search({
  view: view,
  sources: [
    {
      layer: featureLayer,
      searchFields: ["Name", "Team"],
      name: "LayerSearchSource",
      zoomScale: 500000
    }
  ]
});

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

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

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

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

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

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 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");
}

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

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

示例

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

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

toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。

类型定义

GetResultsHandler(params){Promise<SearchResult[]>}

getResults 属性的函数定义。

参数

规范

params Object 作为参数传递以获取搜索结果的对象。 规范 exactMatch Boolean optional 用于查找结果的关键字段。 location Point optional 搜索使用的位置值。 maxResults Number optional 指示要返回的最大搜索结果数。 sourceIndex Number optional 指示搜索源的索引。 spatialReference SpatialReference optional 指示源定义的空间参考。 suggestResult SuggestResult 指示触发结果搜索的建议结果。 view MapView|SceneView optional 指示使用源提供给 Search 微件的视图。

返回

类型	描述
Promise<SearchResult[]>	解析后，返回一个包含搜索结果数组的对象。

GetSuggestionsParameters(params){Promise<SuggestResult[]>}

getSuggestions() 属性的函数定义。

参数

规范

params Object 作为参数传递以获取搜索建议的对象。 规范 maxSuggestions Number optional 指示为微件的输入返回的最大建议数。 sourceIndex Number optional 指示搜索源的索引。 spatialReference SpatialReference optional 指示源定义的空间参考。 suggestTerm String optional 指示用于查找建议的搜索词。 view MapView|SceneView optional 指示使用源提供给 Search 微件的视图。

返回

类型	描述
Promise<SuggestResult[]>	解析后，返回一个包含建议结果数组的对象。