SearchViewModel

属性概述

属性详细信息

activeSource LayerSearchSource|LocatorSearchSourcereadonly

当前选定的源对象。可以是要素图层或定位器。

activeSourceIndex Number

所选源的索引。此值是 -1 在选择所有源时。

默认值：0

allPlaceholder String

在多个源上搜索时用作输入文本提示的字符串值。请参阅下图，查看此文本在微件上下文中的位置和样式。

默认值："Find address or place"

allSources Collection<(LayerSearchSource|LocatorSearchSource)>readonly

起始版本：GeoScene API for JavaScript 4.8

defaultSources 和源的组合集合。defaultSources 首先显示在搜索 UI 中。

autoSelect Boolean

指示是否自动选择并缩放至第一个地理编码结果。如果 false，则 findAddressCandidates 操作仍将对输入字符串进行地理编码，但不会选择顶部结果。要使用地理编码结果，您可以设置 search-complete 事件处理程序并通过事件对象获取结果。

默认值：true

declaredClass Stringreadonly inherited

起始版本：GeoScene API for JavaScript 4.7

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

defaultSources Collection<(LayerSearchSource|LocatorSearchSource)>readonly

起始版本：GeoScene API for JavaScript 4.8

一个只读属性，它是 LayerSearchSource 和/或 LocatorSearchSource 的集合。此属性可能包含 GeoScene Portal 定位器以及任何 web 地图或 web 场景可配置的搜索源。Web 地图或 web 场景可能包含地图/要素服务要素图层和/或表作为源。

如果未设置源属性，则此属性用于填充搜索 UI。

defaultSymbol Symbol

起始版本：GeoScene API for JavaScript 4.8

已弃用自版本 4.22 起。请改用 defaultSymbols。

搜索结果的默认符号。

Default Value:PictureMarkerSymbol

另请参阅：

• PictureMarkerSymbol

defaultSymbols Object

起始版本：GeoScene API for JavaScript 4.22

搜索结果的默认符号。选择符号取决于视图类型（SceneView 或 MapView）以及搜索结果的几何类型。此属性允许开发人员覆盖一个或多个几何类型的默认符号系统。

属性：

point SimpleMarkerSymbol|PointSymbol3D|TextSymbol|CIMSymbol|WebStyleSymbol optional SimpleMarkerSymbol、PointSymbol3D、TextSymbol、CIMSymbol 或 WebStyleSymbol 用于表示为搜索结果绘制的点几何。SimpleMarkerSymbol 还可用于对 SceneView 中的点要素进行符号化。但是，建议您改用 PointSymbol3D。

polygon SimpleFillSymbol|PolygonSymbol3D|CIMSymbol optional SimpleFillSymbol、PolygonSymbol3D 或 CIMSymbol 用于表示为搜索结果绘制的面几何。SimpleFillSymbol 还可用于对 SceneView 中的面要素进行符号化。但是，建议您改用 PolygonSymbol3D。

polyline SimpleLineSymbol|LineSymbol3D|CIMSymbol optional SimpleLineSymbol、LineSymbol3D 或 CIMSymbol 用于表示为搜索结果绘制的折线几何。SimpleLineSymbol 还可用于对 SceneView 中的折线要素进行符号化。但是，建议您改用 LineSymbol3D。

示例：

const searchWidget = new Search();

searchWidget.viewModel.defaultSymbols = {
   point: new PictureMarkerSymbol({
      url: "https://freesvg.org/img/1287178070.png",
      size: 24,
      width: 24,
      height: 24
   }),
   polygon: new SimpleFillSymbol({
      color: [235, 235, 235, 0.4],
      outline: {
         color: [130, 130, 130, 1],
         width: 2
      }
   }),
   polyline: new SimpleLineSymbol({
      color: [130, 130, 130, 1],
      width: 2
   })
};

goToOverride GoToOverride

起始版本：GeoScene API for JavaScript 4.8

此函数提供了重写 MapView goTo() 或 SceneView goTo() 方法的功能。

另请参阅：

• MapView
• SceneView

示例：

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};

includeDefaultSources Boolean|Function

起始版本：GeoScene API for JavaScript 4.8

指示是否在搜索 UI 中包括 defaultSources。这可以是布尔值或返回搜索源数组的函数。

默认值：true

示例：

// includeDefaultSources passed as a boolean value
let searchWidget = new Search({
  view: view
});
searchWidget.viewModel.includeDefaultSources = false;

