@syncfusion/ej2-maps 20.4.54 → 21.1.35

package/src/maps/model/interface.d.ts

@@ -6,7 +6,7 @@ import { Size } from '../utils/helper';
 import { LayerSettingsModel, MarkerSettingsModel, DataLabelSettingsModel, ShapeSettingsModel, MarkerType, LegendShape, Annotation, MarkerClusterSettingsModel } from '../index';
 import { ToolLocationModel, TextStyleModel } from '@syncfusion/ej2-svg-base';
 /**
- * Specifies the event arguments for the maps component.
+ * Specifies the event arguments for the maps.
  *
  * @private
  */
@@ -21,25 +21,27 @@ export interface IMapsEventArgs {
  */
 export interface IPrintEventArgs extends IMapsEventArgs {
     /**
-     * Specifies the html content that is printed. The html content returned is usually the id string of the maps.
+     * Specifies the HTML content that is printed. The HTML content returned is usually the id string of the maps.
      */
     htmlContent: Element;
 }
 /**
- * Specifies the event arguments for load event in maps.
+ * Specifies the event arguments for the loaded event in maps.
  */
 export interface ILoadedEventArgs extends IMapsEventArgs {
-    /** Defines the current maps instance.
+    /**
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
-    /** Defines the isResized argument.
+    /**
+     * Defines whether the maps is resized or not.
      */
     isResized: boolean;
 }
 /**
- * Specifies the event argument load event in maps.
+ * Specifies the event argument of the load event in maps.
  */
 export interface ILoadEventArgs extends IMapsEventArgs {
     /** Defines the current maps instance.
@@ -52,57 +54,59 @@ export interface ILoadEventArgs extends IMapsEventArgs {
  * Specifies the event arguments for the data-label event in maps.
  */
 export interface IDataLabelArgs extends IMapsEventArgs {
-    /** Defines the current maps instance.
+    /**
+     * Defines the current maps instance.
      *
 
      */
     maps: Maps;
     /**
-     * Defines the labels in maps.
+     * Defines the data label instance in maps.
      */
     dataLabel: DataLabelSettingsModel;
 }
 /**
- * Specifies the event arguments for mouse move event in maps.
+ * Specifies the event arguments for mouse event in maps.
  */
 export interface IMouseEventArgs extends IMapsEventArgs {
-    /** Defines the current mouse event target id */
+    /** Defines the current mouse event target id. */
     target: string;
-    /** Defines the current mouse x location. */
+    /** Defines the current mouse x location in pixels. */
     x: number;
-    /** Defines the current mouse y location. */
+    /** Defines the current mouse y location in pixels. */
     y: number;
-    /** Defines the current latitude value of maps location */
+    /** Defines the current latitude value of maps location. */
     latitude?: number;
     /** Defines the current longitude value of maps location */
     longitude?: number;
-    /** Specifies whether the shape is selected or not in the Map */
+    /** Specifies whether the shape is selected or not in the maps. */
     isShapeSelected?: boolean;
 }
 /**
- * Specifies the current position in maps.
+ * Specifies the location using geographical coordinates in maps.
  */
 export interface GeoPosition {
-    /** Specifies the current latitude value for the maps location. */
+    /** Specifies the latitude value for the maps location. */
     latitude?: number;
-    /** Specifies the current longitude value for the maps location. */
+    /** Specifies the longitude value for the maps location. */
     longitude?: number;
 }
 /**
  * Specifies the event arguments for tooltip render event in maps.
  */
 export interface ITooltipRenderCompleteEventArgs extends IMapsEventArgs {
-    /** Defines the current map instance.
+    /**
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Define the current tooltip element.
+     * Defines the current tooltip element.
      */
     element: Element;
     /**
-     * Define the tooltip options.
+     * Defines the options of the tooltip.
      */
     options: Object;
 }
@@ -110,11 +114,12 @@ export interface ITooltipRenderCompleteEventArgs extends IMapsEventArgs {
  * Specifies the event arguments for the resize event in maps.
  */
 export interface IResizeEventArgs extends IMapsEventArgs {
-    /** Defines the previous size of the maps before the resize event. */
+    /** Defines the size of the maps before the resize event. */
     previousSize: Size;
-    /** Defines the current size of the maps after the resize event. */
+    /** Defines the size of the maps after the resize event. */
     currentSize: Size;
-    /** Defines the current maps instance.
+    /**
+     * Defines the current maps instance.
      *
 
      */
@@ -140,29 +145,30 @@ export interface MapsTooltipOption {
  * Specifies the event arguments for tooltip render event in maps.
  */
 export interface ITooltipRenderEventArgs extends IMapsEventArgs {
-    /** Defines the current maps instance.
+    /**
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Define the content of the tooltip.
+     * Defines the content of the tooltip.
      */
     content?: string | HTMLElement;
     /**
-     * Define the tooltip options.
+     * Defines the options of the tooltip.
      */
     options?: Object;
     /**
-     * Defines the style of text for the tooltip in event argument.
+     * Defines the style of text for the tooltip.
      */
     textStyle?: FontModel;
     /**
-     * Defines the color and width of the border for the tooltip in event argument.
+     * Defines the settings of the border for the tooltip.
      */
     border?: BorderModel;
     /**
-     * Defines the color for the tooltip in event argument.
+     * Defines the color of the tooltip.
      */
     fill?: string;
     /**
@@ -174,7 +180,7 @@ export interface ITooltipRenderEventArgs extends IMapsEventArgs {
      */
     element: Element;
     /**
-     * Defines the original event arguments.
+     * Defines the original mouse event arguments.
      */
     eventArgs?: PointerEvent;
 }
@@ -182,7 +188,8 @@ export interface ITooltipRenderEventArgs extends IMapsEventArgs {
  * Specifies the event arguments for item selection event in maps.
  */
 export interface ISelectionEventArgs extends IMapsEventArgs {
-    /** Defines the current maps instance.
+    /**
+     * Defines the current maps instance.
      *
 
      */
@@ -196,19 +203,19 @@ export interface ISelectionEventArgs extends IMapsEventArgs {
      */
     opacity?: number;
     /**
-     * Defines the color and width of the border for the selected shape in maps.
+     * Defines the settings of the border for the selected shape in maps.
      */
     border?: BorderModel;
     /**
-     * Defines current mouse event target id.
+     * Defines target id of current mouse event.
      */
     target?: string;
     /**
-     * Defines the shape data for the maps.
+     * Defines the data from GeoJSON data for the current shape.
      */
     shapeData?: Object;
     /**
-     * Defines the data from the data source.
+     * Defines the data from the data source for the current shape or marker.
      */
     data?: Object;
 }
@@ -216,7 +223,8 @@ export interface ISelectionEventArgs extends IMapsEventArgs {
  * Specifies the event arguments for shape selected event in maps.
  */
 export interface IShapeSelectedEventArgs extends IMapsEventArgs {
-    /** Defines the current maps instance.
+    /**
+     * Defines the current maps instance.
      *
 
      */
@@ -230,21 +238,21 @@ export interface IShapeSelectedEventArgs extends IMapsEventArgs {
      */
     opacity?: number;
     /**
-     * Defines the color and width of the border for the selected element in maps.
+     * Defines the settings of the border for the selected shape in maps.
      */
     border?: BorderModel;
     /**
-     * Defines the shapeData for the currently clicked shape.
+     * Defines the data from the GeoJSON data for the currently selected shape.
      */
     shapeData?: Object;
     /**
-     * Defines the data source for the currently clicked shape.
+     * Defines the data from the data source for the currently selected shape.
      */
     data?: Object;
-    /** Defines the id string of current mouse event target. */
+    /** Defines the id string of the target of the current mouse event. */
     target?: string;
     /**
-     * Returns the shape details which are in selected state during multi-selection
+     * Returns the details of the shapes which are in selected state during multiple selection.
      */
     shapeDataCollection?: Object;
 }
@@ -268,7 +276,7 @@ export interface ILayerRenderingEventArgs extends IMapsEventArgs {
      */
     index?: number;
     /**
-     * Defines the maps instance in event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -289,29 +297,29 @@ export interface ILayerRenderingEventArgs extends IMapsEventArgs {
  */
 export interface IShapeRenderingEventArgs extends IMapsEventArgs {
     /**
-     * Defines the index value of shape rendering in the map.
+     * Defines the index value of the shape rendering in the maps.
      */
     index?: number;
     /**
-     * Defines the maps instance in event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the current shape settings in event argument.
+     * Defines the current shape settings.
      */
     shape?: ShapeSettingsModel;
     /**
-     * Defines the color for the current shape in event argument.
+     * Defines the color for the current shape.
      */
     fill?: string;
     /**
-     * Defines the color and width of the border for the current shape in event argument.
+     * Defines the settings of the border for the current shape.
      */
     border?: BorderModel;
     /**
-     * Defines the data for the shape from the data source in event argument.
+     * Defines the data from the data source for the shape which is being currently rendered.
      */
     data?: Object;
 }
@@ -320,7 +328,7 @@ export interface IShapeRenderingEventArgs extends IMapsEventArgs {
  */
 export interface IMarkerRenderingEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance in event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -330,19 +338,19 @@ export interface IMarkerRenderingEventArgs extends IMapsEventArgs {
      */
     marker?: MarkerSettingsModel;
     /**
-     * Defines the color for the marker in event argument.
+     * Defines the color of the marker which is currently rendered.
      */
     fill?: string;
     /**
-     * Defines the height of the marker in event argument.
+     * Defines the height of the marker which is currently rendered.
      */
     height?: number;
     /**
-     * Defines the width of the marker.
+     * Defines the width of the marker which is currently rendered.
      */
     width?: number;
     /**
-     * Defines the shape of the marker.
+     * Defines the shape of the marker which is currently rendered.
      */
     shape?: MarkerType;
     /**
@@ -354,23 +362,23 @@ export interface IMarkerRenderingEventArgs extends IMapsEventArgs {
      */
     template?: string;
     /**
-     * Defines the color and width of the border for the marker.
+     * Defines the settings of the border for the marker.
      */
     border?: BorderModel;
     /**
-     * Defines the marker data from the marker data source in maps.
+     * Defines the current marker data from the marker data source in maps.
      */
     data?: Object;
     /**
-     * Defines the value path of marker color from the marker data source.
+     * Defines the field name from the marker data source to set the color from the marker data source.
      */
     colorValuePath?: string;
     /**
-     * Defines the value path of marker shape from the marker data source.
+     * Defines the field name from the marker data source to set the marker shape from the marker data source.
      */
     shapeValuePath?: string;
     /**
-     * Defines the value path of marker image from the marker data source.
+     * Defines the field name from the marker data source to set the marker image from the marker data source.
      */
     imageUrlValuePath?: string;
 }
@@ -379,7 +387,7 @@ export interface IMarkerRenderingEventArgs extends IMapsEventArgs {
  */
 export interface IMarkerClusterRenderingEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -389,19 +397,19 @@ export interface IMarkerClusterRenderingEventArgs extends IMapsEventArgs {
      */
     cluster?: MarkerClusterSettingsModel;
     /**
-     * Defines the color for the marker cluster.
+     * Defines the color of the marker cluster.
      */
     fill?: string;
     /**
-     * Defines the height for the marker cluster.
+     * Defines the height of the marker cluster.
      */
     height?: number;
     /**
-     * Defines the width for the marker cluster.
+     * Defines the width of the marker cluster.
      */
     width?: number;
     /**
-     * Defines the shape for the marker cluster.
+     * Defines the shape of the marker cluster.
      */
     shape?: MarkerType;
     /**
@@ -409,11 +417,11 @@ export interface IMarkerClusterRenderingEventArgs extends IMapsEventArgs {
      */
     imageUrl?: string;
     /**
-     * Defines the color and width of the border for the marker cluster.
+     * Defines the settings of the border of the marker cluster.
      */
     border?: BorderModel;
     /**
-     * Defines the data for the marker cluster in maps.
+     * Defines the data from marker data source for the marker cluster in maps.
      */
     data?: Object;
 }
@@ -422,7 +430,7 @@ export interface IMarkerClusterRenderingEventArgs extends IMapsEventArgs {
  */
 export interface IMarkerClickEventArgs extends IMouseEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -436,22 +444,43 @@ export interface IMarkerClickEventArgs extends IMouseEventArgs {
      */
     value: string;
     /**
-     * Defines the marker data for the marker that is clicked.
+     * Defines the data from the marker data source for the marker that is clicked.
      */
     data?: Object;
 }
+/**
+ * Specifies the event arguments for marker click event in maps.
+ */
+export interface IMarkerDragEventArgs {
+    /** Defines the name of the event. */
+    name: string;
+    /** Defines the current x position of the mouse pointer when dragging is performed. */
+    x: number;
+    /** Defines the current y position of the mouse pointer when dragging is performed. */
+    y: number;
+    /** Defines the current latitude number of the marker with which the dragging operation is performed. */
+    latitude: number;
+    /** Defines the current longitude number of the marker with which the dragging operation is performed. */
+    longitude: number;
+    /** Defines the index of the layer in which the current marker is associated. */
+    layerIndex: number;
+    /** Defines the index of the marker settings in which the current marker is associated. */
+    markerIndex: number;
+    /** Defines the index of the current marker data from the entire data source. */
+    dataIndex: number;
+}
 /**
  * Specifies the event arguments for marker move event in maps.
  */
 export interface IMarkerMoveEventArgs extends IMouseEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the data of the marker in event argument.
+     * Defines the data from the marker data source for the marker over which the mouse is moved.
      */
     data?: Object;
 }
@@ -460,11 +489,11 @@ export interface IMarkerMoveEventArgs extends IMouseEventArgs {
  */
 export interface IMarkerClusterClickEventArgs extends IMouseEventArgs {
     /**
-     * Defines the currently clicked marker data.
+     * Defines the data from marker data source for the currently clicked marker.
      */
     data?: Object;
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -479,13 +508,13 @@ export interface IMarkerClusterClickEventArgs extends IMouseEventArgs {
  */
 export interface IMarkerClusterMoveEventArgs extends IMouseEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the data of the cluster of marker in event argument.
+     * Defines the data from marker data source for the currently clicked marker.
      */
     data?: Object;
 }
@@ -494,29 +523,29 @@ export interface IMarkerClusterMoveEventArgs extends IMouseEventArgs {
  */
 export interface ILabelRenderingEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the text for the data-label in event argument.
+     * Defines the text of the data-label which is being currently rendered.
      */
     text: string;
     /**
-     * Defines the right and left position of text for the data-label in event argument.
+     * Defines the right and left position of text for the data-label.
      */
     offsetX: number;
     /**
-     * Defines the top and bottom position of text for the data-label in event argument.
+     * Defines the top and bottom position of text for the data-label.
      */
     offsetY: number;
     /**
-     * Defines the color and width of the border for the data-label in event argument.
+     * Defines the settings of the border of the data-label.
      */
     border: BorderModel;
     /**
-     * Defines the color for the data-label in event argument.
+     * Defines the color of the data-label.
      */
     fill: string;
     /**
@@ -524,7 +553,7 @@ export interface ILabelRenderingEventArgs extends IMapsEventArgs {
      */
     template: string;
     /**
-     * Defines the instance of the data-label in event argument.
+     * Defines the instance of the data-label.
      */
     datalabel?: DataLabelSettingsModel;
 }
@@ -533,33 +562,33 @@ export interface ILabelRenderingEventArgs extends IMapsEventArgs {
  */
 export interface IBubbleRenderingEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the color for the bubble in event argument.
+     * Defines the color of the bubble in event argument.
      */
     fill?: string;
     /**
-     * Defines the color and width of the border for the bubble in event argument.
+     * Defines the settings of the border of the bubble in event argument.
      */
     border?: BorderModel;
     /**
-     * Defines the center x position for the current bubble.
+     * Defines the center x position of the current bubble.
      */
     cx?: number;
     /**
-     * Defines the center Y position for the current bubble.
+     * Defines the center Y position of the current bubble.
      */
     cy?: number;
     /**
-     * Defines the radius for the current bubble.
+     * Defines the radius of the current bubble.
      */
     radius?: number;
     /**
-     * Defines the data for the current bubble.
+     * Defines the data of the current bubble from data source.
      */
     data?: Object;
 }
@@ -574,7 +603,7 @@ export interface IBubbleClickEventArgs extends IMouseEventArgs {
      */
     maps?: Maps;
     /**
-     * Defines the current data for the bubble in event argument.
+     * Defines the current data from the data source of the bubble in event argument.
      */
     data?: Object;
 }
@@ -583,13 +612,13 @@ export interface IBubbleClickEventArgs extends IMouseEventArgs {
  */
 export interface IBubbleMoveEventArgs extends IMouseEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the data for the current bubble on which the mouse has hovered in event argument.
+     * Defines the data from the data source for the current bubble on which the mouse has hovered.
      */
     data?: Object;
 }
@@ -598,7 +627,7 @@ export interface IBubbleMoveEventArgs extends IMouseEventArgs {
  */
 export interface IAnimationCompleteEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -613,7 +642,7 @@ export interface IAnimationCompleteEventArgs extends IMapsEventArgs {
  */
 export interface ILegendRenderingEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -623,15 +652,15 @@ export interface ILegendRenderingEventArgs extends IMapsEventArgs {
      */
     fill?: string;
     /**
-     * Defines the options for customizing the color and width of the shape in legend.
+     * Defines the options for customizing the border of the shape in legend.
      */
     shapeBorder?: BorderModel;
     /**
-     * Defines the shape of the legend in maps.
+     * Defines the shape of the current legend item in maps.
      */
     shape?: LegendShape;
     /**
-     * Defines the text for legend.
+     * Defines the text of the current legend item.
      */
     text?: string | string[];
 }
@@ -640,13 +669,13 @@ export interface ILegendRenderingEventArgs extends IMapsEventArgs {
  */
 export interface IAnnotationRenderingEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance in event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the content for annotation in maps.
+     * Defines the content of the annotation which is being rendered.
      */
     content?: string;
     /**
@@ -659,13 +688,13 @@ export interface IAnnotationRenderingEventArgs extends IMapsEventArgs {
  */
 export interface IMapPanEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance in event argument.
+     * Defines the current maps instance.
      *
 
      */
     maps?: Maps;
     /**
-     * Defines the tile map translate point.
+     * Defines the translate point of the online map providers.
      */
     tileTranslatePoint?: Object;
     /**
@@ -673,19 +702,19 @@ export interface IMapPanEventArgs extends IMapsEventArgs {
      */
     translatePoint?: Object;
     /**
-     * Defines the zoom level for the tile map.
+     * Defines the zoom level of the online map providers.
      */
     tileZoomLevel?: number;
     /**
-     * Defines the scale value for the maps.
+     * Defines the scale value of the geometry maps.
      */
     scale?: number;
     /**
-     * Defines the latitude value of maps on pan event.
+     * Defines the latitude value of the maps on pan event.
      */
     latitude: number;
     /**
-     * Defines the longitude value of maps on pan event.
+     * Defines the longitude value of the maps on pan event.
      */
     longitude: number;
 }
@@ -694,7 +723,7 @@ export interface IMapPanEventArgs extends IMapsEventArgs {
  */
 export interface IMapZoomEventArgs extends IMapsEventArgs {
     /**
-     * Defines the maps instance event argument.
+     * Defines the current maps instance.
      *
 
      */
@@ -704,11 +733,11 @@ export interface IMapZoomEventArgs extends IMapsEventArgs {
      */
     type: string;
     /**
-     * Defines the tile translate point.
+     * Defines the translate point of the online map providers.
      */
     tileTranslatePoint?: Object;
     /**
-     * Defines the translate point of geometry map.
+     * Defines the translate point of the geometry map.
      */
     translatePoint?: Object;
     /**
@@ -716,13 +745,13 @@ export interface IMapZoomEventArgs extends IMapsEventArgs {
      */
     tileZoomLevel?: Object;
     /**
-     * Defines the scale value for the maps.
+     * Defines the scale value of the geometry maps.
      */
     scale?: Object;
 }
-/** @private */
 /**
  * Specifies the theme style for maps.
+ * @private
  */
 export interface IThemeStyle {
     /** Specifies the background color for the maps based on theme style. */