@syncfusion/ej2-maps 20.4.54 → 21.1.37

package/src/maps/maps.d.ts

@@ -31,7 +31,7 @@ import { IBubbleRenderingEventArgs, IAnimationCompleteEventArgs, IPrintEventArgs
 import { LayerPanel } from './layers/layer-panel';
 import { GeoLocation, Rect } from '../maps/utils/helper';
 import { Annotations } from '../maps/user-interaction/annotation';
-import { DataLabel, IAnnotationRenderingEventArgs } from './index';
+import { DataLabel, IAnnotationRenderingEventArgs, IMarkerDragEventArgs } from './index';
 import { NavigationLine } from './layers/navigation-selected-line';
 import { ExportType } from '../maps/utils/enum';
 import { PdfPageOrientation } from '@syncfusion/ej2-pdf-export';
@@ -39,7 +39,8 @@ import { Print } from './model/print';
 import { PdfExport } from './model/export-pdf';
 import { ImageExport } from './model/export-image';
 /**
- * Represents the Maps control.
+ * Represents the maps control. It is ideal for rendering maps from GeoJSON data or other map providers like OpenStreetMap, Google Maps, Bing Maps, etc that
+ * has rich feature set that includes markers, labels, bubbles and much more.
  * ```html
  * <div id="maps"/>
  * <script>
@@ -50,65 +51,85 @@ import { ImageExport } from './model/export-image';
  */
 export declare class Maps extends Component<HTMLElement> implements INotifyPropertyChanged {
     /**
-     * Sets and gets the module to add bubbles in the maps component.
+     * Gets or sets the module to add bubbles in the maps.
+     *
+     * @private
      */
     bubbleModule: Bubble;
     /**
-     * Sets and get the module to add the marker in the maps component.
+     * Sets and get the module to add the marker in the maps.
+     *
+     * @private
      */
     markerModule: Marker;
     /**
-     * Sets and gets the module to add the data-label in the maps component.
+     * Gets or sets the module to add the data-label in the maps.
+     *
+     * @private
      */
     dataLabelModule: DataLabel;
     /**
-     * Sets and gets the module to highlight the element when mouse has hovered on it in maps.
+     * Gets or sets the module to highlight the element when mouse has hovered on it in maps.
+     *
+     * @private
      */
     highlightModule: Highlight;
     /**
-     * Sets and gets the module to add the navigation lines in the maps component.
+     * Gets or sets the module to add the navigation lines in the maps.
+     *
+     * @private
      */
     navigationLineModule: NavigationLine;
     /**
-     * Sets and gets the module to add the legend in maps.
+     * Gets or sets the module to add the legend in maps.
+     *
+     * @private
      */
     legendModule: Legend;
     /**
-     * Sets and gets the module to select the geometric shapes when clicking in maps.
+     * Gets or sets the module to select the geometric shapes when clicking in maps.
+     *
+     * @private
      */
     selectionModule: Selection;
     /**
-     * Sets and gets the module to add the tooltip when mouse has hovered on an element in maps.
+     * Gets or sets the module to add the tooltip when mouse has hovered on an element in maps.
+     *
+     * @private
      */
     mapsTooltipModule: MapsTooltip;
     /**
-     * Sets and gets the module to add the zooming operations in maps.
+     * Gets or sets the module to add the zooming operations in maps.
+     *
+     * @private
      */
     zoomModule: Zoom;
     /**
-     * Sets and gets the module to add annotation elements in maps.
+     * Gets or sets the module to add annotation elements in maps.
+     *
+     * @private
      */
     annotationsModule: Annotations;
     /**
-     * This module enables the print functionality in Maps control.
+     * This module enables the print functionality in maps.
      *
      * @private
      */
     printModule: Print;
     /**
-     * This module enables the export to PDF functionality in Maps control.
+     * This module enables the export to PDF functionality in maps.
      *
      * @private
      */
     pdfExportModule: PdfExport;
     /**
-     * This module enables the export to image functionality in Maps control.
+     * This module enables the export to image functionality in maps.
      *
      * @private
      */
     imageExportModule: ImageExport;
     /**
-     * Sets and gets the background color of the maps container.
+     * Gets or sets the background color of the maps container.
      *
      * @default null
      */
@@ -120,25 +141,25 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     useGroupingSeparator: boolean;
     /**
-     * Sets and gets the format in which the text in the maps are to be rendered.
+     * Gets or sets the format to apply internationalization for the text in the maps.
      *
      * @default null
      */
     format: string;
     /**
-     * Sets and gets the width in which the maps is to be rendered.
+     * Gets or sets the width in which the maps is to be rendered.
      *
      * @default null
      */
     width: string;
     /**
-     * Sets and gets the height in which the maps is to be rendered.
+     * Gets or sets the height in which the maps is to be rendered.
      *
      * @default null
      */
     height: string;
     /**
-     * Sets and gets the mode in which the tooltip is to be displayed.
+     * Gets or sets the mode in which the tooltip is to be displayed.
      * The tooltip can be rendered on mouse move, click or double clicking on the
      * element on the map.
      *
@@ -146,91 +167,91 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     tooltipDisplayMode: TooltipGesture;
     /**
-     * Enables or disables the print functionality in map.
+     * Enables or disables the print functionality in maps.
      *
      * @default false
      */
     allowPrint: boolean;
     /**
-     * Enables or disables the export to image functionality in map.
+     * Enables or disables the export to image functionality in maps.
      *
      * @default false
      */
     allowImageExport: boolean;
     /**
-     * Enables or disables the export to PDF functionality in map.
+     * Enables or disables the export to PDF functionality in maps.
      *
      * @default false
      */
     allowPdfExport: boolean;
     /**
-     * Sets and gets the title to be displayed for maps.
+     * Gets or sets the options to customize the title of the maps.
      */
     titleSettings: TitleSettingsModel;
     /**
-     * Sets and gets the options to customize the zooming operations in maps.
+     * Gets or sets the options to customize the zooming operations in maps.
      */
     zoomSettings: ZoomSettingsModel;
     /**
-     * Sets and gets the options to customize the legend of the maps.
+     * Gets or sets the options to customize the legend of the maps.
      */
     legendSettings: LegendSettingsModel;
     /**
-     * Sets and gets the options to customize the layers of the maps.
+     * Gets or sets the options to customize the layers of the maps.
      */
     layers: LayerSettingsModel[];
     /**
-     * Sets and gets the options for customizing the annotation of maps.
+     * Gets or sets the options for customizing the annotations in the maps.
      */
     annotations: AnnotationModel[];
     /**
-     * Sets and gets the options to customize the margins of the maps.
+     * Gets or sets the options to customize the margin of the maps.
      */
     margin: MarginModel;
     /**
-     * Sets and gets the options for customizing the color and width of the maps border.
+     * Gets or sets the options for customizing the style properties of the maps border.
      */
     border: BorderModel;
     /**
-     * Set and gets the theme supported for the maps.
+     * Gets or sets the theme styles supported for maps. When the theme is set, the styles associated with the theme will be set in the maps.
      *
      * @default Material
      */
     theme: MapsTheme;
     /**
-     * Sets and gets the projection type for the maps.
+     * Gets or sets the projection with which the maps will be rendered to show the two-dimensional curved surface of a globe on a plane.
      *
      * @default Mercator
      */
     projectionType: ProjectionType;
     /**
-     * Sets and gets the base map index of maps. It provides the option to select which layer to be visible in the maps.
+     * Gets or sets the index of the layer of maps which will be the base layer. It provides the option to select which layer to be visible in the maps.
      *
      * @default 0
      */
     baseLayerIndex: number;
     /**
-     * Sets and gets the description for maps.
+     * Gets or sets the description of the maps for assistive technology.
      *
      * @default null
      */
     description: string;
     /**
-     * Sets and gets the tab index value for the maps.
+     * Gets or sets the tab index value for the maps.
      *
      * @default 1
      */
     tabIndex: number;
     /**
-     * Sets and gets the center position of the maps.
+     * Gets or sets the center position of the maps.
      */
     centerPosition: CenterPositionModel;
     /**
-     * Sets and gets the options to customize the area around the map.
+     * Gets or sets the options to customize the area around the map.
      */
     mapsArea: MapsAreaSettingsModel;
     /**
-     * Triggers when the map is on load.
+     * Triggers before the maps gets rendered.
      *
      * @event load
      */
@@ -273,7 +294,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     rightClick: EmitType<IMouseEventArgs>;
     /**
-     * Triggers when resizing the maps.
+     * Triggers to notify the resize of the maps when the window is resized.
      *
      * @event resize
      */
@@ -299,25 +320,25 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     tooltipRenderComplete: EmitType<ITooltipRenderCompleteEventArgs>;
     /**
-     * Triggers when clicking a shape in maps.
+     * Triggers when a shape is selected in the maps.
      *
      * @event shapeSelected
      */
     shapeSelected: EmitType<IShapeSelectedEventArgs>;
     /**
-     * Triggers when clicking the shape on maps and before the selection is applied.
+     * Triggers before the shape, bubble or marker gets selected.
      *
      * @event itemSelection
      */
     itemSelection: EmitType<ISelectionEventArgs>;
     /**
-     * Trigger when mouse move on the shape in maps and before the shape gets highlighted.
+     * Trigger before the shape, bubble or marker gets highlighted.
      *
      * @event itemHighlight
      */
     itemHighlight: EmitType<ISelectionEventArgs>;
     /**
-     * Triggers when mouse move on the shape in maps and before the shape gets highlighted.
+     * Triggers before the shape gets highlighted.
      *
      * @event shapeHighlight
      */
@@ -347,11 +368,23 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     markerClusterRendering: EmitType<IMarkerClusterRenderingEventArgs>;
     /**
-     * Triggers when clicking on the maps marker element.
+     * Triggers when clicking on a marker element.
      *
      * @event markerClick
      */
     markerClick: EmitType<IMarkerClickEventArgs>;
+    /**
+     * When the marker begins to drag on the map, this event is triggered.
+     *
+     * @event markerDragStart
+     */
+    markerDragStart: EmitType<IMarkerDragEventArgs>;
+    /**
+     * When the marker has stopped dragging on the map, this event is triggered.
+     *
+     * @event markerDragEnd
+     */
+    markerDragEnd: EmitType<IMarkerDragEventArgs>;
     /**
      * Triggers when clicking the marker cluster in maps.
      *
@@ -395,19 +428,19 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     bubbleMouseMove: EmitType<IBubbleMoveEventArgs>;
     /**
-     * Triggers after the animation completed in the maps component.
+     * Triggers after the animation is completed in the maps.
      *
      * @event animationComplete
      */
     animationComplete: EmitType<IAnimationCompleteEventArgs>;
     /**
-     * Triggers before rendering the annotation in maps.
+     * Triggers before rendering an annotation in the maps.
      *
      * @event annotationRendering
      */
     annotationRendering: EmitType<IAnnotationRenderingEventArgs>;
     /**
-     * Triggers before the zoom operations in the maps such as zoom in and zoom out.
+     * Triggers before the zoom operations such as zoom in and zoom out in the maps.
      *
      * @event zoom
      */
@@ -513,7 +546,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * Specifies whether the shape is selected in the maps or not.
      *
-     * @returns {boolean} - Returns the boolean value.
+     * @returns {boolean} - Returns a boolean value to specify whether the shape is selected in the maps or not.
      */
     readonly isShapeSelected: boolean;
     dataLabel: DataLabel;
@@ -593,6 +626,8 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
     /** @private */
     serverProcess: any;
     /** @private */
+    toolbarProperties: any;
+    /** @private */
     previousScale: number;
     /** @private */
     previousPoint: Point;
@@ -661,6 +696,8 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
     /** @private */
     previousTileWidth: number;
     /** @private */
+    markerDragId: string;
+    /** @private */
     previousTileHeight: number;
     /** @private */
     initialZoomLevel: number;
@@ -673,7 +710,11 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
     /** @private */
     markerClusterExpand: boolean;
     /** @private */
+    mouseMoveId: string;
+    /** @private */
     shapeSelectionItem: any[];
+    /** @private */
+    markerDragArgument: any;
     /**
      * Constructor for creating the widget
      *
@@ -692,6 +733,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param  {string} key - Specifies the key
      * @returns {string} - Returns the string value
+     * @private
      */
     getLocalizedLabel(key: string): string;
     /**
@@ -717,6 +759,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      * @param {LayerSettings} layer - Specifies the layer for the maps.
      * @param {string} dataType - Specifies the data type for maps.
      * @returns {void}
+     * @private
      */
     processResponseJsonData(processType: string, data?: any | string, layer?: LayerSettings, dataType?: string): void;
     private renderMap;
@@ -817,6 +860,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param {PointerEvent} e - Specifies the pointer event on maps.
      * @returns {void}
+     * @private
      */
     mouseLeaveOnMap(e: PointerEvent): void;
     private keyUpHandler;
@@ -835,10 +879,12 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param {PointerEvent} e - Specifies the pointer event on maps.
      * @returns {void}
+     * @private
      */
     mapsOnClick(e: PointerEvent): void;
     private clickHandler;
     private triggerShapeSelection;
+    private getMarkerClickLocation;
     private getClickLocation;
     private removeTileMap;
     /**
@@ -846,6 +892,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param {PointerEvent} e - Specifies the pointer event on maps.
      * @returns {boolean} - Returns the boolean value
+     * @private
      */
     mouseEndOnMap(e: PointerEvent): boolean;
     /**
@@ -853,6 +900,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param {PointerEvent} e - Specifies the pointer event on maps
      * @returns {void}
+     * @private
      */
     mouseDownOnMap(e: PointerEvent): void;
     /**
@@ -873,6 +921,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param {PointerEvent} e - Specifies the pointer event.
      * @returns {void}
+     * @private
      */
     mapsOnDoubleClick(e: PointerEvent): void;
     /**
@@ -880,6 +929,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param {PointerEvent} e - Specifies the pointer event on maps.
      * @returns {void}
+     * @private
      */
     mouseMoveOnMap(e: PointerEvent): void;
     /**
@@ -887,6 +937,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      *
      * @param {PointerEvent} e - Specifies the pointer event on maps.
      * @returns {void}
+     * @private
      */
     onMouseMove(e: PointerEvent): boolean;
     private legendTooltip;
@@ -895,10 +946,8 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
     /**
      * This method is used to zoom the map by specifying the center position.
      *
-     * @param {number} centerPosition - Specifies the center position
-     * @param {number} centerPosition.latitude - Specifies the latitude value for the center position
-     * @param {number} centerPosition.longitude - Specifies the longitude value for the center position
-     * @param {number} zoomFactor - Specifies the zoom factor for maps.
+     * @param {number} centerPosition - Specifies the location of the maps to be zoomed as geographical coordinates.
+     * @param {number} zoomFactor - Specifies the zoom factor for the maps.
      * @returns {void}
      */
     zoomByPosition(centerPosition: {
@@ -908,20 +957,20 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
     /**
      * This method is used to perform panning by specifying the direction.
      *
-     * @param {PanDirection} direction - Specifies the direction in which the panning is performed.
-     * @param {PointerEvent | TouchEvent} mouseLocation - Specifies the location of the mouse pointer in maps.
+     * @param {PanDirection} direction - Specifies the direction in which the panning must be performed.
+     * @param {PointerEvent | TouchEvent} mouseLocation - Specifies the location of the mouse pointer in maps in pixels.
      * @returns {void}
      */
     panByDirection(direction: PanDirection, mouseLocation?: PointerEvent | TouchEvent): void;
     /**
      * This method is used to add the layers dynamically to the maps.
      *
-     * @param {Object} layer - Specifies the layer for the maps.
+     * @param {Object} layer - Specifies the layer to be added in the maps.
      * @returns {void}
      */
     addLayer(layer: Object): void;
     /**
-     * This method is used to remove a layer from map.
+     * This method is used to remove a layer from the maps.
      *
      * @param {number} index - Specifies the index number of the layer to be removed.
      * @returns {void}
@@ -929,7 +978,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
     removeLayer(index: number): void;
     /**
      * This method is used to add markers dynamically in the maps.
-     * If we provide the index value of the layer in which the marker to be added and the coordinates
+     * If we provide the index value of the layer in which the marker to be added and the settings
      * of the marker as parameters, the marker will be added in the location.
      *
      * @param {number} layerIndex - Specifies the index number of the layer.
@@ -938,22 +987,22 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     addMarker(layerIndex: number, markerCollection: MarkerSettingsModel[]): void;
     /**
-     * This method is used to select the geometric shape element in the maps component.
+     * This method is used to select the geometric shape element in the maps.
      *
      * @param {number} layerIndex - Specifies the index of the layer in maps.
      * @param {string | string[]} propertyName - Specifies the property name from the data source.
-     * @param {string} name - Specifies the name of the shape that is selected.
-     * @param {boolean} enable - Specifies the shape selection to be enabled.
+     * @param {string} name - Specifies the name of the shape, which is mapped from the data source, that is selected.
+     * @param {boolean} enable - Specifies whether the shape should be selected or the selection should be removed.
      * @returns {void}
      */
     shapeSelection(layerIndex: number, propertyName: string | string[], name: string, enable?: boolean): void;
     /**
-     * This method is used to zoom the maps component based on the provided coordinates.
+     * This method is used to zoom the maps based on the provided coordinates.
      *
-     * @param {number} minLatitude - Specifies the minimum latitude to be zoomed.
-     * @param {number} minLongitude - Specifies the minimum latitude to be zoomed.
-     * @param {number} maxLatitude - Specifies the maximum latitude to be zoomed.
-     * @param {number} maxLongitude - Specifies the maximum longitude to be zoomed.
+     * @param {number} minLatitude - Specifies the minimum latitude of the location to be zoomed.
+     * @param {number} minLongitude - Specifies the minimum latitude of the location to be zoomed.
+     * @param {number} maxLatitude - Specifies the maximum latitude of the location to be zoomed.
+     * @param {number} maxLongitude - Specifies the maximum longitude of the location to be zoomed.
      * @returns {void}
      */
     zoomToCoordinates(minLatitude: number, minLongitude: number, maxLatitude: number, maxLongitude: number): void;
@@ -964,19 +1013,19 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     private removeShapeSelection;
     /**
-     * This method is used to set culture for maps component.
+     * This method is used to set culture for maps.
      *
      * @returns {void}
      */
     private setCulture;
     /**
-     * This method to set locale constants to the maps component.
+     * This method to set locale constants to the maps.
      *
      * @returns {void}
      */
     private setLocaleConstants;
     /**
-     * This method disposes the maps component.
+     * This method destroys the maps. This method removes the events associated with the maps and disposes the objects created for rendering and updating the maps.
      *
      * @returns {void}
      */
@@ -985,6 +1034,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      * Gets component name
      *
      * @returns {string} - Returns the string value
+     * @private
      */
     getModuleName(): string;
     /**
@@ -1048,27 +1098,27 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     getBubbleVisible(layer: LayerSettingsModel): boolean;
     /**
-     * This method handles the printing functionality for the maps component.
+     * This method handles the printing functionality for the maps.
      *
      * @param {string[] | string | Element} id - Specifies the element to be printed.
      * @returns {void}
      */
     print(id?: string[] | string | Element): void;
     /**
-     * This method handles the export functionality for the maps component.
+     * This method handles the export functionality for the maps.
      *
      * @param {ExportType} type - Specifies the type of the exported file.
      * @param {string} fileName - Specifies the name of the file with which the rendered maps need to be exported.
-     * @param {PdfPageOrientation} orientation - Specifies the orientation of the pdf document in exporting.
-     * @param {boolean} allowDownload - Specifies whether to download as a file or get as base64 string for the file
-     * @returns {Promise<string>} - Returns the string value.
+     * @param {PdfPageOrientation} orientation - Specifies the orientation of the PDF document while exporting.
+     * @param {boolean} allowDownload - Specifies whether to download as a file or get as base64 string for the file.
+     * @returns {Promise<string>} - Specifies the base64 string of the exported image which is returned when the `allowDownload` is set to false.
      */
     export(type: ExportType, fileName: string, orientation?: PdfPageOrientation, allowDownload?: boolean): Promise<string>;
     /**
      * This method is used to get the Bing maps URL.
      *
-     * @param {string} url - Specifies the URL of the maps.
-     * @returns {Promise<string>} - Returns the processed Bing URL as Promise.
+     * @param {string} url - Specifies the URL of the Bing maps along with the API key.
+     * @returns {Promise<string>} - Returns the processed Bing URL as `Promise`.
      */
     getBingUrlTemplate(url: string): Promise<string>;
     /**
@@ -1084,29 +1134,29 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
      */
     private findVisibleLayers;
     /**
-     * This method is used to get the geo location points.
+     * This method is used to get the geographical coordinates for location points in pixels when shape maps are rendered in the maps.
      *
-     * @param {number} layerIndex - Specifies the index number of the layer of the map.
-     * @param {number} x - Specifies the x value.
-     * @param {number} y - Specifies the y value.
-     * @returns {GeoPosition}- Returns the geo position
+     * @param {number} layerIndex - Specifies the index number of the layer of the maps.
+     * @param {number} x - Specifies the x value in pixel.
+     * @param {number} y - Specifies the y value in pixel.
+     * @returns {GeoPosition}- Returns the geographical coordinates.
      */
     getGeoLocation(layerIndex: number, x: number, y: number): GeoPosition;
     private clip;
     /**
-     * This method is used to get the geo location points when tile maps is rendered in the maps component.
+     * This method is used to get the geographical coordinates for location points in pixels when an online map provider is rendered in the maps.
      *
-     * @param {number} x - Specifies the x value
-     * @param {number} y - Specifies the y value
-     * @returns {GeoPosition} - Returns the position
+     * @param {number} x - Specifies the x value in pixel.
+     * @param {number} y - Specifies the y value in pixel.
+     * @returns {GeoPosition} - Returns the geographical coordinates.
      */
     getTileGeoLocation(x: number, y: number): GeoPosition;
     /**
-     * This method is used to convert the point to latitude and longitude in maps.
+     * This method is used to convert the point in pixels to latitude and longitude in maps.
      *
-     * @param {number} pageX - Specifies the x value for the page.
-     * @param {number} pageY - Specifies the y value for the page.
-     * @returns {Object} - Returns the object.
+     * @param {number} pageX - Specifies the x position value in pixels.
+     * @param {number} pageY - Specifies the y position value in pixels.
+     * @returns {Object} - Returns the latitude and longitude values.
      */
     pointToLatLong(pageX: number, pageY: number): Object;
 }