// includeDefaultSources passed as a function
let searchWidget = new Search({
  view: view
});
searchWidget.viewModel.includeDefaultSources = function(sourcesResponse) {
    return sourcesResponse.defaultSources;
};

locationEnabled Boolean

起始版本：GeoScene API for JavaScript 4.8

指示是否在微件中启用定位服务。

仅在安全源上支持使用此属性。要使用它，请将应用程序切换到安全源，例如 HTTPS。请注意，localhost 被认为是“潜在的安全”，可用于在支持 Window.isSecureContext（目前是 Chrome 和 Firefox）的浏览器中轻松测试。

maxInputLength Number

搜索文本的最大字符长度。

默认值：128

maxResults Number

如果源未指定，则微件返回的最大结果数。

默认值：6

maxSuggestions Number

如果源未指定，则微件返回的最大建议数。

如果使用默认的 GeoScene Online 地理编码服务，则默认值仍为 5。

默认值：6

minSuggestCharacters Number

如果源未指定，则搜索所需的最小字符数。

默认值：1

placeholder Stringreadonly

activeSource 使用的占位符。

popupEnabled Boolean

指示是否在单击要素时显示弹出窗口。可以单击图形以显示弹出窗口。

默认值：true

popupTemplate PopupTemplate

所选要素的自定义 PopupTemplate。请注意，在 allSources 上定义的任何模板都优先于直接在模板上定义的模板。

默认值：null

portal Portal

起始版本：GeoScene API for JavaScript 4.8

可以搜索指定门户实例的定位器服务使用此属性可将此 GeoScene Portal 实例设置为搜索。

resultGraphic Graphicreadonly

用于高亮显示生成的要素或位置的图形。

默认值：null

resultGraphicEnabled Boolean

指示 resultGraphic 是否将显示在所选要素的位置。

对于不支持 highlight 方法的图层视图，将在视图的图形中放置一个图形。

默认值：true

results Object[]readonly

来自搜索的当前结果的数组。

默认值：null

searchAllEnabled Boolean

指示是否显示搜索所有源的选项。当 true 时，默认情况下显示“全部”选项：

当 false 时，没有一次搜索所有源的选项可用时：

默认值：true

searchTerm String

搜索框的值输入文本字符串。

selectedResult Objectreadonly

从搜索中选择的结果。

默认值：null

selectedSuggestion Geometry|SuggestResultreadonly

选定的 SuggestResult。

默认值：null

sources Collection<(LayerSearchSource|LocatorSearchSource)>

搜索微件可用于搜索 FeatureLayer 或表中的要素，或者使用定位器对位置进行地理编码。sources 属性定义要从中搜索由搜索微件实例指定的视图的源。有两种类型的源：

• LayerSearchSource
• LocatorSearchSource

这些源的任意组合可以在搜索微件的同一实例中一起使用。

示例：

// Default sources[] when sources is not specified
[
  {
    url: "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer",
    singleLineFieldName: "SingleLine",
    outFields: ["Addr_type"],
    name: "ArcGIS World Geocoding Service",
    placeholder: "Adresse",
    resultSymbol: {
       type: "picture-marker",  // autocasts as new PictureMarkerSymbol()
       url: this.basePath + "/images/search/search-symbol-32.png",
       size: 24,
       width: 24,
       height: 24,
       xoffset: 0,
       yoffset: 0
   }
  }
]

// Example of multiple sources[]
let sources = [
{
  url: "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer",
  singleLineFieldName: "SingleLine",
  name: "Custom Geocoding Service",
  placeholder: "Search Geocoder",
  maxResults: 3,
  maxSuggestions: 6,
  suggestionsEnabled: false,
  minSuggestCharacters: 0
}, {
  layer: new FeatureLayer({
    url: "https://services.arcgis.com/DO4gTjwJVIJ7O9Ca/arcgis/rest/services/GeoForm_Survey_v11_live/FeatureServer/0",
    outFields: ["*"]
  }),
  searchFields: ["Email", "URL"],
  displayField: "Email",
  exactMatch: false,
  outFields: ["*"],
  name: "Point FS",
  placeholder: "example: esri",
  maxResults: 6,
  maxSuggestions: 6,
  suggestionsEnabled: true,
  minSuggestCharacters: 0
},
{
  layer: new FeatureLayer({
    outFields: ["*"]
  });
  placeholder: "esri",
  name: "A FeatureLayer",
  prefix: "",
  suffix: "",
  maxResults: 1,
  maxSuggestions: 6,
  exactMatch: false,
  searchFields: [], // defaults to FeatureLayer.displayField
  displayField: "", // defaults to FeatureLayer.displayField
  minSuggestCharacters: 0
}
];

