@syncfusion/ej2-maps 20.4.49 → 21.1.35

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

@@ -1,4 +1,4 @@
-import { Component, NotifyPropertyChanges, INotifyPropertyChanged, Property, Ajax } from '@syncfusion/ej2-base';import { EventHandler, Browser, EmitType, isNullOrUndefined, createElement, setValue, extend } from '@syncfusion/ej2-base';import { Event, remove, L10n, Collection, Internationalization, Complex } from '@syncfusion/ej2-base';import { ModuleDeclaration } from '@syncfusion/ej2-base';import { SvgRenderer } from '@syncfusion/ej2-svg-base';import { Size, createSvg, Point, removeElement, triggerShapeEvent, showTooltip, checkShapeDataFields, MapLocation, getMousePosition, calculateSize } from './utils/helper';import { getElement, removeClass, getTranslate, triggerItemSelectionEvent, mergeSeparateCluster, customizeStyle, querySelector } from './utils/helper';import { createStyle } from './utils/helper';import { ZoomSettings, LegendSettings } from './model/base';import { LayerSettings, TitleSettings, Border, Margin, MapsAreaSettings, Annotation, CenterPosition } from './model/base';import { ZoomSettingsModel, LegendSettingsModel, LayerSettingsModel, BubbleSettingsModel } from './model/base-model';import { MarkerSettingsModel, SelectionSettingsModel, InitialMarkerSelectionSettingsModel } from './model/base-model';import { TitleSettingsModel, BorderModel, MarginModel, CenterPositionModel, InitialShapeSelectionSettingsModel } from './model/base-model';import { MapsAreaSettingsModel, AnnotationModel } from './model/base-model';import { Bubble } from './layers/bubble';import { Legend } from './layers/legend';import { Marker } from './layers/marker';import { Highlight } from './user-interaction/highlight';import { Selection } from './user-interaction/selection';import { MapsTooltip } from './user-interaction/tooltip';import { Zoom } from './user-interaction/zoom';import { load, click, onclick, rightClick, loaded, doubleClick, resize, shapeSelected, itemSelection, zoomIn } from './model/constants';import { ProjectionType, MapsTheme, PanDirection, TooltipGesture } from './utils/enum';import { getThemeStyle, Theme } from './model/theme';import { ILoadEventArgs, ILoadedEventArgs, IMouseEventArgs, IResizeEventArgs, ITooltipRenderEventArgs } from './model/interface';import { GeoPosition, ITooltipRenderCompleteEventArgs, ILegendRenderingEventArgs } from './model/interface';import { ILayerRenderingEventArgs, IShapeRenderingEventArgs, IMarkerRenderingEventArgs, IMarkerClickEventArgs } from './model/interface';import { IMarkerMoveEventArgs, ILabelRenderingEventArgs, IBubbleMoveEventArgs, IBubbleClickEventArgs } from './model/interface';import { IMarkerClusterClickEventArgs, IMarkerClusterMoveEventArgs, IMarkerClusterRenderingEventArgs } from './model/interface';import { ISelectionEventArgs, IShapeSelectedEventArgs, IMapPanEventArgs, IMapZoomEventArgs } from './model/interface';import { IBubbleRenderingEventArgs, IAnimationCompleteEventArgs, IPrintEventArgs, IThemeStyle } from './model/interface';import { LayerPanel } from './layers/layer-panel';import { GeoLocation, Rect, RectOption, measureText, getElementByID, MapAjax, processResult, getElementsByClassName } from '../maps/utils/helper';import { findPosition, textTrim, TextOption, renderTextElement, calculateZoomLevel } from '../maps/utils/helper';import { Annotations } from '../maps/user-interaction/annotation';import { FontModel, DataLabel, MarkerSettings, IAnnotationRenderingEventArgs } from './index';import { NavigationLineSettingsModel, changeBorderWidth } from './index';import { NavigationLine } from './layers/navigation-selected-line';import { DataManager, Query } from '@syncfusion/ej2-data';import { ExportType } from '../maps/utils/enum';import { PdfPageOrientation } from '@syncfusion/ej2-pdf-export';import { Print } from './model/print';import { PdfExport } from './model/export-pdf';import { ImageExport } from './model/export-image';
+import { Component, NotifyPropertyChanges, INotifyPropertyChanged, Property, Ajax } from '@syncfusion/ej2-base';import { EventHandler, Browser, EmitType, isNullOrUndefined, createElement, setValue, extend } from '@syncfusion/ej2-base';import { Event, remove, L10n, Collection, Internationalization, Complex } from '@syncfusion/ej2-base';import { ModuleDeclaration } from '@syncfusion/ej2-base';import { SvgRenderer } from '@syncfusion/ej2-svg-base';import { Size, createSvg, Point, removeElement, triggerShapeEvent, showTooltip, checkShapeDataFields, MapLocation, getMousePosition, calculateSize } from './utils/helper';import { getElement, removeClass, getTranslate, triggerItemSelectionEvent, mergeSeparateCluster, customizeStyle, querySelector } from './utils/helper';import { createStyle } from './utils/helper';import { ZoomSettings, LegendSettings } from './model/base';import { LayerSettings, TitleSettings, Border, Margin, MapsAreaSettings, Annotation, CenterPosition } from './model/base';import { ZoomSettingsModel, LegendSettingsModel, LayerSettingsModel, BubbleSettingsModel } from './model/base-model';import { MarkerSettingsModel, SelectionSettingsModel, InitialMarkerSelectionSettingsModel } from './model/base-model';import { TitleSettingsModel, BorderModel, MarginModel, CenterPositionModel, InitialShapeSelectionSettingsModel } from './model/base-model';import { MapsAreaSettingsModel, AnnotationModel } from './model/base-model';import { Bubble } from './layers/bubble';import { Legend } from './layers/legend';import { Marker } from './layers/marker';import { Highlight } from './user-interaction/highlight';import { Selection } from './user-interaction/selection';import { MapsTooltip } from './user-interaction/tooltip';import { Zoom } from './user-interaction/zoom';import { load, click, onclick, rightClick, loaded, doubleClick, resize, shapeSelected, itemSelection, zoomIn } from './model/constants';import { ProjectionType, MapsTheme, PanDirection, TooltipGesture } from './utils/enum';import { getThemeStyle, Theme } from './model/theme';import { ILoadEventArgs, ILoadedEventArgs, IMouseEventArgs, IResizeEventArgs, ITooltipRenderEventArgs } from './model/interface';import { GeoPosition, ITooltipRenderCompleteEventArgs, ILegendRenderingEventArgs } from './model/interface';import { ILayerRenderingEventArgs, IShapeRenderingEventArgs, IMarkerRenderingEventArgs, IMarkerClickEventArgs } from './model/interface';import { IMarkerMoveEventArgs, ILabelRenderingEventArgs, IBubbleMoveEventArgs, IBubbleClickEventArgs } from './model/interface';import { IMarkerClusterClickEventArgs, IMarkerClusterMoveEventArgs, IMarkerClusterRenderingEventArgs } from './model/interface';import { ISelectionEventArgs, IShapeSelectedEventArgs, IMapPanEventArgs, IMapZoomEventArgs } from './model/interface';import { IBubbleRenderingEventArgs, IAnimationCompleteEventArgs, IPrintEventArgs, IThemeStyle } from './model/interface';import { LayerPanel } from './layers/layer-panel';import { GeoLocation, Rect, RectOption, measureText, getElementByID, MapAjax, processResult, getElementsByClassName } from '../maps/utils/helper';import { findPosition, textTrim, TextOption, renderTextElement, calculateZoomLevel, convertTileLatLongToPoint, convertGeoToPoint} from '../maps/utils/helper';import { Annotations } from '../maps/user-interaction/annotation';import { FontModel, DataLabel, MarkerSettings, IAnnotationRenderingEventArgs, IMarkerDragEventArgs } from './index';import { NavigationLineSettingsModel, changeBorderWidth } from './index';import { NavigationLine } from './layers/navigation-selected-line';import { DataManager, Query } from '@syncfusion/ej2-data';import { ExportType } from '../maps/utils/enum';import { PdfPageOrientation } from '@syncfusion/ej2-pdf-export';import { Print } from './model/print';import { PdfExport } from './model/export-pdf';import { ImageExport } from './model/export-image';
 import {ComponentModel} from '@syncfusion/ej2-base';
 
 /**
@@ -7,7 +7,7 @@ import {ComponentModel} from '@syncfusion/ej2-base';
 export interface MapsModel extends ComponentModel{
 
     /**
-     * Sets and gets the background color of the maps container.
+     * Gets or sets the background color of the maps container.
      *
      * @default null
      */
@@ -21,28 +21,28 @@ export interface MapsModel extends ComponentModel{
     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.
      *
@@ -51,108 +51,108 @@ export interface MapsModel extends ComponentModel{
     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
      */
@@ -202,7 +202,7 @@ export interface MapsModel extends ComponentModel{
     rightClick?: EmitType<IMouseEventArgs>;
 
     /**
-     * Triggers when resizing the maps.
+     * Triggers to notify the resize of the maps when the window is resized.
      *
      * @event resize
      */
@@ -232,28 +232,28 @@ export interface MapsModel extends ComponentModel{
     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
      */
@@ -288,12 +288,26 @@ export interface MapsModel extends ComponentModel{
     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.
      *
@@ -344,21 +358,21 @@ export interface MapsModel extends ComponentModel{
     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
      */