前言
在前端开发中,我们常常需要使用各种 npm 包来快速解决问题和提高效率。@bentley/itwin-client 是一款专门为前端开发者设计的 npm 包,可以为开发者提供 iModel.js 的 API 和工具。本文就是一篇介绍 @bentley/itwin-client 包的使用教程,希望能帮助初学者快速上手。
安装
首先,我们需要在本地安装 @bentley/itwin-client 包。打开终端,执行以下命令:
--- ------- ------ ---------------------
使用
1. 初始化
使用 itwin 各种功能前,我们需要初始化一个 iTwin.js 客户端,代码如下:
------ - ----------- - ---- ------------------------ ----- ---------- - --- --------------
在初始化的过程中,如果我们需要设置一些 iTwin.js 客户端的参数,只需要在 ITwinClient 构造函数中传递一个 json 格式的参数即可。
2. 身份验证
通过 iTwin.js 开发的应用程序大多数都需要使用到身份验证。在 itwin 中,有多种身份验证方式,如:OIDC、SAML、Basic 等等。在这里,我们以 OIDC 方式作为示例:
------ - ---------- - ---- ---------------------------- ----- ---------- - --- ------------ --------- ----- ------ ---- ------------ ----- -------- ----- ------ ------- ----- ------- ------------ --------- ------------------------ ----------------- ------------- ------- ---------- ---------------------------------- --------- ------------------------ --- ----- ----------------------- ------------- --------------------------------------------- -------------------------- ------------------------ --- -----------------------------------------------------
其中,各个参数的含义如下:
- clientId:在开发者平台创建的客户端 ID。
- redirectUri:用户身份验证后,重定向 URI。
- scope:请求身份验证时包含的范围。
- responseType:请求身份验证的方式。
- authority:OpenID 服务的 URL。
- redirect_uri:在身份验证流程中,用于用户身份验证后重定向到的 URI。
- post_signout_redirect_uri:用户取消身份验证后,重定向到的 URI。
3. 获取项目和 iModel
------ - ------ - ---- ---------------------------- ------ - ------- - ---- ----------------------------------- ------ - ----------- - ---- --------------------------- ----- -------- ------- - ----- --------------------------------------- ----- ------- - ----- -------------------------------------- -------------- --- ----------------------------------- ---------- --- -----------------------------------
其中:
- projectName:要获取的项目名称。
- iModelName:要获取的 iModel 名称。
4. 使用基础 API
@bentley/itwin-client 包支持多个 iTwin.js 的 API,如:Geometry、Imodel、Integrity、Context 等等。在这里,我们以 Geometry API 为例子:
------ - ------------------- - ---- --------------------------- ----- ------ - ----- -------------------------------------- ---------- --- ------------------------------ ----- --------------- ------------------- - ----- --------------------------------------------------------------
其中:
- projectId:你要查询的项目 ID。
- iModleId:要查询的 iModel 的 ID。
总结
@bentley/itwin-client 包不仅提供 iModel.js 的 API,还包含许多 iTwin.js 工具,可以为前端开发者提供强有力的支持。本文中,我们了解了基本的使用方法,包括身份验证、获取项目和 iModel,以及使用基础 API。希望可以帮助大家快速上手。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedaa81b5cbfe1ea06104db