npm 包 @bentley/presentation-common 使用教程

简介

@bentley/presentation-common 是由 Bentley Systems 的前端团队开发的一个 npm 包，用于在前端项目中呈现 iModel 数据。

安装

--- ------- ----------------------------

使用

------ - ------------ - ---- -------------------------------

----- ---- - ----- -- -- -
  -- --- ------------
  ----- -------------------------
    -- ----
  ---
  
  -- ----
  ----- ------ - ----- -------------------------------------------------
  
  --------------------
-

-------

在使用之前，我们需要先初始化 presentation。在初始化 presentation 时，我们需要传入一些配置信息，例如 iModel 的文件路径、存储 Token 的客户端等等。具体配置项可以在配置文件中进行设置。配置文件的完整示例如下：

------ ------- -
  --------- ------                -- -- ----- - ------ --
  ------------ ------             -- ------ --------
  ------------- --------          -- ------ ----
  ------ ------                    -- -----
  ---------- -------------------------------------------     -- --------- --
  ----------- --------------------------          -- ------ ----
  ---------------- -----           -- ------ -----
  -------------- -----             -- ------
  ---------- ------                -- -- --
  ------------ ------              -- ---
  ----------- ------               -- ------ --
-

常用方法

  • initialize(options: PresentationInitOptions): Promise<void>：初始化 presentation
  • dispose(): void：销毁 presentation
  • getClient(): PresentationRpcInterface：获取 presentation 客户端
  • readNode(nodeId: string, requestContext?: ClientRequestContext): Promise<NodeJSON>：读取一个节点
  • readNodePaths(paths: NodePathElement[][], markedIndex?: number, requestContext?: ClientRequestContext): Promise<NodePathJSON[]>：读取多个节点路径
  • readPagedNodePaths(parentNodeId: string, paging: PagingOptions, requestContext?: ClientRequestContext): Promise<Result<NodePathElement[]>[]>：分页读取子节点路径
  • getContentDescriptor(requestOptions: ContentRequestOptions, requestContext?: ClientRequestContext): Promise<DescriptorJSON | undefined>：获取内容描述器
  • getContentSetSize(requestOptions: ContentRequestOptions, requestContext?: ClientRequestContext): Promise<number>：获取内容集大小
  • getContent(requestOptions: ContentRequestOptions, pageOptions?: PageOptions, requestContext?: ClientRequestContext): Promise<Result<ContentJSON>>：获取内容

示例

-- -------
----- -------------- - -----------------------------
----- ---------- - ----- ------------------------------------------------
  ------- -------                    -- ------ --
  ---------- ------------             -- ------- --
  ------------ -------                -- ----
  ----- --- ----------------------------------     -- ----
-- ----------------
------------------------
-- ---------
----- -------------- - -----------------------------
----- -------------- - ----- ---------------------------------------------
  ------- -------                    -- ------ --
  ---------- ------------             -- ------- --
  ------------ -------                -- ----
  ----- --- ----------------------------------     -- ----
-- ----------------

--- ---- ---------- - -- ---------- - --------------- ---------- -- --- -
  ----- ------ - ----- --------------------------------------
    ------- -------                    -- ------ --
    ---------- ------------             -- ------- --
    ------------ -------                -- ----
    ----- --- ----------------------------------     -- ----
  -- - ------ ----------- ----- -- -- ----------------
  
  --------------------
-

总结

@bentley/presentation-common 提供了一系列方便的 API，可以帮助我们在前端项目中呈现 iModel 数据。通过本文的介绍，我们可以学习到如何正确地使用它，并在实际项目中得到应用。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/155449

阅读全文

