TableList 微件提供了一种显示与 Map 关联的表列表的方法。它旨在与要素图层表一起使用。
如果地图包含要素图层表,则这些表将显示在微件中。还可将表添加到地图的 tables 集合中。map 属性中引用的任何表都将显示在微件中。如果不确定图层是否为表,请检查要素图层的 isTable 属性。
ListItem API 提供了对每个表的访问,允许开发人员配置与表相关的操作,并允许开发人员向与表相关的项目添加内容。
已知限制 TableList 微件不支持 web 场景。
const tableList = new TableList({
map: map, // takes any tables associated with the map and displays in widget
selectionEnabled: true,
listItemCreatedFunction: function(event) {
let item = event.item;
item.actionsSections = [
{
title: "Show table",
className: "geoscene-icon-table",
id: "table",
type: "toggle"
},
{
title: "Layer information",
className: "geoscene-icon-description",
id: "information"
}
]
});
构造函数
属性概述
名称 | 类型 | 描述 | 类 |
---|---|---|---|
String|HTMLElement | 包含微件的 DOM 元素的 ID 或节点。 更多详情 | Widget | |
String | 类的名称。 更多详情 | Accessor | |
String | 微件的默认 CSS 图标类。 更多详情 | iconClass | |
String | 创建微件时分配给微件的唯一 ID。 更多详情 | Widget | |
String | 微件的默认的标注。 更多详情 | TableList | |
ListItemCreatedHandler | 指定访问每个 ListItem 的函数。 更多详情 | TableList | |
Map|WebMap | 对包含表格的地图的引用。 更多详情 | TableList | |
Boolean | 指示用户一次是否可以选择多个列表项。 更多详情 | TableList | |
Collection<ListItem> | 所选 ListItem 的集合,表示用户选择的表列表项。 更多详情 | TableList | |
Boolean | 指示用户是否可以选择列表项。 更多详情 | TableList | |
Collection<ListItem> | 微件中显示的表 ListItem 的集合。 更多详情 | TableList | |
TableListViewModel | 此微件的视图模型。 更多详情 | TableList | |
Boolean | 指示微件是否可见。 更多详情 | Widget | |
VisibleElements | 微件中显示的可见元素。 更多详情 | TableList |
属性详细信息
-
-
包含微件的 DOM 元素的 ID 或节点。此属性只能设置一次。以下示例都是使用微件时的有效用例。
示例// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>
// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
类的名称。声明的类名称格式化为
geoscene.folder.className
。
-
iconClass Stringinner
-
微件的默认 CSS 图标类。
-
创建微件时分配给微件的唯一 ID。如果不是由开发人员设置的,它将默认为容器 Id,或者如果没有容器 ID,则将自动生成。
-
label String
-
微件的默认的标注。
-
listItemCreatedFunction ListItemCreatedHandler
-
指定访问每个 ListItem 的函数。每个列表项都可根据其可修改的属性进行修改。可以使用 ListItem 的 actionsSections 属性将操作添加到列表项。
示例const tableList = new TableList({ map: map, selectionEnabled: true, listItemCreatedFunction: function(event) { let item = event.item; item.actionsSections = [ [ { title: "Go to full extent", className: "geoscene-icon-zoom-out-fixed", id: "full-extent" } ] ]; } });
-
对包含表格的地图的引用。设置此属性以访问地图中的基础表。
- 另请参阅
示例Layer.fromPortalItem({ // Loads a layer (table) from a portal item portalItem: { // autocasts new PortalItem() id: "add portal item id" } }).then(function(layer) { // Load the layer layer.load().then(function() { // Check if the layer is a table if (layer.isTable) { map.tables.add(layer); console.log(map.tables); } }); }); const tableList = new TableList({ map: map // map contains tables collection });
-
multipleSelectionEnabled Boolean
-
指示用户一次是否可以选择多个列表项。必须将 SelectionEnabled 设置为
true
,此属性才能对微件产生影响。所选项目在 selectedItems 属性中可用。
- 默认值:false
- 另请参阅
示例tableList.selectionEnabled = true; tableList.multipleSelectionEnabled = true;
-
selectedItems Collection<ListItem>
-
所选 ListItem 的集合,表示用户选择的表列表项。
- 另请参阅
-
selectionEnabled Boolean
-
指示用户是否可以选择列表项。通过使用鼠标或触摸屏进行拖放,或者使用键盘上的箭头,可以在列表中对所选项目进行重新排序。
所选项目在 selectedItems 属性中可用。
- 默认值:false
- 另请参阅
示例tableList.selectionEnabled = true;
-
tableItems Collection<ListItem>readonly
-
微件中显示的表 ListItem 的集合。
-
viewModel TableListViewModelautocast
-
此微件的视图模型。此类包含控制此微件行为的所有逻辑。请参阅 TableListViewModel 类来访问微件上的所有属性和方法。
-
指示微件是否可见。
如果为
false
,微件将不再呈现在 web 文档中。这可能会影响文档中其他元素或微件的布局。例如,如果此微件是与视图 UI 右上角关联的三个微件中的第一个,则当此微件不可见时,其他微件将重新定位。有关更多信息,请参阅 CSS display 值"none"
。- 默认值:true
示例// Hides the widget in the view widget.visible = false;
-
visibleElements VisibleElements起始版本:GeoScene Maps SDK for JavaScript 4.25
-
微件中显示的可见元素。此属性提供了打开/关闭微件显示的各个元素的能力。
示例tableList.visibleElements = { statusIndicators: false, errors: true };
方法概述
名称 | 返回值类值 | 描述 | 类 |
---|---|---|---|
添加一个或多个与对象的生命周期相关联的句柄。 更多详情 | Accessor | ||
String | 用于为微件的 | Widget | |
销毁微件实例。 更多详情 | Widget | ||
Boolean | 在实例上触发事件。 更多详情 | Widget | |
Boolean | 指示实例上是否存在与提供的事件名称相匹配的事件监听器。 更多详情 | Widget | |
Boolean | 如果存在指定的句柄组,则返回 true。 更多详情 | Accessor | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Object | 在实例上注册事件处理程序。 更多详情 | Widget | |
添加一个或多个与微件的生命周期相关联的句柄。 更多详情 | Widget | ||
此方法主要由开发人员在实现自定义微件时使用。 更多详情 | Widget | ||
移除对象拥有的句柄组。 更多详情 | Accessor | ||
Object | 此方法主要由开发人员在实现自定义微件时使用。 更多详情 | Widget | |
立即将微件渲染到 DOM。 更多详情 | Widget | ||
此方法主要由开发人员在实现自定义微件时使用。 更多详情 | Widget | ||
触发 trigger-action 事件并执行给定的操作或操作切换。 更多详情 | TableList | ||
Promise | 一旦创建了类的实例,就可以使用 | Widget |
方法详细说明
-
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() 进行删除。如果未提供键,则句柄将被添加到默认组。
-
用于为微件的
class
属性构建值的实用方法。这有助于简化 CSS 类设置。参数repeatable 类名称。
返回类型 描述 String 计算的类名。 - 另请参阅
示例// .tsx syntax showing how to set CSS classes while rendering the widget render() { const dynamicIconClasses = { [CSS.myIcon]: this.showIcon, [CSS.greyIcon]: !this.showIcon }; return ( <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} /> ); }
-
destroy()inherited
-
销毁微件实例。
-
在实例上触发事件。仅当创建此类的子类时,才应使用此方法。
参数type String事件的名称。
event Objectoptional事件有效负载。
返回类型 描述 Boolean 如果监听器收到通知,则为 true
-
起始版本: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"); }
-
起始版本:GeoScene Maps SDK for JavaScript 4.19
-
isFulfilled()
可用于验证创建类的实例是否已完成 (已解决或已拒绝)。如果满足,则返回true
。返回类型 描述 Boolean 指示创建类的实例是否已完成 (已解决或已拒绝)。
-
起始版本:GeoScene Maps SDK for JavaScript 4.19
-
isRejected()
可用于验证创建类的实例是否被拒绝。如果被拒绝,则返回true
。返回类型 描述 Boolean 指示创建类的实例是否已被拒绝。
-
起始版本:GeoScene Maps SDK for JavaScript 4.19
-
isResolved()
可用于验证创建类的实例是否已解决。如果已解决,则返回true
。返回类型 描述 Boolean 指示创建类的实例是否已解决。
-
在实例上注册事件处理程序。调用此方法将事件与监听器挂钩。
参数要侦听的事件或者事件数组。
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); });
-
own(handleOrHandles)inherited起始版本:GeoScene Maps SDK for JavaScript 4.24
-
添加一个或多个与微件的生命周期相关联的句柄。当微件被销毁时,将移除句柄。
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
参数handleOrHandles WatchHandle|WatchHandle[]微件销毁后,标记为要移除的句柄。
-
postInitialize()inherited
-
此方法主要由开发人员在实现自定义微件时使用。在微件准备好渲染后执行。
-
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");
-
此方法主要由开发人员在实现自定义微件时使用。它必须由子类实现以进行渲染。
返回类型 描述 Object 渲染的虚拟节点。
-
renderNow()inherited
-
立即将微件渲染到 DOM。
-
scheduleRender()inherited
-
此方法主要由开发人员在实现自定义微件时使用。计划微件渲染。此方法对于影响 UI 的更改非常有用。
-
triggerAction(action, item)
-
触发 trigger-action 事件并执行给定的操作或操作切换。
参数action ActionButton|ActionToggle要执行的操作。
item ListItem与操作关联的项目。
-
起始版本:GeoScene Maps SDK for JavaScript 4.19
-
一旦创建了类的实例,就可以使用
when()
。此方法接受两个输入参数:callback
函数和errback
函数。callback
在类的实例加载时执行。errback
在类的实例无法加载时执行。参数callback Functionoptional当 promise 解决时调用的函数。
errback Functionoptional当 promise 失败时执行的函数。
返回类型 描述 Promise 为 callback
结果返回一个新的 promise。示例// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.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 });
类型定义
-
ListItemCreatedHandler(event)
-
listItemCreatedFunction 属性的函数定义。
参数event Object包含由 TableList 创建的列表项的对象。
规范item ListItem由 TableList 创建的列表项。您可以修改此项目的属性以自定义列表项目的文本、操作和可见性。有关详细信息,请参阅 listItemCreatedFunction 的文档。
-
VisibleElements
-
微件中显示的可见元素。这提供了打开/关闭微件显示的各个元素的能力。
事件概述
名称 | 类型 | 描述 | 类 |
---|---|---|---|
{action: ActionButton,ActionToggle,item: ListItem} |
用户在 TableList 微件内单击操作或操作切换后触发。 更多详情 |
TableList |
事件详细说明
-
trigger-action
-
- 属性
-
action ActionButton|ActionToggle
用户单击的操作。
item ListItem与操作关联的项目。
示例tableList.on("trigger-action", function (event) { let item = event.item; // Capture the action id. let id = event.action.id; if (id === "information") { window.open(item.layer.url); } });