SearchResultRenderer

AMD: require(["geoscene/widgets/Search/SearchResultRenderer"], (SearchResultRenderer) => { /* 代码 */ });
ESM: import SearchResultRenderer from "@geoscene/core/widgets/Search/SearchResultRenderer";
类: geoscene/widgets/Search/SearchResultRenderer
继承于: SearchResultRenderer Widget Accessor
起始版本: GeoScene API for JavaScript 4.22

SearchResultRenderer 呈现 Search widget 结果,并允许展开 DOM 元素来显示可选匹配项。在 Search widget 更多结果 链接中出现了这些替代匹配。

所需要的属性: 视图视图模型

有关获得对 widget 样式的完全控制的信息,请参阅样式主题。

示例:

构造函数

new SearchResultRenderer(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
String|HTMLElement更多信息

包含 widget 的 DOM 元素的 ID 或者节点。

更多信息Widget
String更多信息

类名。

更多信息Accessor
String更多信息

创建部件时分配给部件的唯一ID。

更多信息Widget
String更多信息

 widget 的标签。

更多信息Widget
Boolean更多信息

表示是否在搜索结果的弹出窗口中显示更多结果 链接。

更多信息SearchResultRenderer
SearchViewModel更多信息

Search widget 的视图模型。

更多信息SearchResultRenderer
Boolean更多信息

是否显示 widget 。

更多信息Widget

属性详细说明

包含 widget 的 DOM 元素的 ID 或者节点 。此属性只能设置一次。以下示例都是使用 widget 时的有效用例。

示例代码:
// 在运行时创建HTML div元素,并将其设置为小部件的容器
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});
// 创建 HTML div 元素 并且设置为widget的容器

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML 标签
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>
// 在添加到视图的UI时指定widget
const basemapGallery = new BasemapGallery({
  view: view
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});
declaredClass Stringreadonly inherited
起始版本: GeoScene API for JavaScript 4.22

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

创建部件时分配给部件的唯一ID。 如果不是由开发人员设置的,它将默认为容器ID 或者如果没有容器ID,那么它将自动生成

起始版本: GeoScene API for JavaScript 4.22

 widget 的标签。

当 widget 被另一个控件控制时(例如 Expand),这个属性非常有用。

showMoreResultsOpen Boolean

表示是否在搜索结果的弹出窗口中显示更多结果 链接。值为 true将不会在弹出窗口中显示链接。

默认值:false
示例代码:
const searchResult = new SearchResultRenderer({
  view: view,
  container: document.createElement("div"),
  showMoreResultsOpen: true,
  viewModel: searchWidget.viewModel
});

// Add the result to the bottom-right corner of the view
view.ui.add(searchResult, {
  position: "bottom-right"
});

Search 小部件的视图模型。这是一个包含所有未定义逻辑的类,请参阅 SearchViewModel 类来访问小部件上的所有属性和方法。

示例代码:
const searchResult = new SearchResultRenderer({
  view: view,
  container: document.createElement("div"),
  showMoreResultsOpen: true,
  viewModel: searchWidget.viewModel
});

// Add the result to the bottom-right corner of the view
view.ui.add(searchResult, {
  position: "bottom-right"
});
visible Boolean inherited

是否显示 widget 

如果为false,小部件将不再呈现在web文档中。这可能会影响文档中其他元素或小部件的布局。例如,如果此小部件是与 view UI,右上角关联的三个小部件中的第一个,那么当此小部件不可见时,其他小部件将重新定位。 有关更多信息,请参阅 CSS display"none"

默认值:true
示例代码:
// 在view中隐藏widget
widget.visible = false;

方法列表

展示继承方法 隐藏继承方法
属性 返回值类型 描述
String更多信息

用于为 widgets 的class属性构建值的实用方法

更多信息Widget
更多信息

销毁 widget 实例。

更多信息Widget
Boolean更多信息

在实例上触发事件。

更多信息Widget
Boolean更多信息

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

更多信息Widget
Boolean更多信息

isFulfilled() 可用于验证创建类的实例是否已完成(无论成功或失败)。

更多信息Widget
Boolean更多信息

isRejected() 可用于验证创建类的实例是否失败。

更多信息Widget
Boolean更多信息

isResolved() 可用于验证创建类的实例是否成功。

