highcharts 9.3.2 → 10.1.0

package/modules/map.src.d.ts

@@ -15,19 +15,16 @@ export function factory(highcharts: typeof Highcharts): void;
 declare module "../highcharts.src" {
     interface Chart {
         /**
-         * Highmaps only. Get chart coordinates from latitude/longitude. Returns
-         * an object with x and y values corresponding to the `xAxis` and
-         * `yAxis`.
+         * Deprecated. Use `MapView.lonLatToProjectedUnits` instead.
          *
-         * @param latLon
+         * @param lonLat
          *        Coordinates.
          *
-         * @return X and Y coordinates in terms of chart axis values.
+         * @return X and Y coordinates in terms of projected values
          */
-        fromLatLonToPoint(latLon: MapLatLonObject): MapCoordinateObject;
+        fromLatLonToPoint(lonLat: MapLonLatObject): ProjectedXY;
         /**
-         * Highmaps only. Calculate latitude/longitude values for a point.
-         * Returns an object with the numeric properties `lat` and `lon`.
+         * Deprecated. Use `MapView.projectedUnitsToLonLat` instead.
          *
          * @param point
          *        A `Point` instance or anything containing `x` and `y`
@@ -35,7 +32,7 @@ declare module "../highcharts.src" {
          *
          * @return An object with `lat` and `lon` properties.
          */
-        fromPointToLatLon(point: (MapCoordinateObject|Point)): (MapLatLonObject|undefined);
+        fromPointToLatLon(point: (Point|ProjectedXY)): (MapLonLatObject|undefined);
         /**
          * Highcharts Maps only. Zoom in or out of the map. See also
          * Point#zoomTo. See Chart#fromLatLonToPoint for how to get the
@@ -66,8 +63,8 @@ declare module "../highcharts.src" {
          */
         mapZoom(howMuch?: number, xProjected?: number, yProjected?: number, chartX?: number, chartY?: number): void;
         /**
-         * Highmaps only. Get point from latitude and longitude using specified
-         * transform definition.
+         * Highcharts Maps only. Get point from latitude and longitude using
+         * specified transform definition.
          *
          * @param latLon
          *        A latitude/longitude object.
@@ -78,9 +75,9 @@ declare module "../highcharts.src" {
          *
          * @return An object with `x` and `y` properties.
          */
-        transformFromLatLon(latLon: MapLatLonObject, transform: any): MapCoordinateObject;
+        transformFromLatLon(latLon: MapLonLatObject, transform: any): ProjectedXY;
         /**
-         * Highmaps only. Get latLon from point using specified transform
+         * Highcharts Maps only. Get latLon from point using specified transform
          * definition. The method returns an object with the numeric properties
          * `lat` and `lon`.
          *
@@ -94,25 +91,12 @@ declare module "../highcharts.src" {
          *
          * @return An object with `lat` and `lon` properties.
          */
-        transformToLatLon(point: (MapCoordinateObject|Point), transform: any): (MapLatLonObject|undefined);
-    }
-    /**
-     * Result object of a map transformation.
-     */
-    interface MapCoordinateObject {
-        /**
-         * X coordinate on the map.
-         */
-        x: number;
-        /**
-         * Y coordinate on the map.
-         */
-        y: (number|null);
+        transformToLatLon(point: (Point|ProjectedXY), transform: any): (MapLonLatObject|undefined);
     }
     /**
      * A latitude/longitude object.
      */
-    interface MapLatLonObject {
+    interface MapLonLatObject {
         /**
          * The latitude.
          */
@@ -125,8 +109,8 @@ declare module "../highcharts.src" {
     interface Point {
         pointPadding?: number;
         /**
-         * In Highmaps, when data is loaded from GeoJSON, the GeoJSON item's
-         * properies are copied over here.
+         * In Highcharts Maps, when data is loaded from GeoJSON, the GeoJSON
+         * item's properies are copied over here.
          */
         properties: any;
         value?: (number|null);
@@ -139,6 +123,19 @@ declare module "../highcharts.src" {
         pointPadding?: number;
         value?: (number|null);
     }
+    /**
+     * Result object of a map transformation.
+     */
+    interface ProjectedXY {
+        /**
+         * X coordinate in projected units.
+         */
+        x: number;
+        /**
+         * Y coordinate in projected units
+         */
+        y: number;
+    }
     /**
      * Map-optimized chart. Use Chart for common charts.
      */
@@ -206,6 +203,35 @@ declare module "../highcharts.src" {
          *        What animation to use for redraw
          */
         fitToBounds(bounds: object, padding?: (number|string), redraw?: boolean, animation?: (boolean|Partial<AnimationOptionsObject>)): void;
+        /**
+         * Convert map coordinates in longitude/latitude to pixels
+         *
+         * @param lonLat
+         *        The map coordinates
+         *
+         * @return The pixel position
+         */
+        lonLatToPixels(lonLat: MapLonLatObject): (PositionObject|undefined);
+        /**
+         * Get projected units from longitude/latitude. Insets are accounted
+         * for. Returns an object with x and y values corresponding to positions
+         * on the projected plane.
+         *
+         * @param lonLat
+         *        Coordinates.
+         *
+         * @return X and Y coordinates in terms of projected values
+         */
+        lonLatToProjectedUnits(lonLat: MapLonLatObject): ProjectedXY;
+        /**
+         * Convert pixel position to longitude and latitude.
+         *
+         * @param pos
+         *        The position in pixels
+         *
+         * @return The map coordinates
+         */
+        pixelsToLonLat(pos: PositionObject): (MapLonLatObject|undefined);
         /**
          * Convert pixel position to projected units
          *
@@ -215,6 +241,17 @@ declare module "../highcharts.src" {
          * @return The position in projected units
          */
         pixelsToProjectedUnits(pos: PositionObject): PositionObject;
+        /**
+         * Calculate longitude/latitude values for a point or position. Returns
+         * an object with the numeric properties `lon` and `lat`.
+         *
+         * @param point
+         *        A `Point` instance or anything containing `x` and `y`
+         *        properties with numeric values.
+         *
+         * @return An object with `lat` and `lon` properties.
+         */
+        projectedUnitsToLonLat(point: (Point|ProjectedXY)): (MapLonLatObject|undefined);
         /**
          * Convert projected units to pixel position
          *
@@ -277,25 +314,25 @@ declare module "../highcharts.src" {
      */
     let maps: Record<string, any>;
     /**
-     * Highmaps only. Restructure a GeoJSON object in preparation to be read
-     * directly by the series.mapData option. The GeoJSON will be broken down to
-     * fit a specific Highcharts type, either `map`, `mapline` or `mappoint`.
-     * Meta data in GeoJSON's properties object will be copied directly over to
-     * Point.properties in Highmaps.
+     * Highcharts Maps only. Restructure a GeoJSON or TopoJSON object in
+     * preparation to be read directly by the series.mapData option. The object
+     * will be broken down to fit a specific Highcharts type, either `map`,
+     * `mapline` or `mappoint`. Meta data in GeoJSON's properties object will be
+     * copied directly over to Point.properties in Highcharts Maps.
      *
-     * @param geojson
-     *        The GeoJSON structure to parse, represented as a JavaScript object
-     *        rather than a JSON string.
+     * @param json
+     *        The GeoJSON or TopoJSON structure to parse, represented as a
+     *        JavaScript object.
      *
      * @param hType
-     *        The Highmaps series type to prepare for. Setting "map" will return
-     *        GeoJSON polygons and multipolygons. Setting "mapline" will return
-     *        GeoJSON linestrings and multilinestrings. Setting "mappoint" will
-     *        return GeoJSON points and multipoints.
+     *        The Highcharts Maps series type to prepare for. Setting "map" will
+     *        return GeoJSON polygons and multipolygons. Setting "mapline" will
+     *        return GeoJSON linestrings and multilinestrings. Setting
+     *        "mappoint" will return GeoJSON points and multipoints.
      *
      * @return An object ready for the `mapData` option.
      */
-    function geojson(geojson: GeoJSON, hType?: string): Array<any>;
+    function geojson(json: (GeoJSON|TopoJSON), hType?: string): Array<any>;
     /**
      * The factory function for creating new map charts. Creates a new MapChart
      * object with different default options than the basic Chart.