@syncfusion/ej2-maps 25.1.37 → 25.1.40

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

@@ -80,6 +80,11 @@ export declare function radiansToDegrees(radian: number): number;
  */
 export declare function convertGeoToPoint(latitude: number, longitude: number, factor: number, layer: LayerSettings, mapModel: Maps): Point;
 /**
+ * @param {Maps} maps - Specifies the map control.
+ * @param {number} factor - Specifies the factor.
+ * @param {LayerSettings} currentLayer - Specifies the current layer.
+ * @param {Coordinate} markerData - Specifies the marker data.
+ * @returns {string} - Returns the path.
  * @private
  */
 export declare function calculatePolygonPath(maps: Maps, factor: number, currentLayer: LayerSettings, markerData: Coordinate[]): string;
@@ -219,7 +224,11 @@ export declare class GeoLocation {
  * @private
  */
 export declare function measureText(text: string, font: FontModel): Size;
-/** @private */
+/**
+ * @param {string} text - Specifies the text.
+ * @param {FontModel} font - Specifies the font.
+ * @returns {Size} - Returns the size of text.
+ * @private */
 export declare function measureTextElement(text: string, font: FontModel): Size;
 /**
  * Internal use of text options
@@ -359,6 +368,7 @@ export declare class Rect {
 }
 /**
  * Defines the pattern unit types for drawing the patterns in maps.
+ *
  * @private
  */
 export declare type patternUnits = 
@@ -397,15 +407,16 @@ export declare class PatternOptions {
  */
 export declare function renderTextElement(option: TextOption, style: FontModel, color: string, parent: HTMLElement | Element, isMinus?: boolean): Element;
 /**
- * @param {HTMLCollection} element Specifies the html collection
- * @param {string} markerId Specifies the marker id
- * @param {any} data Specifies the data
- * @param {number} index Specifies the index
- * @param {Maps} mapObj Specifies the map object
- * @returns {HTMLCollection} Returns the html collection
+ * @param {HTMLCollection} element - Specifies the html collection
+ * @param {string} markerId - Specifies the marker id
+ * @param {object} data - Specifies the data
+ * @param {number} index - Specifies the index
+ * @param {Maps} mapObj - Specifies the map object
+ * @param {string} templateType - Specifies the template type
+ * @returns {HTMLElement} - Returns the html element
  * @private
  */
-export declare function convertElement(element: HTMLCollection, markerId: string, data: any, index: number, mapObj: Maps, templateType: string): HTMLElement;
+export declare function convertElement(element: HTMLCollection, markerId: string, data: object, index: number, mapObj: Maps, templateType: string): HTMLElement;
 /**
  *
  * @param {string} value - Specifies the value
@@ -418,23 +429,21 @@ export declare function formatValue(value: string, maps: Maps): string;
  *
  * @param {string} stringTemplate - Specifies the template
  * @param {string} format - Specifies the format
- * @param {any} data - Specifies the data
+ * @param {object} 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;
+export declare function convertStringToValue(stringTemplate: string, format: string, data: object, maps: Maps): string;
 /**
  *
  * @param {Element} element - Specifies the element
  * @param {string} labelId - Specifies the label id
- * @param {any} data - Specifies the data
- * @param {number} index - Specifies the index
- * @param {Maps} mapObj - Specifies the map object
+ * @param {object} data - Specifies the data
  * @returns {HTMLElement} - Returns the html element
  * @private
  */
-export declare function convertElementFromLabel(element: Element, labelId: string, data: any, index: number, mapObj: Maps): HTMLElement;
+export declare function convertElementFromLabel(element: Element, labelId: string, data: object): HTMLElement;
 /**
  *
  * @param {MarkerType} shape - Specifies the shape
@@ -450,28 +459,28 @@ export declare function convertElementFromLabel(element: Element, labelId: strin
 export declare function drawSymbols(shape: MarkerType, imageUrl: string, location: Point, markerID: string, shapeCustom: any, markerCollection: Element, maps: Maps): Element;
 /**
  *
- * @param {any} data - Specifies the data
+ * @param {object} 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;
+export declare function getValueFromObject(data: object, value: string): any;
 /**
  *
  * @param {IMarkerRenderingEventArgs} eventArgs - Specifies the event arguments
- * @param {any} data - Specifies the data
+ * @param {object} data - Specifies the data
  * @returns {IMarkerRenderingEventArgs} - Returns the arguments
  * @private
  */
-export declare function markerColorChoose(eventArgs: IMarkerRenderingEventArgs, data: any): IMarkerRenderingEventArgs;
+export declare function markerColorChoose(eventArgs: IMarkerRenderingEventArgs, data: object): IMarkerRenderingEventArgs;
 /**
  *
  * @param {IMarkerRenderingEventArgs} eventArgs - Specifies the event arguments
- * @param {any} data - Specifies the data
+ * @param {object} data - Specifies the data
  * @returns {IMarkerRenderingEventArgs} - Returns the arguments
  * @private
  */
-export declare function markerShapeChoose(eventArgs: IMarkerRenderingEventArgs, data: any): IMarkerRenderingEventArgs;
+export declare function markerShapeChoose(eventArgs: IMarkerRenderingEventArgs, data: object): IMarkerRenderingEventArgs;
 /**
  *
  * @param {LayerSettings} currentLayer - Specifies the current layer
@@ -482,23 +491,36 @@ export declare function markerShapeChoose(eventArgs: IMarkerRenderingEventArgs,
  * @param {Element} layerElement - Specifies the layer element
  * @param {boolean} check - Specifies the boolean value
  * @param {boolean} zoomCheck - Specifies the boolean value
- * @returns {void}
+ * @returns {boolean} -Returns boolean for cluster completion
  * @private
  */
 export declare function clusterTemplate(currentLayer: LayerSettings, markerTemplate: HTMLElement | Element, maps: Maps, layerIndex: number, markerCollection: Element, layerElement: Element, check: boolean, zoomCheck: boolean): boolean;
-/** @private */
+/**
+ * @param {Maps} maps - Specifies the map control.
+ * @param {number} currentZoomFactor - Specifies the current zoom factor.
+ * @param {number} layerIndex - Specifies the layer index.
+ * @param {number} index - Specifies the index.
+ * @param {number} indexCollection - Specifies the index Collection.
+ * @returns {void}
+ * @private */
 export declare function markerClusterListHandler(maps: Maps, currentZoomFactor: number, layerIndex: number, index: number, indexCollection: number[]): void;
-/** @private */
+/**
+ * @param {Element} tempElement - Specifies the temp element.
+ * @param {ClientRect} markerBounds - Specifies the marker bounds.
+ * @param {ClientRect} colloideBounds - Specifies the colloide Bounds.
+ * @param {number[]} indexCollection - Specifies the index collection.
+ * @param {number} p - Specifies the p.
+ * @returns {void}
+ * @private */
 export declare function markerBoundsComparer(tempElement: Element, markerBounds: ClientRect, colloideBounds: ClientRect[], indexCollection: number[], p: number): void;
 /**
  *
  * @param {MarkerClusterData[]} sameMarkerData - Specifies the marker data
  * @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;
+export declare function mergeSeparateCluster(sameMarkerData: MarkerClusterData[], maps: Maps): void;
 /**
  *
  * @param {MarkerClusterData[]} sameMarkerData - Specifies the marker data
@@ -771,10 +793,10 @@ export declare function checkShapeDataFields(dataSource: any[], properties: any,
  *
  * @param {string} shapeData - Specifies the shape data
  * @param {string | string[]} shapePropertyPath -  Specifies the shape property path
- * @param {any} shape -  Specifies the shape
+ * @param {object} shape -  Specifies the shape
  * @returns {string} - Returns the string value
  */
-export declare function checkPropertyPath(shapeData: string, shapePropertyPath: string | string[], shape: any): string;
+export declare function checkPropertyPath(shapeData: string, shapePropertyPath: string | string[], shape: object): string;
 /**
  *
  * @param {MapLocation[]} points - Specifies the location
@@ -819,6 +841,9 @@ export declare function isCustomPath(layerData: any[]): boolean;
  * @param {number} maxWidth - Specifies the maximum width
  * @param {string} text - Specifies the text
  * @param {FontModel} font - Specifies the font
+ * @param {number} width - Specifies the width of text
+ * @param {boolean} isCanvasMeasure - checks the canvas measure
+ * @param {number[]} widthList - Specifies the width list
  * @returns {string} - Returns the string
  * @private
  */
@@ -903,9 +928,9 @@ export declare function Internalize(maps: Maps, value: number): string;
 /**
  * Function to compile the template function for maps.
  *
- * @param {string} template - Specifies the template
+ * @param {string | Function} template - Specifies the template
  * @param {Maps} maps - Specifies the Maps instance.
- * @returns {Function} - Returns the function
+ * @returns {any} - Returns the template function
  * @private
  */
 export declare function getTemplateFunction(template: string | Function, maps: Maps): any;
@@ -922,7 +947,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
+ * @returns {object} - Returns the object
  * @private
  */
 export declare function getShapeData(targetId: string, map: Maps): {
@@ -997,12 +1022,12 @@ export declare function customizeStyle(id: string, className: string, eventArgs:
  * @param {SelectionSettingsModel} selectionSettings - Specifies the selection settings
  * @param {Maps} map - Specifies the instance of the maps
  * @param {Element} targetElement - Specifies the target element
- * @param {any} shapeData - Specifies the shape data
- * @param {any} data - Specifies the data
+ * @param {object} shapeData - Specifies the shape data
+ * @param {object} data - Specifies the data
  * @returns {void}
  * @private
  */
-export declare function triggerItemSelectionEvent(selectionSettings: SelectionSettingsModel, map: Maps, targetElement: Element, shapeData: any, data: any): void;
+export declare function triggerItemSelectionEvent(selectionSettings: SelectionSettingsModel, map: Maps, targetElement: Element, shapeData: object, data: object): void;
 /**
  * Function to remove class from element
  *
@@ -1061,14 +1086,16 @@ export declare function wordWrap(tooltip: HTMLElement, text: string, x: number,
 /**
  * @param {string} id - Specifies the id
  * @param {string} text - Specifies the text
- * @param {string} top - Specifies the top
- * @param {string} left - Specifies the left
+ * @param {number} top - Specifies the top
+ * @param {number} left - Specifies the left
  * @param {ZoomToolbarTooltipSettingsModel} settings - Specifies the tooltip settings.
  * @returns {void}
  * @private
  */
 export declare function createTooltip(id: string, text: string, top: number, left: number, settings: ZoomToolbarTooltipSettingsModel): void;
 /**
+ * @param {string} color - Specifies the color
+ * @returns {any} - Returns the color in rgb
  * @private
  */
 export declare function getHexColor(color: string): any;
@@ -1185,7 +1212,7 @@ export declare function zoomAnimate(element: Element, delay: number, duration: n
  * @returns {void}
  * @private
  */
-export declare function animate(element: Element, delay: number, duration: number, process: any, end: any): void;
+export declare function animate(element: Element, delay: number, duration: number, process: Function, end: Function): void;
 /**
  * Defines the options to get shape data file using Ajax request.
  */
@@ -1242,6 +1269,7 @@ export declare function compareZoomFactor(scaleFactor: number, maps: Maps): void
  * @param {number} mapWidth - Specifies the width of the maps
  * @param {number} mapHeight - Specifies the height of the maps
  * @param {Maps} maps - Specifies the instance of the maps
+ * @param {boolean} isZoomToCoordinates - Checks for the zoom to coordinates
  * @returns {number} - Returns the scale factor
  * @private
  */