@types/leaflet.awesome-markers

Installation

npm install --save @types/leaflet.awesome-markers

Summary

This package contains type definitions for Leaflet.awesome-markers plugin v2.0 with Leaflet (https://github.com/sigma-geosistemas/Leaflet.awesome-markers#properties).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/leaflet.awesome-markers/v0.

index.d.ts

// Type definitions for Leaflet.awesome-markers plugin v2.0 with Leaflet 0.x
// Project: https://github.com/sigma-geosistemas/Leaflet.awesome-markers#properties
// Definitions by: Egor Komarov <https://github.com/Odrin>, Marcel Sebek <https://github.com/sebek64>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

import * as Leaflet from "leaflet";

declare global { namespace L {
    module AwesomeMarkers {
        var version: string;

        function icon(options: AwesomeMarkers.IconOptions): AwesomeMarkers.Icon;

        interface IconStatic extends Leaflet.IconStatic {
            /**
              * Creates an icon instance with the given options.
              */
            new (options: IconOptions): Icon;

            Default: {
                /**
                  * Creates a default icon instance with the given options.
                  */
                new (options?: IconOptions): Icon.Default;

                imagePath: string;
            };
        }

        interface Icon extends Leaflet.Icon {
            options: AwesomeMarkers.IconOptions;
        }

        interface IconOptions extends Leaflet.IconOptions {
            /**
            * Name of the icon. See glyphicons or font-awesome.
            */
            icon?: string | undefined;

            /**
            * Select de icon library. 'fa' for font-awesome or 'glyphicon' for bootstrap 3.
            */
            prefix?: 'fa' | 'glyphicon' | undefined;

            /**
            * Color of the marker
            */
            markerColor?: 'red' | 'darkred' | 'orange' | 'green' | 'darkgreen' | 'blue' | 'purple' | 'darkpurple' | 'cadetblue' | undefined;

            /**
            * Color of the icon. 'white', 'black' or css code (hex, rgba etc).
            */
            iconColor?: 'white' | 'black' | string | undefined;

            /**
            * Make the icon spin. true or false. Font-awesome required
            */
            spin?: boolean | undefined;

            /**
            * Additional classes in the created tag
            */
            extraClasses?: string | undefined;
        }

        var Icon: AwesomeMarkers.IconStatic;
    }
} }

Additional Details

• Last updated: Thu, 08 Jul 2021 16:23:37 GMT
• Dependencies: @types/leaflet
• Global values: none

Credits

These definitions were written by Egor Komarov, and Marcel Sebek.