Gathering detailed insights and metrics for @googlemaps/markerclusterer
Gathering detailed insights and metrics for @googlemaps/markerclusterer
Create and manage clusters for large amounts of markers
Installations
npm install @googlemaps/markerclustererScore
99.2
Supply Chain
100
Quality
81.6
Maintenance
100
Vulnerability
100
License
Developer
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
16.20.2
NPM Version
8.19.4
Statistics
234 Stars
707 Commits
86 Forks
23 Watching
11 Branches
22 Contributors
Updated on 25 Nov 2024
Bundle Size
20.24 kB
Minified
6.84 kB
Minified + Gzipped
Languages
TypeScript (93.43%)
JavaScript (6.57%)
Total Downloads
Cumulative downloads
Total Downloads
69,556,532
Last day
-6%
155,049
Compared to previous day
Last week
-0.7%
836,962
Compared to previous week
Last month
5.1%
3,666,883
Compared to previous month
Last year
51.1%
36,405,474
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Dev Dependencies
32
jesteslintrollupcore-jsts-jesttypedocprettiertypescript@types/jestd3-interpolate@babel/preset-env@types/google.mapseslint-plugin-jestrollup-plugin-copyselenium-webdriver@rollup/plugin-html@rollup/plugin-json@types/superclusterrollup-plugin-serve@rollup/plugin-babelrollup-plugin-terser@types/d3-interpolate@babel/runtime-corejs3@googlemaps/jest-mockseslint-config-prettiereslint-plugin-prettier@rollup/plugin-commonjs@googlemaps/js-api-loader@rollup/plugin-typescript@typescript-eslint/parser@rollup/plugin-node-resolve@typescript-eslint/eslint-plugin
Versions
Google Maps JavaScript MarkerClusterer
Description
The library creates and manages per-zoom-level clusters for large amounts of markers.
See the history section and migration section for how this library relates to @google/markerclusterer and @googlemaps/markerclustererplus.
Install
Available via npm as the package @googlemaps/markerclusterer.
npm i @googlemaps/markerclusterer
Alternativly you may add the umd package directly to the html document using the unpkg link.
1<script src="https://unpkg.com/@googlemaps/markerclusterer/dist/index.min.js"></script>
When adding via unpkg, the MarkerClusterer can be accessed at markerClusterer.MarkerClusterer.
TypeScript
This library uses the official TypeScript typings for Google Maps Platform, @types/google.maps.
1npm i -D @types/google.maps
Documentation
The reference documentation is generated from the TypeScript definitions.
Examples
1import { MarkerClusterer } from "@googlemaps/markerclusterer"; 2 3// use default algorithm and renderer 4const markerCluster = new MarkerClusterer({ map, markers });
View the package in action:
-
Algorithm Comparisons - This example demonstrates the different algorithms. Please note that spacing and many other options can be changed for each algorithm.
-
Renderer Usage - This example demonstrates different renderers similar to the image below.
History
This library has a heritage in @google/markerclusterer and @googlemaps/markerclustererplus, originally made available on code.google.com and then transferred to GitHub at https://github.com/googlemaps/v3-utility-library. The following is an approximate timeline.
- 201X - @google/markerclusterer was created.
- 201X - @googlemaps/markerclustererplus was created.
- 2019 - Libraries were published to NPM.
- 2019 - @google/markerclusterer was deprecated for @googlemaps/markerclustererplus.
- 2020 - @googlemaps/markerclustererplus was refactored to TypeScript.
- 2020 - @googlemaps/markerclustererplus was moved to a separate repository.
- 2021 - @googlemaps/markerclustererplus was rewritten as @googlemaps/markerclusterer (new).
- TBD - @googlemaps/markerclustererplus is deprecated for @googlemaps/markerclusterer (new).
Migration
The API of @googlemaps/markerclusterer has changed in a number of ways from @googlemaps/markerclustererplus.
- The
MarkerClustererclass now accepts analgorithmandrendererparameter to allow for more flexibility. The interface looks like the following:
1{ 2 algorithm?: Algorithm; 3 map?: google.maps.Map; 4 markers?: google.maps.Marker[]; 5 renderer?: Renderer; 6 onClusterClick?: onClusterClickHandler; 7 }
- The
MarkerClustereraccepts a single options argument instead of positional parameters. - The traditional
GridAlgorithmis still supported, but is not the default. The default is supercluster which uses k-d trees for improved performance. - Styling of clusters has been simplifed and moved to the renderer interface.
- The
MarkerClustererclass is still an instance ofgoogle.maps.OverlayView, but usesgoogle.maps.Markers instead ofgoogle.maps.Overlayto render the clusters. This solves issues related to the usage of map panes and click handlers. - @googlemaps/markerclusterer supports Marker and Map a11y improvements.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (27) are checked with a SAST tool
Reason
5 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Reason
Found 2/5 approved changesets -- score normalized to 4
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bundlewatch.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/bundlewatch.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/codeql.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/codeql.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/codeql.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/codeql.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/docs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/docs.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/docs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/package.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/package.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/package.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/release-please.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/release-please.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/release-please.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/release-please.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/googlemaps/js-markerclusterer/test.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/package.yml:25
- Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 5 third-party GitHubAction dependencies pinned
- Info: 3 out of 4 npmCommand dependencies pinned
Reason
1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:43
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:42
- Warn: no topLevel permission defined: .github/workflows/bundlewatch.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/dependabot.yml:19
- Warn: no topLevel permission defined: .github/workflows/docs.yml:1
- Warn: no topLevel permission defined: .github/workflows/package.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release-please.yml:24
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
5.3
/10
Last Scanned on 2024-11-25
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 More