UNPKG

2.42 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/d3-polygon`
3
4# Summary
5This package contains type definitions for d3-polygon (https://github.com/d3/d3-polygon/).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/d3-polygon.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/d3-polygon/index.d.ts)
10````ts
11// Last module patch version validated against: 3.0.1
12
13/**
14 * Returns the signed area of the specified polygon. If the vertices of the polygon are in counterclockwise order
15 * (assuming a coordinate system where the origin <0,0> is in the top-left corner), the returned area is positive;
16 * otherwise it is negative, or zero.
17 *
18 * @param polygon Array of coordinates <x0, y0>, <x1, y1> and so on.
19 */
20export function polygonArea(polygon: Array<[number, number]>): number;
21
22/**
23 * Returns the centroid of the specified polygon.
24 *
25 * @param polygon Array of coordinates <x0, y0>, <x1, y1> and so on.
26 */
27export function polygonCentroid(polygon: Array<[number, number]>): [number, number];
28
29/**
30 * Returns the convex hull of the specified points using Andrew’s monotone chain algorithm.
31 * The returned hull is represented as an array containing a subset of the input points arranged in
32 * counterclockwise order. Returns null if points has fewer than three elements.
33 *
34 * @param points Array of coordinates <x0, y0>, <x1, y1> and so on.
35 */
36export function polygonHull(points: Array<[number, number]>): Array<[number, number]> | null;
37
38/**
39 * Returns true if and only if the specified point is inside the specified polygon.
40 *
41 * @param polygon Array of coordinates <x0, y0>, <x1, y1> and so on.
42 * @param point Coordinates of point <x, y>.
43 */
44export function polygonContains(polygon: Array<[number, number]>, point: [number, number]): boolean;
45
46/**
47 * Returns the length of the perimeter of the specified polygon.
48 *
49 * @param polygon Array of coordinates <x0, y0>, <x1, y1> and so on.
50 */
51export function polygonLength(polygon: Array<[number, number]>): number;
52
53````
54
55### Additional Details
56 * Last updated: Tue, 07 Nov 2023 15:11:37 GMT
57 * Dependencies: none
58
59# Credits
60These definitions were written by [Tom Wanzek](https://github.com/tomwanzek), [Alex Ford](https://github.com/gustavderdrache), [Boris Yankov](https://github.com/borisyankov), and [Nathan Bierema](https://github.com/Methuselah96).
61
\No newline at end of file