// Set source(s) on creation
let searchWidget = new Search({
  viewModel: { // autocasts as new SearchViewModel()
    sources: []
  }
});

// Set source(s)
let searchWidget = new Search();
let sources = [{ ... }, { ... }, { ... }]; //array of sources
searchWidget.viewModel.sources = sources;

// Add to source(s)
let searchWidget = new Search();
searchWidget.viewModel.sources.push({ ... });  //new source

state Stringreadonly

起始版本：GeoScene API for JavaScript 4.8

微件的当前状态。此属性已从搜索中删除，现在应在 SearchViewModel 中访问。

可能的值："ready"|"disabled"|"searching"|"loading"

默认值：ready

suggestionDelay Number

密钥启动后和发出建议网络请求之前的毫秒级延迟。

默认值：350

suggestions SuggestResult[]readonly

来自建议方法的结果数组。

如果使用已建议加载功能的 2.0 或更高版本的地理编码服务或支持分页的 2.0 或更高版本的要素图层（即 supportsPagination = true。

默认值：null

suggestionsEnabled Boolean

为微件启用建议。

仅当使用具有 [建议加载功能]（https://doc.geoscene.cn/rest/geocode/api-reference/geocoding-suggest.htm）或支持分页的 2.0 或更高版本的要素图层（即 supportsPagination = true。

默认值：true

updating Booleanreadonly

起始版本：GeoScene API for JavaScript 4.16

指示 View 或 Portal 在使用前是否正在加载资源。如果资源仍在加载，则此值为 false。如果资源加载完成，则此值为 true。

默认值：false

view MapView|SceneView

对 MapView 或 SceneView 的引用。设置此选项可将微件链接到特定视图。

默认值：null

方法概述

方法详细信息

clear()

清除当前值、搜索结果、建议结果、图形和图形图层。它还会隐藏任何打开的菜单。

emit(type, event){Boolean}

起始版本：GeoScene API for JavaScript 4.5

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

参数：

type String 事件的名称。

event Object optional 事件负载。

返回：

类型	说明
Boolean	true 如果听取了侦听者的通知

hasEventListener(type){Boolean}

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

参数：

type String 事件的名称。

返回：

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

on(type, listener){Object}

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

参数：

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);
});

search(searchTerm){Promise<SearchResponse>}

根据指定的源，search() 查询要素图层和/或使用任何指定的定位器执行地址匹配并返回适用结果。

参数：

searchTerm String|Geometry|SuggestResult|Number[][] optional 此搜索术语可以是字符串、几何、建议候选对象或 [纬度、经度] 数组。如果提供了几何，则它将反向地理编码（定位器）或查找地址使用几何而不是文本（要素图层）的地址。

返回：

类型	说明
Promise<SearchResponse>	解析后，返回一个包含搜索结果数组的对象。

searchNearby(){Promise<SearchResponse>}

返回当前位置附近的搜索结果。它检查 locationEnabled 是否为 true。如果是这样，并且您的浏览器支持地理位置，它将返回您当前位置附近的搜索结果。

返回：

类型	说明
Promise<SearchResponse>	解析后，返回包含搜索对象数组的 SearchResponse。其中每个对象都包含一个 SearchResult。

suggest(value){Promise<SuggestResponse>}

在活动定位器上执行 suggest() 请求。它还使用微件或传入的微件的当前值。

如果使用已建议加载功能的 2.0 或更高版本的地理编码服务或支持分页的 2.0 或更高版本的要素图层（即 supportsPagination = true。

参数：

value String optional 用于在活动定位器或要素图层上 suggest() 的字符串值。如果没有传入任何内容，则取微件的当前值。

返回：

类型	说明
Promise<SuggestResponse>	解析后，返回包含结果对象数组的 SuggestResponse。这些结果中的每一个都包含一个 SuggestResult。

when(callback, errback){Promise}inner

起始版本：GeoScene API for JavaScript 4.16

when() 可以在更新 SearchViewModel 后使用。此方法采用两个输入参数：callback 函数和 errback 函数。在类的实例加载时执行 callback。如果类的实例无法加载，则执行 errback。

参数：

callback Function optional 解析 promise 时要调用的函数。

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

返回：

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

示例：

// 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
});

类型定义

SearchResponse

解决后，在调用 search 后返回此响应。

属性：

activeSourceIndex Number 从中获取搜索结果的源的索引。

