PortalItem

属性概述

属性详细信息

access String

指示对此项目的访问级别：private, shared, org, or public.

可能值："private"|"shared"|"org"|"public"

accessInformation String

关于项目源及其版权状况的信息。

apiKey String

起始版本：GeoScene Maps SDK for JavaScript 4.20

用于访问门户项目的授权字符串。API 秘钥可在 GeoScene Developer 仪表盘中生成和管理。API 密钥显式绑定到 GeoScene 帐户；它还用于监视服务的使用情况。

applicationProxies Object[]readonly

起始版本：GeoScene Maps SDK for JavaScript 4.8

包含一组对象，含有增值平台服务的代理信息。这在使用高级和订阅服务的注册应用程序中最为普遍，例如路径分析和分析服务。

属性

sourceUrl String 高级地图服务图层的 URL。

proxyUrl String 源 URL 的代理 URL。

proxyId String 在 GeoScene Online 或 GeoScene Enterprise Portal 中注册的代理 ID。

avgRating Number

平均评级。使用 "Bayesian average” 的加权平均值。

categories String[]

起始版本：GeoScene Maps SDK for JavaScript 4.8

在项目上设置的组织类别的数组。

created Date

创建项目的日期。

culture String

项目的区域设置信息（语言和国家/地区）。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

description String

项目的详细说明。

extent Extent

项目的地理范围或边界矩形。

groupCategories String[]

起始版本：GeoScene Maps SDK for JavaScript 4.8

在项目上设置的群组类别的数组。这与 categories 略有不同，因为它只返回从 PortalGroup.queryItems 返回的组内容中的类别。

id String

项目的唯一 id。您通常可以在其 url 中找到项目的 id。

示例

// to access the portal item at this url
// https://www.geosceneonline.cn/geoscene/webapps/item?id=17bb415cb14f4f34ab4ea13791882f4d
let item = new PortalItem({
  id: "17bb415cb14f4f34ab4ea13791882f4d"
});

isLayer Booleanreadonly

指定是否可以使用 Layer.fromPortalItem() 从此项目创建图层。

示例

if (item.isLayer) {
  Layer.fromPortalItem({
    portalItem: item
  }).then(addLayerToMap);
}

itemControl Stringreadonly

是否可以更新或删除项目。

可能值	描述
admin	可以更新或删除该项目。
update	该项目可以更新，但不能删除。
null	该项目无法更新或删除。

可能值："admin"|"update"|"null"

itemPageUrl Stringreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.25

门户项目页面的 URL。

itemUrl Stringreadonly

项目的 URL。

licenseInfo String

与项目相关的许可或限制信息。

loaded Booleanreadonly

指示项目的资源是否已从门户加载。如果为 true，则可访问对象的所有属性。

默认值：false

loadError Errorreadonly

如果加载时发生错误，则返回 Error 对象。

默认值：null

loadStatus Stringreadonly

表示 load 操作的状态。

值	描述
not-loaded	对象的资源尚未加载。
loading	对象的资源当前正在加载。
loaded	对象的资源已加载且未出现错误。
failed	无法加载对象的资源。有关更多详情，请参阅 loadError。

可能值："not-loaded"|"loading"|"failed"|"loaded"

默认值：not-loaded

loadWarnings Object[]readonly

加载时发生的警告列表。

modified Date

项目上次修改的日期。

name String

项目的名称。

numComments Number

对项目的评论数。

numRatings Number

项目上的评级数。

numViews Number

项目的浏览次数。

owner String

拥有此项目的用户的用户名。

ownerFolder String

起始版本：GeoScene Maps SDK for JavaScript 4.12

所有者存储该项目的文件夹的 ID。这仅返回给项目所有者或组织管理员。

portal Portalautocast

包含项目的门户。它使用 Portal.getDefault()。这又从 config.portalUrl 获取 URL。我们建议使用 config.portalUrl 替代此属性。如果需要使用多个门户实例，请直接在 PortalItem 中设置门户的 url，或在将它们传递到 PortalItem.portal 属性之前创建单独的门户实例。这两个示例如下所示：

Layer.fromPortalItem({
  portalItem: {
    id: "e691172598f04ea8881cd2a4adaa45ba",
    // autocastable to Portal
    portal: {
      url: "https://thePortalUrl"
    }
  }
});

let portalA = new Portal({
  url: "https://www.exampleA.com/geoscene" // First instance
});

let portalB = new Portal({
  url: "https://www.exampleB.com/geoscene" // Second instance
});

let item = new PortalItem({
  id: "e691172598f04ea8881cd2a4adaa45ba",
  portal: portalA // This loads the first portal instance set above
});

item.load();

screenshots String[]

起始版本：GeoScene Maps SDK for JavaScript 4.8

字符串 URL 数组。这些 URL 应指向与应用程序相关的屏幕截图。

示例值可以类似于 "screenshots/Basic.png"。

默认值：null

size Number

项目大小 (以字节为单位)。

snippet String

对项目的摘要描述。

sourceJSON Object