猜你喜欢

  • npm 包 @betty-blocks/cli 使用教程

    前言 随着前端技术的不断发展，越来越多的前端工具正在出现。@betty-blocks/cli 是一个基于 Node.js 的命令行工具，旨在帮助前端开发者更快、更便捷地进行项目搭建。

    5 年前
  • npm 包 @bcm-energy/oui-share 使用教程

    简介 在前端开发中，我们经常需要使用一些可重用的组件或者函数库。而 npm 是 JavaScript 社区最流行的包管理工具之一，通过 npm 我们可以方便地下载和安装其他开发者分享的代码包。

    5 年前
  • npm 包 @adobe/aio-lib-files 使用教程

    @adobe/aio-lib-files 是一个 Node.js 文件操作库，提供了针对 Adobe I/O File System API 的简单易用的封装。它帮助开发者轻松地在应用程序中读取和写入...

    5 年前
  • npm 包 @adobe/adobeio-cna-cloud-storage 使用教程

    前言 @adobe/adobeio-cna-cloud-storage 是一个由 Adobe 开源的npm 包，它提供了基于云存储服务的前端开发的工具和功能。本文将详细介绍 @adobe/adobei...

    5 年前
  • npm 包 @crawly/grasshopper 使用教程

    1. 简介 @crawly/grasshopper 是一个 Node.js 爬虫框架，提供了强大的各种爬虫功能，包括网页爬取、数据抓取、数据筛选以及数据清洗等。它是基于 Node.js 的 npm 包...

    5 年前
  • npm 包 @cpmech/az-lambda 使用教程

    介绍 npm 包 @cpmech/az-lambda 是一个用于编写 AWS Lambda 函数的 Node.js 框架。它是基于 aws-lambda 包的拓展，提供了一些额外的功能和特性。

    5 年前
  • npm 包 @cpmech/az-cdk 使用教程

    简介 @cpmech/az-cdk 是一个用于构建 AWS CloudFormation 前端资源的 Node.js 库。它基于 TypeScript 构建，可以帮助您快速创建、管理和部署前端应用程序...

    5 年前
  • npm 包 @btakita/serverless-http 使用教程

    在开发前端应用时，我们经常需要将前端代码发布到云端进行部署和服务。这时候，我们需要用到 Serverless 框架。@btakita/serverless-http 是一个 npm 包，可以帮助我们快...

    5 年前
  • npm 包 @botsbotsbots/api 使用教程

    随着 AI 技术的强劲发展，聊天机器人正变得日益普及。BotsBotsBots 是一个能够让您快速轻松地搭建聊天机器人的平台。而其 npm 包 @botsbotsbots/api 提供了丰富的接口以供...

    5 年前
  • npm 包 @bots.bots/cognito-auth 使用教程

    前言 AWS Cognito 是一项非常流行的身份验证解决方案，提供了一整套基于云的身份验证、访问控制和用户管理服务。本文将介绍使用 @bots.bots/cognito-auth npm 包进行身份...

    5 年前
  • npm 包 @bots.bots/bots 使用教程

    介绍 @bots.bots/bots 是一个基于 Node.js 的开源 npm 包，它提供了一个简单易用的机器人框架，让我们可以轻松地构建和集成各种机器人应用，比如 Slack Bot、微信公众号机...

    5 年前
  • npm 包 @1password/aws-lambda-helpers 使用教程

    简介 @1password/aws-lambda-helpers 是一个 NPM 包，它提供了一些方便的工具和实用程序，可以用于 AWS Lambda 中的开发。 这个包的目的是帮助 Lambda 开...

    5 年前
  • npm 包 @types/enzyme-adapter-react-16 使用教程

    随着互联网的发展以及前端技术的发展，前端开发变得越来越重要。而现在，前端开发也变得越来越复杂，需要我们掌握各种复杂的技术。在前端开发时，我们会使用各种 npm 包来完成我们的任务， npm 包 @ty...

    5 年前
  • npm 包 @types/copy-webpack-plugin 使用教程

    在前端项目中，复制文件是一个非常常见的操作。在 webpack 中，我们可以使用 copy-webpack-plugin 插件来处理复制文件的任务。但在使用这个插件时，我们需要正确设置它的类型，在这里...

    5 年前
  • npm 包 @types/path-to-regexp 使用教程

    介绍 在前端开发中，经常需要处理路由相关的操作。path-to-regexp 是一个常用的路由转换工具，它可以将字符串路径转换成正则表达式，或者将路由参数匹配成对应的参数值。

    5 年前
  • npm 包 @types/multistream 使用教程

    随着前端开发的不断发展和进步，前端工程师在日常开发中会使用到各种各样的工具和技术，其中包括 npm 包。本篇文章将重点讲解 npm 包 @types/multistream 的使用教程。

    5 年前
  • npm 包 aurelia-webpack-plugin 使用教程

    前言 在前端开发中，webpack 是最常用的代码打包工具之一。而在使用 webpack 打包 aurelia 项目时，aurelia-webpack-plugin 就是一个非常重要的工具。

    5 年前
  • npm 包 @easy-webpack/assign 使用教程

    在前端开发中，使用各种 npm 包来简化开发过程是常见的做法。其中，@easy-webpack/assign 可以帮助我们很方便地处理 webpack 配置文件。本文将详细介绍该 npm 包的使用方法...

    5 年前
  • npm 包 @ngtools/webpack 使用教程

    前言 在前端开发中，使用 Webpack 是必不可少的一部分。特别是在 Angular 开发中，@ngtools/webpack 是非常重要的依赖包。 本文将介绍 @ngtools/webpack 的...

    5 年前
  • npm 包 @angular/tsc-wrapped 使用教程

    介绍 Angular 是一款广泛使用的前端框架，它提供了一组强大的工具和库，帮助开发人员快速构建高质量的 Web 应用程序。其中之一就是 TypeScript ，是一个面向对象的编程语言，它扩展了 J...

    5 年前

相关推荐

    暂无文章