Package Health Score

53 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

scatter
39

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
0.0.13	\|	06/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

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,787)

GitHub Stars: 170
Forks: 38
Contributors: 8

Direct Usage Popularity

The npm package scatter-gl receives a total of 2,787 downloads a week. As such, we scored scatter-gl popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package scatter-gl, we found that it has been starred 170 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: Yes
Code of Conduct: No
Contributors: 8
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like scatter-gl is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 20
Open PR: 32
Last Release: 2 years ago
Last Commit: 6 months ago

Further analysis of the maintenance status of scatter-gl based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for scatter-gl is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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: 5 years
Dependencies: 1 Direct
Versions: 12
Install Size: 3.13 MB
Dist-tags: 1
# of Files: 72
Maintainers: 1
TS Typings: Yes

scatter-gl 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.

Readme

ScatterGL

Interactive 3D / 2D webgl-accelerated scatter plot point renderer. Core functionality from the embedding projector, capable of rendering and interacting with tens of thousands of points.

Examples

Basic use

// where `points` is an array of 2 or 3-dimensional points as number arrays.
const dataset = new ScatterGL.Dataset(points);
const scatterGL = new ScatterGL(containerElement);
scatterGL.render(dataset);

Installation

with yarn / npm

yarn add scatter-gl

via cdn

Parameters

The ScatterGL constructor can accept a number of parameters via a ScatterGLParams object:

Parameter	Type	Description	default
`camera`	`Camera`	An object containing default parameters for the camera	Camera params object (`zoom: number`, `target: Point3D`, and `position: Point3D`)
`onClick`	`(point: Point \| null) => void`	A callback invoked when clicking on a point or elsewhere
`onHover`	`(point: Point \| null) => void`	A callback invoked when hovering over a point
`onSelect`	`(points: Point[]) => void`	A callback invoked when a point or points are selected
`onCameraMove`	`(cameraPosition: THREE.Vector3, cameraTarget: THREE.Vector3) => void`	A callback invoked the camera moves due to user interaction.
`pointColorer`	`(index: number, selectedIndices: Set, hoverIndex: number	null) => string`	A function to determine the color of points
`renderMode`	`RenderMode`	The render mode to display points, one of `RenderMode.POINT`, `RenderMode.SPRITE`, or `RenderMode.TEXT`	`RenderMode.POINT`
`showLabelsOnHover`	`boolean`	Whether or not to render label text on hover	`true`
`selectEnabled`	`boolean`	`true`	Whether or not a user can select points by clicking
`styles`	`Styles`	An object containing style parameters to override the default options
`rotateOnStart`	`boolean`	Whether or not the renderer automatically rotates until interaction	`true`
`orbitControls`	`OrbitControlParams`	An object containing default parameters for the orbit controls	Orbit Controls params object (`zoomSpeed: number`, `autoRotateSpeed: number`, and `mouseRotateSpeed: number`)

ScatterGL methods

Method	Description
`isOrbiting()`	Returns whether the orbit animation is currently on
`render(dataset: Dataset)`	Initializes and renders a dataset to the container element
`resize()`	Updates the render size based on the container element
`resetZoom()`	Resets the camera zoom to default
`select(pointIndices: number[])`	Selects points by index
`setPanMode()`	Sets interaction mode to 'pan'
`setPointColorer(pointColorer: PointColorer)`	Sets a function to determine colors
`setHoverPointIndex()`	Sets the hovered point
`setPointRenderMode()`	Sets point render mode
`setRenderMode(renderMode: RenderMode)`	Sets a specific render mode
`setSelectMode()`	Sets interaction mode to 'select'
`setSequences(sequences: Sequence[])`	Sets sequences with which to render polylines
`setSpriteRenderMode()`	Sets sprite render mode
`setTextRenderMode()`	Sets text render mode
`updateDataset(dataset: Dataset)`	Updates the dataset
`startOrbitAnimation()`	Begin rotating until an interaction
`stopOrbitAnimation()`	Stops automatic rotation

ScatterGL Styles

See styles.ts for interfaces and descriptions of a user-configurable styles object that can be provided to ScatterGL to configure colors, sizes, fog, etc.

Advanced usage

See the demo app for examples of interaction handling, spritesheet rendering, and point coloring.

Styling

You can provide an object in the form of Styles via the styles parameter of the ScatterGLParams object.

Development

yarn
yarn demo

This is not an officially supported Google product

scatter-gl dependencies

three

scatter-gl development dependencies

@types/jest copy-webpack-plugin gh-pages html-webpack-plugin jest prettier ts-jest ts-loader typescript webpack webpack-cli webpack-dev-server

FAQs

What is scatter-gl?

webgl accelerated 3D/2D scatterplot renderer. Visit Snyk Advisor to see a full health score report for scatter-gl, including popularity, security, maintenance & community analysis.

Is scatter-gl popular?

The npm package scatter-gl receives a total of 2,787 weekly downloads. As such, scatter-gl popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is scatter-gl well maintained?

We found indications that scatter-gl is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is scatter-gl safe to use?

The npm package scatter-gl 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 November-2024, at 09:51 (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