更多信息Widget
Object更多信息

在实例上注册事件处理程序。

更多信息Widget
更多信息

Widget 拆卸帮手。

更多信息Widget
更多信息

这种方法主要由开发人员在实现自定义 widget 时使用。

更多信息Widget
Object更多信息

这种方法主要由开发人员在实现自定义 widget 时使用。

更多信息Widget
更多信息

立即将 widget 渲染到 DOM 。

更多信息Widget
更多信息

这种方法主要由开发人员在实现自定义 widget 时使用。

更多信息Widget
Promise更多信息

when() 创建类的实例后,会被执行一次。

更多信息Widget

方法详细说明

classes(classNames){String}inherited
起始版本: GeoScene API for JavaScript 4.22

用于为widget的类属性构建值的实用方法class 属性. 这有助于简化CSS类设置.

undefined
参数:
classNames String|String[]|Object
repeatable

class 类名称

返回值:
类型 描述
String 计算的类名。
示例:
示例代码:
// .tsx语法显示在渲染widget时如何设置CSS classs .

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
destroy()inherited

销毁 widget 实例。

emit(type, event){Boolean}inherited
起始版本: GeoScene API for JavaScript 4.22

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

参数:
type String

事件名称

event Object
optional

事件负载。

返回值:
类型 描述
Boolean 如果侦听器收到通知,则为true 
hasEventListener(type){Boolean}inherited

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

参数:
type String

事件名称

返回值:
类型 描述
Boolean 如果类支持输入事件,则返回 true。
isFulfilled(){Boolean}inherited
起始版本: GeoScene API for JavaScript 4.22

isFulfilled() 可用于验证创建类的实例是否已完成(无论成功或失败)。 如果已完成,将会返回true

返回值:
类型 描述
Boolean 指示创建类的实例是否已完成(无论成功或失败)。
isRejected(){Boolean}inherited
起始版本: GeoScene API for JavaScript 4.22

isRejected() 可用于验证创建类的实例是否失败。 如果失败,将会返回 true

返回值:
类型 描述
Boolean 指示是否已拒绝创建类的实例。
isResolved(){Boolean}inherited
起始版本: GeoScene API for JavaScript 4.22

isResolved() 可用于验证创建类的实例是否成功。 如果成功, 将会返回 true

返回值:
类型 描述
Boolean 指示是否已解析创建类的实例。
on(type, listener){Object}inherited

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

参数:

要监听的event 或者事件数组

listener Function

事件触发时要调用的函数

返回值:
类型 描述
Object 返回一个remove() 方法的事件处理程序,该方法用以停止侦听事件。
属性 类型 描述
remove Function 当被调用时,从事件中移除监听器。
示例代码:
view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});
own(handles)inherited

Widget 拆卸助手。当 widget 被销毁时,添加到它的任何句柄都将被自动删除。

参数:

widget 销毁后标记为删除的句柄。

postInitialize()inherited

这种方法主要由开发人员在实现自定义 widget 时使用。 在 widget 准备好后执行。

render(){Object}inherited

这种方法主要由开发人员在实现自定义 widget 时使用。 它必须由子类实现以进行渲染。

返回值:
类型 描述
Object 渲染虚拟节点。
renderNow()inherited

立即将 widget 渲染到 DOM 。

scheduleRender()inherited

这种方法主要由开发人员在实现自定义 widget 时使用。 计划小部件渲染。此方法对于影响UI的更改非常有用。

when(callback, errback){Promise}inherited
起始版本: GeoScene API for JavaScript 4.22

when() 创建类的实例后,会被执行一次。该方法接受两个参数: callback 函数和 errback 函数。 callback 在类的实例加载时执行。 如果类的实例无法加载,则执行 errback

参数:
callback Function
optional

当 Promise 成功时,该函数将被调用。

errback Function
optional

当 Promise 失败时,该函数将被调用。

返回值:
类型 描述
Promise 返回回调结果的新promise,可用于 chain additional functions.
示例代码:
// 尽管此示例使用 BasemapGallery widget,但任何作为 Promise 的类实例都可以以相同的方式使用 when()
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // 当 Promise resolved 时,函数将被执行
}, function(error){
  // 当 Promise 通过 rejected 抛错时,这个函数将被执行
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.