@types/mapboxgl-spiderifier 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. mapboxgl-spiderifier/README.md +12 -13
  2. mapboxgl-spiderifier/index.d.ts +10 -11
  3. mapboxgl-spiderifier/package.json +5 -3
mapboxgl-spiderifier/README.md CHANGED
@@ -15,17 +15,17 @@ export function popupOffsetForSpiderLeg(spiderLeg: SpiderLeg, offset?: number):
15
15
 
16
16
  export interface SpiderLegOffsets {
17
17
  top: SpiderLegOffset;
18
- "top-left": SpiderlegOffset;
19
- "top-right": SpiderlegOffset;
20
- bottom: SpiderlegOffset;
21
- "bottom-left": SpiderlegOffset;
22
- "bottom-right": SpiderlegOffset;
23
- left: SpiderlegOffset;
24
- right: SpiderlegOffset;
18
+ "top-left": SpiderLegOffset;
19
+ "top-right": SpiderLegOffset;
20
+ bottom: SpiderLegOffset;
21
+ "bottom-left": SpiderLegOffset;
22
+ "bottom-right": SpiderLegOffset;
23
+ left: SpiderLegOffset;
24
+ right: SpiderLegOffset;
25
25
  }
26
26
  export type SpiderLegOffset = [number, number];
27
27
 
28
- class MapboxglSpiderifier {
28
+ declare class MapboxglSpiderifier {
29
29
  constructor(map: Map, options: Options);
30
30
 
31
31
  each: (spiderLeg: SpiderLeg) => void;
@@ -43,6 +43,8 @@ export interface Options {
43
43
  /**
44
44
  * number of markers till which the spider will be circular and beyond this threshold,
45
45
  * it will spider in spiral.
46
+ *
47
+ * 0 -> always spiral; Infinity -> always circle
46
48
  * Default: 9
47
49
  */
48
50
  circleSpiralSwitchover?: number;
@@ -50,9 +52,6 @@ export interface Options {
50
52
  initializeLeg?: (spiderLeg: SpiderLeg) => void;
51
53
  onClick?: (event: MouseEvent, spiderLeg: SpiderLeg) => void;
52
54
  // --- <SPIDER TUNING Params>
53
- // circleSpiralSwitchover: show spiral instead of circle from this marker count upwards
54
- // 0 -> always spiral; Infinity -> always circle
55
- circleSpiralSwitchover?: number; // Default: 9,
56
55
  circleFootSeparation?: number; // Default: 25, // related to circumference of circle
57
56
  spiralFootSeparation?: number; // Default: 28, // related to size of spiral (experiment!)
58
57
  spiralLengthStart?: number; // Default: 15, // ditto
@@ -85,8 +84,8 @@ export interface SpiderLeg {
85
84
  ````
86
85
 
87
86
  ### Additional Details
88
- * Last updated: Thu, 25 Jan 2024 16:07:26 GMT
89
- * Dependencies: none
87
+ * Last updated: Fri, 26 Jan 2024 19:06:24 GMT
88
+ * Dependencies: [@types/mapbox-gl](https://npmjs.com/package/@types/mapbox-gl)
90
89
 
91
90
  # Credits
92
91
  These definitions were written by [manoj kumar](https://github.com/bewithjonam), and [Lance Gliser](https://github.com/lancegliser).
mapboxgl-spiderifier/index.d.ts CHANGED
@@ -5,17 +5,17 @@ export function popupOffsetForSpiderLeg(spiderLeg: SpiderLeg, offset?: number):
5
5
 
6
6
  export interface SpiderLegOffsets {
7
7
  top: SpiderLegOffset;
8
- "top-left": SpiderlegOffset;
9
- "top-right": SpiderlegOffset;
10
- bottom: SpiderlegOffset;
11
- "bottom-left": SpiderlegOffset;
12
- "bottom-right": SpiderlegOffset;
13
- left: SpiderlegOffset;
14
- right: SpiderlegOffset;
8
+ "top-left": SpiderLegOffset;
9
+ "top-right": SpiderLegOffset;
10
+ bottom: SpiderLegOffset;
11
+ "bottom-left": SpiderLegOffset;
12
+ "bottom-right": SpiderLegOffset;
13
+ left: SpiderLegOffset;
14
+ right: SpiderLegOffset;
15
15
  }
16
16
  export type SpiderLegOffset = [number, number];
17
17
 
18
- class MapboxglSpiderifier {
18
+ declare class MapboxglSpiderifier {
19
19
  constructor(map: Map, options: Options);
20
20
 
21
21
  each: (spiderLeg: SpiderLeg) => void;
@@ -33,6 +33,8 @@ export interface Options {
33
33
  /**
34
34
  * number of markers till which the spider will be circular and beyond this threshold,
35
35
  * it will spider in spiral.
36
+ *
37
+ * 0 -> always spiral; Infinity -> always circle
36
38
  * Default: 9
37
39
  */
38
40
  circleSpiralSwitchover?: number;
@@ -40,9 +42,6 @@ export interface Options {
40
42
  initializeLeg?: (spiderLeg: SpiderLeg) => void;
41
43
  onClick?: (event: MouseEvent, spiderLeg: SpiderLeg) => void;
42
44
  // --- <SPIDER TUNING Params>
43
- // circleSpiralSwitchover: show spiral instead of circle from this marker count upwards
44
- // 0 -> always spiral; Infinity -> always circle
45
- circleSpiralSwitchover?: number; // Default: 9,
46
45
  circleFootSeparation?: number; // Default: 25, // related to circumference of circle
47
46
  spiralFootSeparation?: number; // Default: 28, // related to size of spiral (experiment!)
48
47
  spiralLengthStart?: number; // Default: 15, // ditto
mapboxgl-spiderifier/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/mapboxgl-spiderifier",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "TypeScript definitions for mapboxgl-spiderifier",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapboxgl-spiderifier",
6
6
  "license": "MIT",
@@ -24,7 +24,9 @@
24
24
  "directory": "types/mapboxgl-spiderifier"
25
25
  },
26
26
  "scripts": {},
27
- "dependencies": {},
28
- "typesPublisherContentHash": "ed43d1081e0fe88ec748a6139190c799652f1f75eb1feeadfaaf82621b10145d",
27
+ "dependencies": {
28
+ "@types/mapbox-gl": "*"
29
+ },
30
+ "typesPublisherContentHash": "eca770c277aa1f4e1d1ac72aaacbe6b75474cf808f750d2f15073e9812946e9b",
29
31
  "typeScriptVersion": "4.6"
30
32
  }