Installations
npm install @xeokit/xeokit-sdkDeveloper Guide
Typescript
Yes
Module System
CommonJS
Node Version
16.10.0
NPM Version
7.24.0
Score
66.5
Supply Chain
95.4
Quality
93
Maintenance
100
Vulnerability
67.6
License
Releases
Contributors
Languages
JavaScript (56.86%)
HTML (42.11%)
CSS (1.02%)
Developer
Download Statistics
Total Downloads
705,410
Last Day
101
Last Week
2,059
Last Month
16,601
Last Year
182,987
GitHub Statistics
739 Stars
4,772 Commits
293 Forks
40 Watching
269 Branches
47 Contributors
Maintainers
Package Meta Information
Latest Version
2.6.61
Package Id
@xeokit/xeokit-sdk@2.6.61
Unpacked Size
26.52 MB
Size
4.77 MB
File Count
593
NPM Version
7.24.0
Node Version
16.10.0
Publised On
11 Dec 2024
Total Downloads
Cumulative downloads
Total Downloads
705,410
Last day
-87.9%
101
Compared to previous day
Last week
-48.5%
2,059
Compared to previous week
Last month
-5.2%
16,601
Compared to previous month
Last year
18.3%
182,987
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
xeokit-sdk
xeokit is a JavaScript software development kit created by xeolabs for viewing high-detail, full-precision 3D engineering and BIM models in the browser.
Resources
Installing
1npm i @xeokit/xeokit-sdk
Usage
The xeokit SDK lets us develop our own browser-based BIM viewer, which we can fully customize and extend with plugins. Let's create a Viewer with a XKTLoaderPlugin to view an XKT model in the browser, which was pre-converted from IFC model from the Open IFC Model Database.
This is just one way to load our models into xeokit: by converting it to XKT and loading via XKTLoaderPlugin. We can also load models from other formats directly, including CityJSON, glTF, LAZ and OBJ.
1<!doctype html> 2<html> 3<head> 4 <meta charset="utf-8"> 5 <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> 6 <meta name="viewport" content="width=device-width, initial-scale=1"> 7 <title>xeokit Example</title> 8 <style> 9 body { 10 margin: 0; 11 width: 100%; 12 height: 100%; 13 user-select: none; 14 } 15 16 #xeokit_canvas { 17 width: 100%; 18 height: 100%; 19 position: absolute; 20 background: lightblue; 21 background-image: linear-gradient(lightblue, white); 22 } 23 </style> 24</head> 25<body> 26<canvas id="xeokit_canvas"></canvas> 27</body> 28<script id="source" type="module"> 29 30 import {XKTLoaderPlugin, Viewer} from 31 "https://cdn.jsdelivr.net/npm/@xeokit/xeokit-sdk/dist/xeokit-sdk.es.min.js"; 32 33 const viewer = new Viewer({ 34 canvasId: "xeokit_canvas", 35 transparent: true, 36 dtxEnabled: true 37 }); 38 39 viewer.camera.eye = [-3.933, 2.855, 27.018]; 40 viewer.camera.look = [4.400, 3.724, 8.899]; 41 viewer.camera.up = [-0.018, 0.999, 0.039]; 42 43 const xktLoader = new XKTLoaderPlugin(viewer); 44 45 const sceneModel = xktLoader.load({ 46 id: "myModel", 47 src: "Duplex.xkt", 48 saoEnabled: true, 49 edges: true, 50 dtxEnabled: true 51 }); 52 53</script> 54</html>
No vulnerabilities found.
Reason
30 commit(s) and 13 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
binaries present in source code
Details
- Warn: binary detected: dist/web-ifc.wasm:1
Reason
license file detected
Details
- Info: project has a license file: LICENSE.txt:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
SAST tool is not run on all commits -- score normalized to 9
Details
- Warn: 18 commits out of 20 are checked with a SAST tool
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/xeokit/xeokit-sdk/ci.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/xeokit/xeokit-sdk/ci.yaml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/codesee-arch-diagram.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/xeokit/xeokit-sdk/codesee-arch-diagram.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/xeokit/xeokit-sdk/release.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/xeokit/xeokit-sdk/release.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/xeokit/xeokit-sdk/release.yaml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/release.yaml:40
- Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 2 out of 3 npmCommand dependencies pinned
Reason
Found 7/20 approved changesets -- score normalized to 3
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: found token with 'none' permissions: .github/workflows/release.yaml:11
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release.yaml:23
- Warn: no topLevel permission defined: .github/workflows/ci.yaml:1
- Info: topLevel permissions set to 'read-all': .github/workflows/codesee-arch-diagram.yml:12
- Warn: no topLevel permission defined: .github/workflows/release.yaml:1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
17 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-xf5p-87ch-gxw2
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-mxhp-79qh-mcx6
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
4.4
/10
Last Scanned on 2024-12-16
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to @xeokit/xeokit-sdk
@cks-ct/xeokit-sdk
Web Programming Toolkit for 3D/2D BIM and AEC Graphics
@superviz/xeokit-plugin
Xeokit Viewer Plugin for SuperViz SDK
@lijuhong1981/xktloader
一个加载解析[.xkt](https://github.com/xeokit/xeokit-convert) BIM模型文件的插件，基于[xeokit-sdk](https://github.com/xeokit/xeokit-sdk)源码精简而来，去除了XKTLoaderPlugin对Viewer和Renderer的依赖，只对.xkt文件进行加载和解析，并返回解析后的数据，可以使用其它的Web3D引擎，如Cesium、threejs等，来对数据进行绘制和展示。