@syncfusion/ej2-maps 20.4.54 → 21.1.37

package/src/maps/utils/helper.d.ts

@@ -1,17 +1,17 @@
 import { Maps, FontModel, BorderModel, LayerSettings } from '../../index';
-import { Alignment, LayerSettingsModel } from '../index';
+import { Alignment, LayerSettingsModel, ZoomToolbarTooltipSettingsModel } from '../index';
 import { MarkerType, IShapeSelectedEventArgs, ITouches, IShapes, SelectionSettingsModel, IMarkerRenderingEventArgs, MarkerSettings, MarkerClusterData } from '../index';
 import { ExportType } from '../utils/enum';
 /**
- * Maps internal use of `Size` type
+ * Specifies the size information of an element.
  */
 export declare class Size {
     /**
-     * height value for size
+     * Specifies the height of an element.
      */
     height: number;
     /**
-     * width value for size
+     * Specifies the width of an element.
      */
     width: number;
     constructor(width: number, height: number);
@@ -30,6 +30,7 @@ export declare function stringToNumber(value: string, containerSize: number): nu
  *
  * @param {Maps} maps Specifies the maps instance
  * @returns {void}
+ * @private
  */
 export declare function calculateSize(maps: Maps): Size;
 /**
@@ -37,6 +38,7 @@ export declare function calculateSize(maps: Maps): Size;
  *
  * @param {Maps} maps Specifies the map instance
  * @returns {void}
+ * @private
  */
 export declare function createSvg(maps: Maps): void;
 /**
@@ -46,6 +48,7 @@ export declare function createSvg(maps: Maps): void;
  * @param {number} pageY - Specifies the pageY.
  * @param {Element} element - Specifies the element.
  * @returns {MapLocation} - Returns the location.
+ * @private
  */
 export declare function getMousePosition(pageX: number, pageY: number, element: Element): MapLocation;
 /**
@@ -53,6 +56,7 @@ export declare function getMousePosition(pageX: number, pageY: number, element:
  *
  * @param {number} deg Specifies the degree value
  * @returns {number} Returns the number
+ * @private
  */
 export declare function degreesToRadians(deg: number): number;
 /**
@@ -60,6 +64,7 @@ export declare function degreesToRadians(deg: number): number;
  *
  * @param {number} radian Specifies the radian value
  * @returns {number} Returns the number
+ * @private
  */
 export declare function radiansToDegrees(radian: number): number;
 /**
@@ -71,6 +76,7 @@ export declare function radiansToDegrees(radian: number): number;
  * @param {LayerSettings} layer - Specifies the layer settings.
  * @param {Maps} mapModel - Specifies the maps.
  * @returns {Point} - Returns the point values.
+ * @private
  */
 export declare function convertGeoToPoint(latitude: number, longitude: number, factor: number, layer: LayerSettings, mapModel: Maps): Point;
 /**
@@ -81,6 +87,7 @@ export declare function convertGeoToPoint(latitude: number, longitude: number, f
  * @param {MapLocation} tileTranslatePoint Specifies the tile translate point
  * @param {boolean} isMapCoordinates Specifies the boolean value
  * @returns {MapLocation} Returns the location value
+ * @private
  */
 export declare function convertTileLatLongToPoint(center: MapLocation, zoomLevel: number, tileTranslatePoint: MapLocation, isMapCoordinates: boolean): MapLocation;
 /**
@@ -89,6 +96,7 @@ export declare function convertTileLatLongToPoint(center: MapLocation, zoomLevel
  * @param {Maps} mapObject - Specifies the maps.
  * @param {number} val - Specifies the value.
  * @returns {number} - Returns the number.
+ * @private
  */
 export declare function xToCoordinate(mapObject: Maps, val: number): number;
 /**
@@ -97,6 +105,7 @@ export declare function xToCoordinate(mapObject: Maps, val: number): number;
  * @param {Maps} mapObject - Specifies the maps.
  * @param {number} val - Specifies the value.
  * @returns {number} - Returns the number.
+ * @private
  */
 export declare function yToCoordinate(mapObject: Maps, val: number): number;
 /**
@@ -105,6 +114,7 @@ export declare function yToCoordinate(mapObject: Maps, val: number): number;
  * @param {number} x - Specifies the x value.
  * @param {number} y - Specifies the y value.
  * @returns {Point} - Returns the point value.
+ * @private
  */
 export declare function aitoff(x: number, y: number): Point;
 /**
@@ -113,18 +123,21 @@ export declare function aitoff(x: number, y: number): Point;
  * @param {number} a - Specifies the a value
  * @param {number} b - Specifies the b value
  * @returns {number} - Returns the number
+ * @private
  */
 export declare function roundTo(a: number, b: number): number;
 /**
  *
  * @param {number} x - Specifies the x value
  * @returns {number} - Returns the number
+ * @private
  */
 export declare function sinci(x: number): number;
 /**
  *
  * @param {number} a - Specifies the a value
  * @returns {number} - Returns the number
+ * @private
  */
 export declare function acos(a: number): number;
 /**
@@ -134,6 +147,7 @@ export declare function acos(a: number): number;
  * @param {number} min Specifies the minimum value
  * @param {number} max Specifies the maximum value
  * @returns {number} Returns the value
+ * @private
  */
 export declare function calculateBound(value: number, min: number, max: number): number;
 /**
@@ -144,18 +158,19 @@ export declare function calculateBound(value: number, min: number, max: number):
  * @param {string} url Specifies the url
  * @param {boolean} isDownload Specifies whether download a file.
  * @returns {void}
+ * @private
  */
 export declare function triggerDownload(fileName: string, type: ExportType, url: string, isDownload: boolean): void;
 /**
- * Map internal class for point
+ * Specifies the information of the position of the point in maps.
  */
 export declare class Point {
     /**
-     * Point x value
+     * Defines the x position in pixels.
      */
     x: number;
     /**
-     * Point Y value
+     * Defines the y position in pixels.
      */
     y: number;
     constructor(x: number, y: number);
@@ -285,6 +300,7 @@ export declare class LineOption extends PathOption {
  * Internal use of line
  *
  * @property {number} Line - Specifies the line class
+ * @private
  */
 export declare class Line {
     x1: number;
@@ -296,6 +312,7 @@ export declare class Line {
 /**
  * Internal use of map location type
  *
+ * @private
  */
 export declare class MapLocation {
     /**
@@ -322,6 +339,7 @@ export declare class Rect {
 }
 /**
  * Defines the pattern unit types for drawing the patterns in maps.
+ * @private
  */
 export declare type patternUnits = 
 /** Specifies the user space for maps. */
@@ -332,6 +350,7 @@ export declare type patternUnits =
  * Internal use for pattern creation.
  *
  * @property {PatternOptions} PatternOptions - Specifies the pattern option class.
+ * @private
  */
 export declare class PatternOptions {
     id: string;
@@ -372,6 +391,7 @@ export declare function convertElement(element: HTMLCollection, markerId: string
  * @param {string} value - Specifies the value
  * @param {Maps} maps - Specifies the instance of the maps
  * @returns {string} - Returns the string value
+ * @private
  */
 export declare function formatValue(value: string, maps: Maps): string;
 /**
@@ -381,6 +401,7 @@ export declare function formatValue(value: string, maps: Maps): string;
  * @param {any} data - Specifies the data
  * @param {Maps} maps - Specifies the instance of the maps
  * @returns {string} - Returns the string value
+ * @private
  */
 export declare function convertStringToValue(stringTemplate: string, format: string, data: any, maps: Maps): string;
 /**
@@ -391,6 +412,7 @@ export declare function convertStringToValue(stringTemplate: string, format: str
  * @param {number} index - Specifies the index
  * @param {Maps} mapObj - Specifies the map object
  * @returns {HTMLElement} - Returns the html element
+ * @private
  */
 export declare function convertElementFromLabel(element: Element, labelId: string, data: any, index: number, mapObj: Maps): HTMLElement;
 /**
@@ -403,6 +425,7 @@ export declare function convertElementFromLabel(element: Element, labelId: strin
  * @param {Element} markerCollection - Specifies the marker collection
  * @param {Maps} maps - Specifies the instance of the maps
  * @returns {Element} - Returns the element
+ * @private
  */
 export declare function drawSymbols(shape: MarkerType, imageUrl: string, location: Point, markerID: string, shapeCustom: any, markerCollection: Element, maps: Maps): Element;
 /**
@@ -410,6 +433,7 @@ export declare function drawSymbols(shape: MarkerType, imageUrl: string, locatio
  * @param {any} data - Specifies the data
  * @param {string} value - Specifies the value
  * @returns {any} - Returns the data
+ * @private
  */
 export declare function getValueFromObject(data: any, value: string): any;
 /**
@@ -417,6 +441,7 @@ export declare function getValueFromObject(data: any, value: string): any;
  * @param {IMarkerRenderingEventArgs} eventArgs - Specifies the event arguments
  * @param {any} data - Specifies the data
  * @returns {IMarkerRenderingEventArgs} - Returns the arguments
+ * @private
  */
 export declare function markerColorChoose(eventArgs: IMarkerRenderingEventArgs, data: any): IMarkerRenderingEventArgs;
 /**
@@ -424,6 +449,7 @@ export declare function markerColorChoose(eventArgs: IMarkerRenderingEventArgs,
  * @param {IMarkerRenderingEventArgs} eventArgs - Specifies the event arguments
  * @param {any} data - Specifies the data
  * @returns {IMarkerRenderingEventArgs} - Returns the arguments
+ * @private
  */
 export declare function markerShapeChoose(eventArgs: IMarkerRenderingEventArgs, data: any): IMarkerRenderingEventArgs;
 /**
@@ -437,6 +463,7 @@ export declare function markerShapeChoose(eventArgs: IMarkerRenderingEventArgs,
  * @param {boolean} check - Specifies the boolean value
  * @param {boolean} zoomCheck - Specifies the boolean value
  * @returns {void}
+ * @private
  */
 export declare function clusterTemplate(currentLayer: LayerSettings, markerTemplate: HTMLElement | Element, maps: Maps, layerIndex: number, markerCollection: Element, layerElement: Element, check: boolean, zoomCheck: boolean): void;
 /**
@@ -445,6 +472,7 @@ export declare function clusterTemplate(currentLayer: LayerSettings, markerTempl
  * @param {Maps} maps - Specifies the instance of the maps
  * @param {Element | HTMLElement} markerElement - Specifies the marker element
  * @returns {void}
+ * @private
  */
 export declare function mergeSeparateCluster(sameMarkerData: MarkerClusterData[], maps: Maps, markerElement: Element | HTMLElement): void;
 /**
@@ -454,6 +482,7 @@ export declare function mergeSeparateCluster(sameMarkerData: MarkerClusterData[]
  * @param {Element | HTMLElement} markerElement - Specifies the marker element
  * @param {boolean} isDom - Specifies the boolean value
  * @returns {void}
+ * @private
  */
 export declare function clusterSeparate(sameMarkerData: MarkerClusterData[], maps: Maps, markerElement: Element | HTMLElement, isDom?: boolean): void;
 /**
@@ -470,6 +499,7 @@ export declare function clusterSeparate(sameMarkerData: MarkerClusterData[], map
  * @param {Maps} maps - Specifies the instance of the maps
  * @param {Element} markerCollection - Specifies the marker collection
  * @returns {Element} - Returns the element
+ * @private
  */
 export declare function marker(eventArgs: IMarkerRenderingEventArgs, markerSettings: MarkerSettings, markerData: any[], dataIndex: number, location: Point, transPoint: Point, markerID: string, offset: Point, scale: number, maps: Maps, markerCollection: Element): Element;
 /**
@@ -486,6 +516,7 @@ export declare function marker(eventArgs: IMarkerRenderingEventArgs, markerSetti
  * @param {Point} offset - Specifies the offset value
  * @param {Maps} maps - Specifies the instance of the maps
  * @returns {HTMLElement} - Returns the html element
+ * @private
  */
 export declare function markerTemplate(eventArgs: IMarkerRenderingEventArgs, templateFn: any, markerID: string, data: any, markerIndex: number, markerTemplate: HTMLElement, location: Point, transPoint: Point, scale: number, offset: Point, maps: Maps): HTMLElement;
 /**
@@ -709,6 +740,7 @@ export declare function getFieldData(dataSource: any[], fields: string[]): any[]
  * @param {string | string[]} propertyPath - Specifies the property path
  * @param {LayerSettingsModel} layer - Specifies the layer settings
  * @returns {number} - Returns the number
+ * @private
  */
 export declare function checkShapeDataFields(dataSource: any[], properties: any, dataPath: string, propertyPath: string | string[], layer: LayerSettingsModel): number;
 /**
@@ -725,6 +757,7 @@ export declare function checkPropertyPath(shapeData: string, shapePropertyPath:
  * @param {number} start - Specifies the start value
  * @param {number} end - Specifies the end value
  * @returns {MapLocation[]} - Returns the location
+ * @private
  */
 export declare function filter(points: MapLocation[], start: number, end: number): MapLocation[];
 /**
@@ -735,6 +768,7 @@ export declare function filter(points: MapLocation[], start: number, end: number
  * @param {number} minValue - Specifies the minValue
  * @param {number} maxValue -Specifies the maxValue
  * @returns {number} - Returns the number
+ * @private
  */
 export declare function getRatioOfBubble(min: number, max: number, value: number, minValue: number, maxValue: number): number;
 /**
@@ -744,6 +778,7 @@ export declare function getRatioOfBubble(min: number, max: number, value: number
  * @param {string} type - Specifies the type
  * @param {string} geometryType - Specified the type of the geometry
  * @returns {any} - Specifies the object
+ * @private
  */
 export declare function findMidPointOfPolygon(points: MapLocation[], type: string, geometryType?: string): any;
 /**
@@ -772,6 +807,7 @@ export declare function textTrim(maxWidth: number, text: string, font: FontModel
  * @param {Size} textSize - Specifies the text size
  * @param {string} type - Specifies the type
  * @returns {Point} - Returns the point values
+ * @private
  */
 export declare function findPosition(location: Rect, alignment: Alignment, textSize: Size, type: string): Point;
 /**
@@ -779,6 +815,7 @@ export declare function findPosition(location: Rect, alignment: Alignment, textS
  *
  * @param {string} id - Specifies the id
  * @returns {void}
+ * @private
  */
 export declare function removeElement(id: string): void;
 /**
@@ -787,6 +824,7 @@ export declare function removeElement(id: string): void;
  * @param {Maps} mapObject - Specifies the map object
  * @param {LayerSettings} layer - Specifies the layer settings
  * @returns {Point} - Returns the x and y points
+ * @private
  */
 export declare function calculateCenterFromPixel(mapObject: Maps, layer: LayerSettings): Point;
 /**
@@ -810,6 +848,7 @@ export declare function getZoomTranslate(mapObject: Maps, layer: LayerSettings,
  *
  * @param {Maps} map - Specifies the instance of the maps
  * @returns {void}
+ * @private
  */
 export declare function fixInitialScaleForTile(map: Maps): void;
 /**
@@ -817,6 +856,7 @@ export declare function fixInitialScaleForTile(map: Maps): void;
  *
  * @param {string} id - Specifies the id
  * @returns {Element} - Returns the element
+ * @private
  */
 export declare function getElementByID(id: string): Element;
 /**
@@ -833,6 +873,7 @@ export declare function getClientElement(id: string): ClientRect;
  * @param {Maps} maps - Specifies the instance of the maps
  * @param {number} value - Specifies the value
  * @returns {string} - Returns the string
+ * @private
  */
 export declare function Internalize(maps: Maps, value: number): string;
 /**
@@ -858,6 +899,7 @@ export declare function getElement(id: string): Element;
  * @param {string} targetId - Specifies the target id
  * @param {Maps} map - Specifies the instance of the maps
  * @returns {any} - Returns the object
+ * @private
  */
 export declare function getShapeData(targetId: string, map: Maps): {
     shapeData: any;
@@ -879,6 +921,7 @@ export declare function triggerShapeEvent(targetId: string, selection: Selection
  *
  * @param {string} className - Specifies the class name
  * @returns {HTMLCollectionOf<Element>} - Returns the collection
+ * @private
  */
 export declare function getElementsByClassName(className: string): HTMLCollectionOf<Element>;
 /**
@@ -890,6 +933,7 @@ export declare function getElementsByClassName(className: string): HTMLCollectio
  * @param {string} args - Specifies the args
  * @param {string} elementSelector - Specifies the element selector
  * @returns {Element} - Returns the element
+ * @private
  */
 export declare function querySelector(args: string, elementSelector: string): Element;
 /**
@@ -900,6 +944,7 @@ export declare function querySelector(args: string, elementSelector: string): El
  * @param {boolean} enable - Specifies the boolean value
  * @param {Maps} map - Specifies the instance of the maps
  * @returns {Element} - Returns the element
+ * @private
  */
 export declare function getTargetElement(layerIndex: number, name: string, enable: boolean, map: Maps): Element;
 /**
@@ -909,6 +954,7 @@ export declare function getTargetElement(layerIndex: number, name: string, enabl
  * @param {string} className - Specifies the class name
  * @param {IShapeSelectedEventArgs | any} eventArgs - Specifies the event args
  * @returns {Element} - Returns the element
+ * @private
  */
 export declare function createStyle(id: string, className: string, eventArgs: IShapeSelectedEventArgs | any): Element;
 /**
@@ -918,6 +964,7 @@ export declare function createStyle(id: string, className: string, eventArgs: IS
  * @param {string} className - Specifies the class name
  * @param {IShapeSelectedEventArgs | any} eventArgs - Specifies the event args
  * @returns {void}
+ * @private
  */
 export declare function customizeStyle(id: string, className: string, eventArgs: IShapeSelectedEventArgs | any): void;
 /**
@@ -929,6 +976,7 @@ export declare function customizeStyle(id: string, className: string, eventArgs:
  * @param {any} shapeData - Specifies the shape data
  * @param {any} data - Specifies the data
  * @returns {void}
+ * @private
  */
 export declare function triggerItemSelectionEvent(selectionSettings: SelectionSettingsModel, map: Maps, targetElement: Element, shapeData: any, data: any): void;
 /**
@@ -936,6 +984,7 @@ export declare function triggerItemSelectionEvent(selectionSettings: SelectionSe
  *
  * @param {Element} element - Specifies the element
  * @returns {void}
+ * @private
  */
 export declare function removeClass(element: Element): void;
 /**
@@ -955,6 +1004,7 @@ export declare function elementAnimate(element: Element, delay: number, duration
 /**
  * @param {string} id - Specifies the id
  * @returns {void}
+ * @private
  */
 export declare function timeout(id: string): void;
 /**
@@ -968,6 +1018,7 @@ export declare function timeout(id: string): void;
  * @param {Element} element - Specifies the element
  * @param {boolean} isTouch - Specifies the boolean value
  * @returns {void}
+ * @private
  */
 export declare function showTooltip(text: string, size: string, x: number, y: number, areaWidth: number, areaHeight: number, id: string, element: Element, isTouch?: boolean): void;
 /**
@@ -980,6 +1031,7 @@ export declare function showTooltip(text: string, size: string, x: number, y: nu
  * @param {number} areaWidth - Specifies the area width
  * @param {Element} element - Specifies the element
  * @returns {void}
+ * @private
  */
 export declare function wordWrap(tooltip: HTMLElement, text: string, x: number, y: number, size1: string[], width: number, areaWidth: number, element: Element): void;
 /**
@@ -987,11 +1039,15 @@ export declare function wordWrap(tooltip: HTMLElement, text: string, x: number,
  * @param {string} text - Specifies the text
  * @param {string} top - Specifies the top
  * @param {string} left - Specifies the left
- * @param {string} fontSize - Specifies the fontSize
+ * @param {ZoomToolbarTooltipSettingsModel} settings - Specifies the tooltip settings.
  * @returns {void}
  * @private
  */
-export declare function createTooltip(id: string, text: string, top: number, left: number, fontSize: string): void;
+export declare function createTooltip(id: string, text: string, top: number, left: number, settings: ZoomToolbarTooltipSettingsModel): void;
+/**
+ * @private
+ */
+export declare function getHexColor(color: string): any;
 /**
  * @param {Point} location - Specifies the location
  * @param {string} shape - Specifies the shape
@@ -1103,30 +1159,31 @@ export declare function zoomAnimate(element: Element, delay: number, duration: n
  * @param {Function} process - Specifies the process
  * @param {Function} end - Specifies the end
  * @returns {void}
+ * @private
  */
 export declare function animate(element: Element, delay: number, duration: number, process: any, end: any): void;
 /**
- * To get shape data file using Ajax.
+ * Defines the options to get shape data file using Ajax request.
  */
 export declare class MapAjax {
     /**
-     * MapAjax data options
+     * Defines the data options for the Ajax.
      */
     dataOptions: string | any;
     /**
-     * MapAjax type value
+     * Defines type of the Ajax.
      */
     type: string;
     /**
-     * MapAjax async value
+     * Defines whether the Ajax request is asynchronous or not.
      */
     async: boolean;
     /**
-     * MapAjax contentType value
+     * Defines the type of the content in Ajax request.
      */
     contentType: string;
     /**
-     * MapAjax sendData value
+     * Defines the data sent in the Ajax request.
      */
     sendData: string | any;
     constructor(options: string | any, type?: string, async?: boolean, contentType?: string, sendData?: string | any);
@@ -1148,6 +1205,7 @@ export declare function smoothTranslate(element: Element, delay: number, duratio
  * @param {number} scaleFactor - Specifies the scale factor
  * @param {Maps} maps - Specifies the instance of the maps
  * @returns {void}
+ * @private
  */
 export declare function compareZoomFactor(scaleFactor: number, maps: Maps): void;
 /**
@@ -1161,6 +1219,7 @@ export declare function compareZoomFactor(scaleFactor: number, maps: Maps): void
  * @param {number} mapHeight - Specifies the height of the maps
  * @param {Maps} maps - Specifies the instance of the maps
  * @returns {number} - Returns the scale factor
+ * @private
  */
 export declare function calculateZoomLevel(minLat: number, maxLat: number, minLong: number, maxLong: number, mapWidth: number, mapHeight: number, maps: Maps, isZoomToCoordinates: boolean): number;
 /**
@@ -1168,5 +1227,6 @@ export declare function calculateZoomLevel(minLat: number, maxLat: number, minLo
  *
  * @param {any} e - Specifies the any type value
  * @returns {any} - Returns the data value
+ * @private
  */
 export declare function processResult(e: any): any;