起始版本：GeoScene Maps SDK for JavaScript 4.13

加载 PortalItem 时，用于创建属性值的 JSON。虽然最常用的属性直接在 PortalItem 类上公开，但这提供了对门户项目返回的所有信息的访问。如果在使用较旧版本的 API 构建的应用程序中工作，且需要访问较新版本的门户项目属性，则此属性非常有用。

tags String[]

描述项目的用户定义标签。

thumbnailUrl Stringreadonly

用于项目缩略图的 URL。

另请参阅

• getThumbnailUrl()

title String

项目的标题。这是显示给用户的名称，可用于引用项目。每个项目都必须有一个标题。

type String

此项目的 GIS 内容类型。示例类型包括 web 地图、地图服务、Shapefile 以及 web 制图应用程序。请参阅 GeoScene REST API 项目和项目类型参考，以了解项目类型层次结构。

示例

portalItem.type = "Web Map";

portalItem.type = "Web Mapping Application";

typeKeywords String[]

描述此项目内容类型的关键字。

url String

此项目的服务 URL。仅 "Feature Service"、"Map Service"、"Image Service"、"Scene Service"、"WMS" 和 "KML” 等特定图层项目类型具有服务 URL。

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

addRating(rating){Promise<PortalRating>}

为可访问项目添加评级。

参数

rating Number|PortalRating 为该项目设置的评级。评级必须是介于 1.0 和 5.0 之间的数字。

返回

类型	描述
Promise<PortalRating>	解析后，将返回 PortalRating。

addResource(resource, content, options){Promise}

起始版本：GeoScene Maps SDK for JavaScript 4.16

向门户项目添加一个新的资源。

参数

规范

resource PortalItemResource 要添加到门户项目的资源。

content Blob 资源内容。

options Object optional 具有以下属性的对象。 规范 access String optional 默认值："inherit" 指定对资源的访问级别。默认值为 "inherit"，这会使资源具有与所属项目相同的访问级别。 可能值："inherit"|"private" signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise	解析时，返回 PortalItemResource。

示例

// The following snippet assumes you have an existing portal item instance
// that you are allowed to modify

// An example of an object that we would like to store as a resource
const definition = { type: "world", description: "A world definition" };

const resource = new PortalItemResource({ path: "definitions/world.json" });

// Resource content is always passed as a blob. Define a blob that contains our definition
// in JSON encoding
const content = new Blob([JSON.stringify(definition)], { type: "application/json" });

portalItem.addResource(resource, content)
  .then(function () {
    console.log("Successfully added resource", resource.url);
  })
  .catch(function (error) {
    console.error("Failed to add resource", error);
  });

cancelLoad()

如果 load() 操作已在进行中，则取消它。

clone(){PortalItem}

起始版本：GeoScene Maps SDK for JavaScript 4.12

创建此对象的克隆。这是一个除了 portal 属性的深度克隆。

返回

类型	描述
PortalItem	调用此方法的 PortalItem 实例的克隆。

deleteRating(){Promise}

删除指定项目的评分。

返回

类型	描述
Promise	成功删除评分时解析。

destroy()

起始版本：GeoScene Maps SDK for JavaScript 4.17

销毁门户项目以及任何相关联的资源，包括其关联的 portal。一旦门户项目损坏，则无法再使用这些内容。为防止这些对象被销毁，请在调用 destroy() 之前将它们从门户项目中移除。

// unset the portal from the portal item so that it is not destroyed
const portal = portalItem.portal;
portalItem.portal = null;

// destroy the portal item and any remaining associated resources
portalItem.destroy();

另请参阅

• Basemap.destroy()
• Map.destroy()
• WebMap.destroy()
• WebScene.destroy()
• Ground.destroy()
• Layer.destroy()

fetchData(responseType, options){Promise}

以 responseType 中指定的格式请求 PortalItem。

参数

responseType String optional 默认值： json 响应的格式。 可能值："json"|"xml"|"text"|"blob"|"array-buffer"|"document"

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise	解析时，返回请求的数据。

fetchRating(options){Promise<PortalRating>}

返回对项目做出的评分 (如果存在的话)。

参数

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<PortalRating>	解析后，将返回 PortalRating。

fetchRelatedItems(params, options){Promise<PortalItem[]>}

获取门户项目的特定关系类型的所有相关项目。如果关系的方向不明确，则可以指定可选方向。否则，服务将尝试推断它。

参数

params Object 有关可作为此对象中的属性传递的参数，请参阅下面的对象规范表。 规范 relationshipType String 两个项目之间的关系类型。有关类型的完整列表，请参阅关系类型 。 direction String 关系的方向。可以是 forward (从原点到目的地) 或 reverse (从目的地到原点)。 可能值："forward"|"reverse"

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<PortalItem[]>	解析为相关 PortalItem 的数组。

示例

let queryParam = {
   relationshipType: "Service2Data"
};

portalItem.fetchRelatedItems(queryParam).then(function(results){
   console.log("related portal item", results);
});

