LocatorSearchSource

属性概述

属性详细信息

apiKey String

起始版本：GeoScene Maps SDK for JavaScript 4.19

用于访问资源或服务的授权字符串。API 秘钥可在 GeoScene Developer 仪表盘中生成和管理。API 密钥显式绑定到 GeoScene 帐户；它还用于监视服务的使用情况。在特定类上设置细粒度 API 秘钥将覆盖全局 API 秘钥。

示例

const searchWidget = new Search({
  view: view,
  includeDefaultSources: false,
  sources: [{
    name: "apiKey locator",
    placeholder: "APIs are Key",
    apiKey: "YOUR_API_KEY",
    url: "https://geocode-api.arcgis.com/geoscene/rest/services/World/GeocodeServer"
  }]
});

autoNavigate Boolean inherited

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

默认值：true

categories String[]

一个字符串数组，用于将结果限制为一个或多个类别。例如，Populated Place 或 airport。仅在使用地理编码服务时适用。

countryCode String

将搜索结果限制为指定的国家/地区代码。例如，美国 US 或瑞典 SE。仅适用于世界地理编码服务。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

defaultZoomScale Number

起始版本：GeoScene Maps SDK for JavaScript 4.13

如果定位器服务未返回具有比例的范围，则为生成的搜索结果设置 MapView 或 SceneView 的比例。这方面的一个示例是在搜索栏中使用 Use current location 选项。

如果要覆盖定位器服务返回的比例，请改用 zoomScale。

默认值：null

示例

// create the Search widget
let searchWidget = new Search({
  view: view
});

// wait for the widget to be ready to set the defaultZoomScale
searchWidget.watch("viewModel.state", function(state) {
  if (state === "ready") {
    let firstSource = searchWidget.allSources.getItemAt(0);
    if (firstSource) {
      firstSource.defaultZoomScale = 100000;
    }
  }
});

filter Object

起始版本：GeoScene Maps SDK for JavaScript 4.4

此属性替换现已弃用的 searchQueryParams、suggestQueryParams 和 searchExtent 属性。在此处设置值优先于 withinViewEnabled。有关详细信息，请参阅下面的对象规格表。

属性

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

另请参阅

• withinViewEnabled

示例

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

const searchExtent = {
  geometry: theExtent
};

const sources = [{
  url: "https://geocode-api.arcgis.com/geoscene/rest/services/World/GeocodeServer",
  placeholder: "Darwin",
  maxResults: 3,
  filter: searchExtent
}];

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

getResults GetResultsHandler inherited

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

getSuggestions GetSuggestionsParameters inherited

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

localSearchDisabled Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.22

此属性根据视图比例控制 搜索 微件结果候选项的优先级。

当此属性为 false (默认值) 时，如 MapView 或 SceneView 的比例小于或等于 300,000，location 参数将包含在请求中。这将根据结果候选项与指定点 (视图中心) 的距离来确定结果候选项的优先级。

当此属性为 true 时，无论 MapView 或 SceneView 的比例如何，location 参数都不会包含在请求中。

默认值：false

示例

const searchWidget = new Search({
  view: view,
  includeDefaultSources: false,
  sources: [
    {
      name: "GeoScene World Geocoding Service",
      placeholder: "example: Campton, NH",
      apiKey: "YOUR_API_KEY",
      singleLineFieldName: "SingleLine",
      url: "https://geocode-api.arcgis.com/geoscene/rest/services/World/GeocodeServer",
      localSearchDisabled: true
    }
  ]
});

locationType String

起始版本：GeoScene Maps SDK for JavaScript 4.12

定义从地理编码服务返回的点的位置类型 street 或 rooftop。

可能值："rooftop"|"street"

示例

// create the Search widget
let searchWidget = new Search({
  view: view
});

// wait for the widget to be ready to set the locationType
searchWidget.watch("viewModel.state", function(state) {
  if (state === "ready") {
    let firstSource = searchWidget.allSources.getItemAt(0);
    if (firstSource) {
      firstSource.locationType = "rooftop";
    }
  }
});

maxResults Number inherited

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

默认值：6

maxSuggestions Number inherited

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

默认值：6

minSuggestCharacters Number inherited

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

默认值：1

name String

显示源的名称。

outFields String[] inherited

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

placeholder String

用作源输入文本的提示。

popupEnabled Boolean inherited

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

popupTemplate PopupTemplate inherited

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

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

prefix String inherited

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

resultGraphicEnabled Boolean inherited

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

resultSymbol Symbol inherited

用于显示结果的符号。

已知限制

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

searchTemplate String

模板字符串，用于在显示结果时以定义的顺序显示多个字段。

示例

locatorLayerSource.searchTemplate = "{County}, {State}";

singleLineFieldName String

定位器服务的 REST 服务目录中单行地址字段的字段名称。常见的值为 SingleLine 和 SingleLineFieldName。

suffix String inherited

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

suggestionsEnabled Boolean

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

默认值：true

url String

起始版本：GeoScene Maps SDK for JavaScript 4.22

表示定位器服务的 GeoScene Server REST 资源的 URL。这是必需项。

示例

const sources = [{
  url: "https://geocode-api.arcgis.com/geoscene/rest/services/World/GeocodeServer"
}];

const searchWidget = new Search({
  view: view,
  sources: sources  // autocasts as new LocatorSearchSource()
});

withinViewEnabled Boolean inherited

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

默认值：false

zoomScale Number

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

默认值：null

示例

let searchWidget = new Search({
  view: view,
  includeDefaultSources: false,
  sources: [
    {
      url: "https://geocode-api.arcgis.com/geoscene/rest/services/World/GeocodeServer",
      name: "LocatorSearchSource",
      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() 进行删除。如果未提供键，则句柄将被添加到默认组。

clone(){LocatorSearchSource}

创建此对象的深度克隆。

返回

类型	描述
LocatorSearchSource	新 LocatorSearchSource 实例的克隆。

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 表示。