Skip to content

feat(google-maps): switch to non-deprecated API for clustering #24853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

crisbeto
Copy link
Member

@crisbeto crisbeto commented Apr 29, 2022

The marker clusterer component is currently based on the @googlemaps/markerclustererplus package which is deprecated. These changes rewrite the component to use @googlemaps/markerclusterer instead.

BREAKING CHANGE:
The new @googlemaps/markerclusterer API should be imported instead of the old one. Read more at: https://github.com/googlemaps/js-markerclusterer

Furthermore, the new clustering package doesn't offer the same set of public APIs. As a result, the following inputs to the MapMarkerClusterer component have been removed:

  • ariaLabelFn
  • averageCenter
  • batchSizeIE
  • calculator
  • clusterClass
  • enableRetinaIcons
  • gridSize
  • ignoreHidden
  • imageExtension
  • imagePath
  • imageSizes
  • maxZoom
  • minimumClusterSize
  • styles
  • title
  • zIndex
  • zoomOnClick
  • options

It is now recommended to customize the cluster using the renderer and algorithm inputs.

Fixes #23695.

@crisbeto crisbeto added blocked This issue is blocked by some external factor, such as a prerequisite PR target: major This PR is targeted for the next major release labels Apr 29, 2022
@crisbeto
Copy link
Member Author

crisbeto commented Apr 29, 2022

Blocked on the new API being available in g3 and existing users being migrated.

@crisbeto crisbeto force-pushed the clusterer-rewrite branch from 28eff59 to cb2105c Compare April 29, 2022 10:31
@crisbeto crisbeto added this to the 15.0.0 milestone May 9, 2022
The marker clusterer component is currently based on the `@googlemaps/markerclustererplus` package which is deprecated. These changes rewrite the component to use `@googlemaps/markerclusterer` instead.

BREAKING CHANGE:
The new `@googlemaps/markerclusterer` API should be imported instead of the old one. Read more at: https://github.com/googlemaps/js-markerclusterer

Furthermore, the new clustering package doesn't offer the same set of public APIs. As a result, the following inputs to the `MapMarkerClusterer` component have been removed:
* `ariaLabelFn`
* `averageCenter`
* `batchSizeIE`
* `calculator`
* `clusterClass`
* `enableRetinaIcons`
* `gridSize`
* `ignoreHidden`
* `imageExtension`
* `imagePath`
* `imageSizes`
* `maxZoom`
* `minimumClusterSize`
* `styles`
* `title`
* `zIndex`
* `zoomOnClick`
* `options`

It is now recommended to customize the cluster using the `renderer` and `algorithm` inputs.

Fixes angular#23695.
@pfeigl
Copy link
Contributor

pfeigl commented Dec 19, 2022

This was marked to be released in v15 but it looks like it didn't make it.
Is there any information, when this will be available?

@mrehman7095
Copy link

any update on this @crisbeto ?

@runette
Copy link

runette commented Feb 10, 2024

@crisbeto Google forcing the use of an API that Google deprecated years ago is not a good look. Isn't it time this one was actioned?

@bougwal
Copy link

bougwal commented Oct 8, 2024

Hi guys, any updates on this PR ? Do we have a potential timeline of when this will land?

@crisbeto
Copy link
Member Author

Closing in favor of #29885.

@crisbeto crisbeto closed this Oct 17, 2024
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Nov 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
blocked This issue is blocked by some external factor, such as a prerequisite PR detected: breaking change PR contains a commit with a breaking change target: major This PR is targeted for the next major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(ANGULAR GOOGLE MAPS): Is it possible to use the new package @googlemaps/markerclusterer?
8 participants