errors Error[] 从搜索结果返回的错误对象的数组。

numResults Number 搜索结果的数量。

searchTerm String 搜索的表达式

results Object[] 表示搜索结果的对象数组。有关结果对象的详细信息，请参阅下面的对象规范表。 规范： results SearchResult[] 搜索结果的数组。 sourceIndex Number 当前所选源的索引。 source Object 所选结果的源。

SearchResult

从搜索返回的结果对象。

属性：

extent Extent 返回要素的范围或边界框。

feature Graphic 从搜索中获得的结果要素或位置。

name String 结果的名称。

SuggestResponse

解决后，在调用 suggest 后返回此响应。

属性：

activeSourceIndex Number 从中获取建议的源的索引。此值是 -1 在选择所有源时。

errors Error[] 从建议结果返回的错误对象数组。

numResults Number 建议结果的数量。

searchTerm String 用于建议的搜索表达式。

results Object[] 表示建议结果的对象数组。有关结果对象的详细信息，请参阅下面的对象规范表。 规范： results SuggestResult[] 建议结果的数组。 sourceIndex Number 当前所选源的索引。 source Object 所选结果的源。

SuggestResult

从建议返回的结果对象。

属性：

key String 与建议结果相关的密钥。

text String 要进行地理编码的建议位置的字符串名称。

sourceIndex Number 当前所选结果的索引。

事件概述

{activeSourceIndex: Number,errors: Error[],numResults: Number,searchTerm: String,results: Object[],results.results: SearchResult[],results.sourceIndex: Number,results.source: Object[]}

{result: Object,result.extent: Extent,result.feature: Graphic,result.name: String,source: Object,sourceIndex: Number}

{activeSourceIndex: Number,errors: Error[],numResults: Number,searchTerm: String,results: Object[],results.results: SuggestResult[],results.sourceIndex: Number,results.source: Object}

事件详细信息

search-clear

从输入框中清除结果或选择新结果时激发。

示例：

let searchWidget = new Search();

searchWidget.viewModel.on("search-clear", function(event){
  console.log("Search input textbox was cleared.");
});

search-complete

在调用 search() 方法时激发并返回其结果。

属性：

activeSourceIndex Number 从中获取搜索结果的源的索引。

errors Error[] 从搜索结果返回的错误对象的数组。

numResults Number 搜索结果的数目。

searchTerm String 搜索的表达式。

results Object[] 表示搜索结果的对象数组。有关结果对象的详细信息，请参阅下面的对象规范表。 规范： results SearchResult[] 包含搜索结果的对象数组。 sourceIndex Number 当前所选源的索引。 source Object[] 所选结果的源。

示例：

let searchWidget = new Search();

searchWidget.viewModel.on("search-complete", function(event){
  // The results are stored in the event Object[]
  console.log("Results of the search: ", event);
});

search-start

在 search() 方法启动时触发。

示例：

let searchWidget = new Search();

searchWidget.viewModel.on("search-start", function(event){
  console.log("Search started.");
});

select-result

选择搜索结果时激发。

属性：

result Object 包含搜索结果的对象。 规范： extent Extent 要缩放到的结果范围。 feature Graphic 要放置在搜索结果位置的图形要素。 name String 地理编码位置的字符串名称。

source Object 所选结果的来源。有关其属性的更多信息，请参阅源。

sourceIndex Number 所选结果源的索引。

示例：

let searchWidget = new Search();

searchWidget.viewModel.on("select-result", function(event){
  console.log("The selected search result: ", event);
});

suggest-complete

在调用 suggest 方法时激发并返回其结果。

属性：

activeSourceIndex Number 从中获取建议的源的索引。此值是 -1 在选择所有源时。

errors Error[] 从建议结果返回的错误对象数组。

numResults Number 建议结果的数量。

searchTerm String 用于建议的搜索表达式。

results Object[] 表示建议结果的对象数组。有关结果对象的详细信息，请参阅下面的对象规范表。 规范： results SuggestResult[] 包含建议结果的对象数组。 sourceIndex Number 当前所选源的索引。 source Object 所选结果的源。

示例：

let searchWidget = new Search();

searchWidget.viewModel.on("suggest-complete", function(event){
  // The results are stored in the event Object[]
  console.log("Results of suggest: ", event);
});

suggest-start

在 suggest() 方法启动时触发。

示例：

let searchWidget = new Search();

searchWidget.viewModel.on("suggest-start", function(event){
  console.log("suggest-start", event);
});