Nachos Preventing Motivation

    TypeScript icon, indicating that this package has built-in type declarations

    15.0.0 • Public • Published


    Build Status

    Extension to the @asymmetrik/ngx-leaflet package for Provides leaflet.markercluster integration into projects. Compatible with Leaflet v1.x and leaflet.markercluster v1.x Supports Angular v15 and Ivy, and use in Angular-CLI based projects

    Table of Contents


    Install the package and its peer dependencies via npm:

    npm install leaflet @asymmetrik/ngx-leaflet
    npm install leaflet.markercluster @asymmetrik/ngx-leaflet-markercluster

    If you intend to use this library in a typescript project (utilizing the typings), you will need to also install the leaflet typings via npm:

    npm install @types/leaflet @types/leaflet.markercluster


    This plugin is used with the Leaflet plugin.

    The first step is to follow the instructions to get @asymmetrik/ngx-leaflet working. Next, follow a similar process to install and configure this plugin. Generally, the steps are:

    • Install this package and its dependencies (see above).
    • Import the leaflet.markercluster stylesheet (i.e., node_modules/leaflet.markercluster/dist/MarkerCluster.Default.css and .../MarkerCluster.css for animations).
      • Follow the same process as documented in @asymmetrik/ngx-leaflet.
    • Import the LeafletMarkerClusterModule into your Angular application module and local module (if applicable).
    • Create and configure a map (see docs below and/or demo)

    To create a map, use the leaflet attribute directive. This directive must appear first. You must specify an initial zoom/center and set of layers either via leafletOptions or by binding to leafletZoom, leafletCenter, and leafletLayers.

    <div style="height: 400px;"

    Finally, to initialize and configure the leaflet markercluster plugin, use the following attribute directives:


    This attribute is an attribute directive that initiates the marker cluster plugin and binds the marker data.


    Input binding for the options to be passed directly to the marker cluster plugin upon creation. These options are only currently processed at creation time.

    The options object is passed through to the leaflet.markercluster object. Therefore, you can reference their documentation for help configuring this plugin.

    Getting a reference to the MarkerCluster Layer

    There is an optional output event emitter that will expose the markercluster group being used by the plugin called leafletMarkerClusterReady. See the following example:

    <div style="height: 400px;"
    markerClusterReady(markerCluster: L.MarkerClusterGroup) {
    	// Do stuff with group


    PRs accepted. If you are part of Asymmetrik, please make contributions on feature branches off of the develop branch. If you are outside of Asymmetrik, please fork our repo to make contributions.


    See LICENSE in repository for details.




    npm i @asymmetrik/ngx-leaflet-markercluster

    DownloadsWeekly Downloads






    Unpacked Size

    37.5 kB

    Total Files


    Last publish


    • brianghig
    • rblace
    • reblace
    • iisluan
    • ekoon121
    • robert-w
    • amarcus
    • jlee-asymmetrik
    • soneill
    • astadler4asymmetrik