SearchSource

属性列表

属性详细说明

autoNavigate Boolean

选中后是否自动导航到选中的结果。

默认值:true

declaredClass Stringreadonly inherited

起始版本: GeoScene API for JavaScript 4.22

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

filter Object

起始版本: GeoScene API for JavaScript 4.22

用于过滤建议或搜索结果。设置一个优先于 withinViewEnabled 的值。详情请参阅下面的对象规格表。

属性:

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

geometry Geometry optional 建议或搜索结果的过滤器几何形状。使用 定位器 源时， 范围 是唯一受支持的几何体。有关更多信息，请参照 查找候选地址 。

示例代码:

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 。解析后，返回一个包含 搜索结果 数组的对象。

默认值:null

示例:

• Sample - Search widget with custom source

getSuggestions GetSuggestionsParameters

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

默认值:null

示例:

• Sample - Search widget with custom source

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

用来显示结果的符号。

已知限制

此属性仅适用于图层/定位器/源不是地图的一部分时。

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

方法列表

方法详细说明

fromJSON(json){*}static

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

参数:

json Object 实例的 json 表达式，以geoscene 格式显示。

返回值:

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

toJSON(){Object}

将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息，请参阅 使用 fromJSON() 指南。

返回值:

类型	描述
Object	此类实例的 GeoScene portal JSON 格式。

类型定义

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

getResults 属性的函数定义。

参数:

规范:

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

返回值:

类型	描述
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 Widget 的视图。

返回值:

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