0.2.4 • Published 7 months ago

@types/leaflet.heat v0.2.4

Weekly downloads
1,054
License
MIT
Repository
github
Last release
7 months ago

Installation

npm install --save @types/leaflet.heat

Summary

This package contains type definitions for Leaflet.heat (https://github.com/Leaflet/Leaflet.heat).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/leaflet.heat.

index.d.ts

// Type definitions for Leaflet.heat 0.2
// Project: https://github.com/Leaflet/Leaflet.heat
// Definitions by: Önder Ceylan <https://github.com/onderceylan>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

import * as L from 'leaflet';

declare module 'leaflet' {
    type HeatLatLngTuple = [number, number, number];

    interface ColorGradientConfig {
        [key: number]: string;
    }

    interface HeatMapOptions {
        minOpacity?: number | undefined;
        maxZoom?: number | undefined;
        max?: number | undefined;
        radius?: number | undefined;
        blur?: number | undefined;
        gradient?: ColorGradientConfig | undefined;
    }

    interface HeatLayer extends TileLayer {
        setOptions(options: HeatMapOptions): HeatLayer;
        addLatLng(latlng: LatLng | HeatLatLngTuple): HeatLayer;
        setLatLngs(latlngs: Array<LatLng | HeatLatLngTuple>): HeatLayer;
    }

    function heatLayer(latlngs: Array<LatLng | HeatLatLngTuple>, options: HeatMapOptions): HeatLayer;
}

Additional Details

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

Credits

These definitions were written by Önder Ceylan.