fetchResources(params, options){Promise<FetchResourcesResult>}

起始版本：GeoScene Maps SDK for JavaScript 4.16

检索对所有门户项目资源的引用。

参数

params FetchResourcesParams optional 用于检索门户项目资源的获取参数。

options Object optional 具有以下属性的其他选项。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<FetchResourcesResult>	使用包含项目资源的对象进行解析。

示例

portalItem.fetchResources().then(function(result) {
   console.log("next start index: ", result.nextStart);

   result.resources.forEach(function(item) {
     console.log("resource:", item.resource.path, "size:", item.size);
   });
});

fromJSON(json){*}static

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

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

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

getThumbnailUrl(width){String}

起始版本：GeoScene Maps SDK for JavaScript 4.4

获取项目缩略图的 URL。

可用宽度大小：200、400、800 和 2400。

参数

width Number optional 所需的图像宽度。

返回

类型	描述
String	缩略图的 URL。

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

isFulfilled(){Boolean}

isFulfilled() 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。如果满足，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已完成 (已解决或已拒绝)。

isRejected(){Boolean}

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}

isResolved() 可用于验证创建类的实例是否已解决。如果已解决，则返回 true。

返回

类型	描述
Boolean	指示创建类的实例是否已解决。

load(signal){Promise}

加载此类引用的资源。如果视图是使用地图实例构造的，则此方法会自动为 View 及其在 Map 中引用的所有资源执行。

开发人员在访问不会在 View 中加载的资源时，必须调用此方法。

load() 方法仅在第一次调用时触发资源的加载。随后的调用将返回相同的 promise。

可以提供一个 signal 来停止对 Loadable 实例加载状态感兴趣。当信号中止时，实例不会停止其加载过程，只有 cancelLoad 可以中止它。

参数

signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise	资源已加载时解析。

reload(){Promise<PortalItem>}

起始版本：GeoScene Maps SDK for JavaScript 4.14

从门户重新加载已加载项目的属性。

返回

类型	描述
Promise<PortalItem>	门户项目的属性重新加载时解析。

removeAllResources(options){Promise}

起始版本：GeoScene Maps SDK for JavaScript 4.16

从门户项目中移除所有资源。

参数

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise	在成功移除所有资源时解析。

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

removeResource(resource, options){Promise}

起始版本：GeoScene Maps SDK for JavaScript 4.16

从门户项目中移除资源。

参数

resource PortalItemResource 要从门户项目中移除的资源。

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise	在移除操作完成后解析。

toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。

update(params){Promise<PortalItem>}

将项目的属性更新到门户，并可以选择更新其数据。

参数

params Object optional 有关可作为此对象中的属性传递的参数，请参阅下面的对象规范表。 规范 data String|Object optional 可选的。用于将项目表示的数据流式传输到客户端的组件。

返回

类型	描述
Promise<PortalItem>	门户项目的属性更新时解析。

updateThumbnail(params){Promise<PortalItem>}

起始版本：GeoScene Maps SDK for JavaScript 4.5

更新门户上项目的缩略图。

参数

规范

params Object 有关可作为此对象中的属性传递的参数，请参阅下面的对象规范表。 规范 thumbnail Blob|String URL、数据 URI、Blob 或文件。可接受的格式为 GIF、JPG 和 PNG。 filename String optional thumbnailUrl 中用于缩略图的文件名。

返回

类型	描述
Promise<PortalItem>	门户项目的缩略图更新时解析。

when(callback, errback){Promise}

起始版本：GeoScene Maps SDK for JavaScript 4.6

一旦创建了类的实例，就可以使用when() 。此方法接受两个输入参数：callback 函数和 errback 函数。callback 在类的实例加载时执行。errback 在类的实例无法加载时执行。

参数

callback Function optional 当 promise 解决时调用的函数。

errback Function optional 当 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
});

类型定义

FetchResource

fetchResources() 结果中返回的资源引用。

属性

resource PortalItemResource 获取的资源。

created Date 创建资源的时间。

size Number 资源的大小 (以字节为单位)。

FetchResourcesParams

使用 fetchResources() 获取门户项目资源时使用的参数。

属性

num Number optional 默认值：10 要包含在结果集响应中的最大结果数。允许的最大值为 100。与 num 属性结合使用的 start 属性可用于对搜索结果进行分页。

start Number optional 默认值：1 结果集响应中第一个条目的索引。索引从 1 开始。start 属性和 num 属性可用于对搜索结果进行分页。

sortOrder String optional 默认值：asc 对结果进行排序的顺序。 可能值 描述 asc 按升序对结果进行排序。 desc 按降序对结果进行排序。 可能值："asc"|"desc"

sortField String optional 默认值：created 用于对结果进行排序的字段。 可能值："created"|"size"|"type"

FetchResourcesResult

当 fetchResources() 承诺解决时返回的对象。

属性

resources FetchResource[] 获取的资源。

nextStart Number 下一个条目索引（如果当前结果集未包含所有结果）。

total Number 结果的总数。