@amcharts/amcharts4
Version:
amCharts 4
93 lines (92 loc) • 3.33 kB
TypeScript
/**
* A collection of Map-related utility functions.
*/
/**
* ============================================================================
* IMPORTS
* ============================================================================
* @hidden
*/
import { IGeoPoint } from "../../core/defs/IGeoPoint";
/**
* Converts a multi-part polygon in X/Y coordinates to a geo-multipolygon in
* geo-points (lat/long).
*
* @param multiPolygon Source multi-polygon
* @return Geo-multipolygon
*/
export declare function multiPolygonToGeo(multiPolygon: Array<[Array<[number, number]>, Array<[number, number]>]>): Array<Array<Array<IGeoPoint>>>;
/**
* Converts a multiline in X/Y coordinates to a geo-multiline in geo-points
* (lat/long).
*
* @param multiLine Source multiline
* @return Geo-multiline
*/
export declare function multiLineToGeo(multiLine: Array<Array<[number, number]>>): Array<Array<IGeoPoint>>;
/**
* Converts multiple X/Y points into a lat/long geo-points.
*
* @param points Source points
* @return Geo-points
*/
export declare function multiPointToGeo(points: Array<[number, number]>): Array<IGeoPoint>;
/**
* Converts multiple X/Y points into a lat/long geo-points.
*
* @param points Source points
* @return Geo-points
*/
export declare function multiGeoToPoint(geoPoints: Array<IGeoPoint>): Array<[number, number]>;
/**
* Converts X/Y point into a lat/long geo-point.
*
* @param point Source point
* @return Geo-point
*/
export declare function pointToGeo(point: [number, number]): IGeoPoint;
/**
* Converts lat/long geo-point into a X/Y point.
*
* @param point Source geo-point
* @return X/Y point
*/
export declare function geoToPoint(geoPoint: IGeoPoint): [number, number];
/**
* Converts geo line (collection of lat/long coordinates) to screen line (x/y).
*
* @param multiGeoLine Source geo line
* @return Screen line
*/
export declare function multiGeoLineToMultiLine(multiGeoLine: Array<Array<IGeoPoint>>): Array<Array<[number, number]>>;
/**
* Converts a geo polygon (collection of lat/long coordinates) to screen
* polygon (x/y).
*
* @param multiGeoPolygon Source polygon
* @return Screen polygon
*/
export declare function multiGeoPolygonToMultipolygon(multiGeoPolygon: Array<[Array<IGeoPoint>, Array<IGeoPoint>]>): Array<Array<Array<[number, number]>>>;
/**
* Returns a set of geographical coordinates for the circle with a center
* at specific lat/long coordinates and radius (in degrees).
*
* @since 4.3.0
* @param longitude Center longitude
* @param latitude Center latitude
* @param radius Radius (degrees)
* @return Circle coordinates
*/
export declare function getCircle(longitude: number, latitude: number, radius: number): Array<Array<Array<[number, number]>>>;
/**
* Returns a set of screen coordinates that represents a "background" area
* between provided extremities.
*
* @since 4.3.0
* @param north North latitude
* @param east East longitude
* @param south South latitude
* @param west West longitude
* @return Polygon
*/
export declare function getBackground(north: number, east: number, south: number, west: number): Array<Array<Array<[number, number]>>>;