@ryancavanaugh/heatmap.js - npm Package Compare versions

Comparing version 2.0.4 to 2.0.6

heatmap.d.ts

@@ -1,1 +0,139 @@
-heatmap.d.ts
+// Type definitions for heatmap.js v2.0
+// Project: https://github.com/pa7/heatmap.js/
+// Definitions by: Yang Guan <https://github.com/lookuptable>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference library="leaflet" />
+
+/*
+ * Configuration object of a heatmap
+ */
+interface HeatmapConfiguration {
+
+    /*
+     * A background color string in form of hexcode, color name, or rgb(a)
+     */
+    backgroundColor?: string;
+
+    /*
+     * The blur factor that will be applied to all datapoints. The higher the
+     * blur factor is, the smoother the gradients will be
+     * Default value: 0.85
+     */
+    blur?: number;
+
+    /*
+     * An object that represents the gradient
+     */
+    gradient?: any;
+
+    /*
+     * The property name of your latitude coordinate in a datapoint
+     * Default value: 'x'
+     */
+    latField?: string;
+
+    /*
+     * The property name of your longitude coordinate in a datapoint
+     * Default value: 'y'
+     */
+    lngField?: string;
+
+    /*
+     * The maximal opacity the highest value in the heatmap will have. (will be
+     * overridden if opacity set)
+     * Default value: 0.6
+     */
+    maxOpacity?: number;
+
+    /*
+     * The minimum opacity the lowest value in the heatmap will have (will be
+     * overridden if opacity set)
+     */
+    minOpacity?: number;
+
+    /*
+     * A global opacity for the whole heatmap. This overrides maxOpacity and
+     * minOpacity if set
+     */
+    opacity?: number;
+
+    /*
+     * The radius each datapoint will have (if not specified on the datapoint
+     * itself)
+     */
+    radius?: number;
+
+    /**
+     * Scales the radius based on map zoom.
+     */
+    scaleRadius?: boolean;
+
+    /*
+     * Indicate whether the heatmap should use a global extrema or a local
+     * extrema (the maximum and minimum of the currently displayed viewport)
+     */
+    useLocalExtrema?: boolean;
+
+    /*
+     * The property name of the value/weight in a datapoint
+     */
+    valueField: string;
+}
+
+/*
+ * A single data point on a heatmap. The keys are specified by
+ * HeatmapConfig.latField, HeatmapConfig.lngField and HeatmapConfig.valueField
+ */
+interface HeatmapDataPoint {
+    [index: string]: number;
+}
+
+/*
+ * An object representing the set of data points on a heatmap
+ */
+interface HeatmapData {
+
+    /*
+     * An array of HeatmapDataPoints
+     */
+    data: HeatmapDataPoint[];
+
+    /*
+     * Max value of the valueField
+     */
+    max?: number;
+
+    /*
+     * Min value of the valueField
+     */
+    min?: number;
+}
+
+/*
+ * The overlay layer to be added onto leaflet map
+ */
+declare class HeatmapOverlay {
+
+    /*
+     * Initialization function
+     */
+    constructor(configuration: HeatmapConfiguration)
+
+    /*
+     * Create DOM elements for an overlay, adding them to map panes and puts
+     * listeners on relevant map events
+     */
+    onAdd(map: L.Map): void;
+
+    /*
+     * Remove the overlay's elements from the DOM and remove listeners
+     * previously added by onAdd()
+     */
+    onRemove(map: L.Map): void;
+
+    /*
+     * Initialize a heatmap instance with the given dataset
+     */
+    setData(data: HeatmapData): void;
+}

package.json

 {
     "name": "@ryancavanaugh/heatmap.js",
-    "version": "2.0.4",
+    "version": "2.0.6",
     "description": "Type definitions for heatmap from https://www.github.com/DefinitelyTyped/DefinitelyTyped",
@@ -5,0 +5,0 @@ "main": "",

README.md

@@ -10,3 +10,3 @@ This package contains type definitions for heatmap.
 Additional Details
- * Last updated: Tue, 22 Mar 2016 23:49:48 GMT
+ * Last updated: Wed, 23 Mar 2016 04:52:36 GMT
  * Typings kind: Global
@@ -13,0 +13,0 @@ * Library Dependencies: none

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3996

increased by358.26%

Lines of code

115

increased byInfinity%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes