@xeokit/xeokit-sdk

v2.6.0-beta-13

Web Programming Toolkit for 3D/2D BIM and AEC Graphics For more information about how to use this package see README

Latest version published 18 hours ago

License: See LICENSE.txt

NPM

GitHub

Package Health Score

78 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.6.0-beta-13	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.4.1	\|	11/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.7	\|	10/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.9.999	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.9.91	\|	04/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

See LICENSE.txt

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2,092)

GitHub Stars: 676
Forks: 268
Contributors: 40

Direct Usage Popularity

The npm package @xeokit/xeokit-sdk receives a total of 2,092 downloads a week. As such, we scored @xeokit/xeokit-sdk popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @xeokit/xeokit-sdk, we found that it has been starred 676 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the @xeokit/xeokit-sdk repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @xeokit/xeokit-sdk is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 151
Open PR: 13
Last Release: 18 hours ago
Last Commit: 6 days ago

Further analysis of the maintenance status of @xeokit/xeokit-sdk based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @xeokit/xeokit-sdk demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 4 Direct
Versions: 447
Install Size: 26.8 MB
Dist-tags: 1
# of Files: 571
Maintainers: 1
TS Typings: No

@xeokit/xeokit-sdk has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @xeokit/xeokit-sdk?

To help you get started, we've collected the most common ways that @xeokit/xeokit-sdk is being used within popular public projects.

opf / openproject / frontend / src / app / modules / ifc_models / xeokit-viewer.js View on Github

cameraControl.panToPointer = true;
    cameraControl.doublePickFlyTo = true;
    cameraFlight.duration = 1.0;
    cameraFlight.fitFOV = 25;
    viewer.camera.eye = [-2.56, 8.38, 8.27];
    viewer.camera.look = [13.44, 3.31, -14.83];
    viewer.camera.up = [0.10, 0.98, -0.14];
    viewer.scene.xrayMaterial.fillAlpha = 0.1;
    viewer.scene.xrayMaterial.fillColor = [0, 0, 0];
    viewer.scene.xrayMaterial.edgeAlpha = 0.4;
    viewer.scene.xrayMaterial.edgeColor = [0, 0, 0];
    viewer.scene.highlightMaterial.fill = false;
    viewer.scene.highlightMaterial.fillAlpha = 0.3;
    viewer.scene.highlightMaterial.edgeColor = [1, 1, 0];

    const xktLoader = new XKTLoaderPlugin(viewer);
    const model = xktLoader.load({
      id: "xeokit-model-" + ifcModelId,
      src: xktFileUrl,
      metaModelSrc: metadataFileUrl,
      edges: true
    });
    //------------------------------------------------------------------------------------------------------------------
    // Mouse over entities to highlight them
    //------------------------------------------------------------------------------------------------------------------
    var lastEntity = null;
    viewer.scene.input.on("mousemove", function (coords) {
      var hit = viewer.scene.pick({
        canvasPos: coords
      });
      if (hit) {
        if (!lastEntity || hit.entity.id !== lastEntity.id) {

View more ways to use @xeokit/xeokit-sdk

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.

Installing

npm 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 WebIFCLoaderPlugin to view a IFC model in the browser, then view a sample IFC model from the Open IFC Model Database.

This is just one way to load our models into xeokit. We can also load multiple models from other formats, including CityJSON, glTF, LAZ and OBJ, as well as xeokit's own native highly-compressed XKT format, which we can pre-convert offline from other formats.




    
    
    
    <title>xeokit Example</title>
    <style>
        body {
            margin: 0;
            width: 100%;
            height: 100%;
            user-select: none;
        }

        #myCanvas {
            width: 100%;
            height: 100%;
            position: absolute;
            background: lightblue;
            background-image: linear-gradient(lightblue, white);
        }
    </style>


<canvas id="myCanvas"></canvas>

Resources

@xeokit/xeokit-sdk dependencies

@loaders.gl/core @loaders.gl/gltf @loaders.gl/las html2canvas

@xeokit/xeokit-sdk development dependencies

@babel/core @babel/preset-env @rollup/plugin-babel @rollup/plugin-node-resolve esdoc esdoc-custom-theme esdoc-publish-html-plugin esdoc-standard-plugin eslint parse5 rollup rollup-plugin-terser typedoc

FAQs

What is @xeokit/xeokit-sdk?

Web Programming Toolkit for 3D/2D BIM and AEC Graphics. Visit Snyk Advisor to see a full health score report for @xeokit/xeokit-sdk, including popularity, security, maintenance & community analysis.

Is @xeokit/xeokit-sdk popular?

The npm package @xeokit/xeokit-sdk receives a total of 2,092 weekly downloads. As such, @xeokit/xeokit-sdk popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @xeokit/xeokit-sdk well maintained?

We found that @xeokit/xeokit-sdk demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @xeokit/xeokit-sdk safe to use?

The npm package @xeokit/xeokit-sdk was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 April-2024, at 03:54 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP