@syncfusion/ej2-maps 19.4.56 → 19.4.57-105067

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, Tile } 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, rightClick, loaded, doubleClick, resize, shapeSelected, itemSelection, zoomIn } from './model/constants';import { ProjectionType, MapsTheme, PanDirection, TooltipGesture } from './utils/enum';import { getThemeStyle } from './model/theme';import { BingMap } from './layers/bing-map';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, convertGeoToPoint, 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 {ComponentModel} from '@syncfusion/ej2-base';
 
 /**
@@ -7,360 +7,368 @@ import {ComponentModel} from '@syncfusion/ej2-base';
 export interface MapsModel extends ComponentModel{
 
     /**
-     * Sets and gets the background color of the maps container.
-     *
-     * @default null
-     */
-    background?: string;
+     * Sets and gets the background color of the maps container.
+     *
+     * @default null
+     */
+    background?: string;
 
     /**
-     * Enables or disables the visibility state of the separator for grouping.
-     *
-     * @default false
-     */
-    useGroupingSeparator?: boolean;
+     * Enables or disables the visibility state of the separator for grouping.
+     *
+     * @default false
+     */
+    useGroupingSeparator?: boolean;
 
     /**
-     * Sets and gets the format in which the text in the maps are to be rendered.
-     *
-     * @default null
-     */
-    format?: string;
+     * Sets and gets the format in which the text in the maps are to be rendered.
+     *
+     * @default null
+     */
+    format?: string;
 
     /**
-     * Sets and gets the width in which the maps is to be rendered.
-     *
-     * @default null
-     */
-    width?: string;
+     * Sets and gets 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.
-     *
-     * @default null
-     */
-    height?: string;
+     * Sets and gets 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.
-     * The tooltip can be rendered on mouse move, click or double clicking on the
-     * element on the map.
-     *
-     * @default 'MouseMove'
-     */
-    tooltipDisplayMode?: TooltipGesture;
+     * Sets and gets 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.
+     *
+     * @default 'MouseMove'
+     */
+    tooltipDisplayMode?: TooltipGesture;
 
     /**
-     * Enables or disables the print functionality in map.
-     *
-     * @default false
-     */
-    allowPrint?: boolean;
+     * Enables or disables the print functionality in map.
+     *
+     * @default false
+     */
+    allowPrint?: boolean;
 
     /**
-     * Enables or disables the export to image functionality in map.
-     *
-     * @default false
-     */
-    allowImageExport?: boolean;
+     * Enables or disables the export to image functionality in map.
+     *
+     * @default false
+     */
+    allowImageExport?: boolean;
 
     /**
-     * Enables or disables the export to PDF functionality in map.
-     *
-     * @default false
-     */
-    allowPdfExport?: boolean;
+     * Enables or disables the export to PDF functionality in map.
+     *
+     * @default false
+     */
+    allowPdfExport?: boolean;
 
     /**
-     * Sets and gets the title to be displayed for maps.
-     */
-    titleSettings?: TitleSettingsModel;
+     * Sets and gets the title to be displayed for maps.
+     */
+    titleSettings?: TitleSettingsModel;
 
     /**
-     * Sets and gets the options to customize the zooming operations in maps.
-     */
-    zoomSettings?: ZoomSettingsModel;
+     * Sets and gets the options to customize the zooming operations in maps.
+     */
+    zoomSettings?: ZoomSettingsModel;
 
     /**
-     * Sets and gets the options to customize the legend of the maps.
-     */
-    legendSettings?: LegendSettingsModel;
+     * Sets and gets the options to customize the legend of the maps.
+     */
+    legendSettings?: LegendSettingsModel;
 
     /**
-     * Sets and gets the options to customize the layers of the maps.
-     */
-    layers?: LayerSettingsModel[];
+     * Sets and gets the options to customize the layers of the maps.
+     */
+    layers?: LayerSettingsModel[];
 
     /**
-     * Sets and gets the options for customizing the annotation of maps.
-     */
-    annotations?: AnnotationModel[];
+     * Sets and gets the options for customizing the annotation of maps.
+     */
+    annotations?: AnnotationModel[];
 
     /**
-     * Sets and gets the options to customize the margins of the maps.
-     */
-    margin?: MarginModel;
+     * Sets and gets the options to customize the margins of the maps.
+     */
+    margin?: MarginModel;
 
     /**
-     * Sets and gets the options for customizing the color and width of the maps border.
-     */
-    border?: BorderModel;
+     * Sets and gets the options for customizing the color and width of the maps border.
+     */
+    border?: BorderModel;
 
     /**
-     * Set and gets the theme supported for the maps.
-     *
-     * @default Material
-     */
-    theme?: MapsTheme;
+     * Set and gets the theme supported for the maps.
+     *
+     * @default Material
+     */
+    theme?: MapsTheme;
 
     /**
-     * Sets and gets the projection type for the maps.
-     *
-     * @default Mercator
-     */
-    projectionType?: ProjectionType;
+     * Sets and gets the projection type for the maps.
+     *
+     * @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.
-     *
-     * @default 0
-     */
-    baseLayerIndex?: number;
+     * Sets and gets the base map index of maps. 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.
-     *
-     * @default null
-     */
-    description?: string;
+     * Sets and gets the description for maps.
+     *
+     * @default null
+     */
+    description?: string;
 
     /**
-     * Sets and gets the tab index value for the maps.
-     *
-     * @default 1
-     */
-    tabIndex?: number;
+     * Sets and gets the tab index value for the maps.
+     *
+     * @default 1
+     */
+    tabIndex?: number;
 
     /**
-     * Sets and gets the center position of the maps.
-     */
-    centerPosition?: CenterPositionModel;
+     * Sets and gets the center position of the maps.
+     */
+    centerPosition?: CenterPositionModel;
 
     /**
-     * Sets and gets the options to customize the area around the map.
-     */
-    mapsArea?: MapsAreaSettingsModel;
+     * Sets and gets the options to customize the area around the map.
+     */
+    mapsArea?: MapsAreaSettingsModel;
 
     /**
-     * Triggers when the map is on load.
-     *
-     * @event load
-     */
-    load?: EmitType<ILoadEventArgs>;
+     * Triggers when the map is on load.
+     *
+     * @event load
+     */
+    load?: EmitType<ILoadEventArgs>;
 
     /**
-     * Triggers before the print gets started.
-     *
-     * @event beforePrint
-     */
-    beforePrint?: EmitType<IPrintEventArgs>;
+     * Triggers before the print gets started.
+     *
+     * @event beforePrint
+     */
+    beforePrint?: EmitType<IPrintEventArgs>;
 
     /**
-     * Triggers after the maps gets rendered.
-     *
-     * @event loaded
-     */
-    loaded?: EmitType<ILoadedEventArgs>;
+     * Triggers after the maps gets rendered.
+     *
+     * @event loaded
+     */
+    loaded?: EmitType<ILoadedEventArgs>;
 
     /**
-     * Triggers when clicking an element in maps.
-     *
-     * @event click
-     */
-    click?: EmitType<IMouseEventArgs>;
+     * Triggers when a user clicks on an element in Maps.
+     *
+     * @event click
+     * @deprecated
+     */
+    click?: EmitType<IMouseEventArgs>;
 
     /**
-     * Triggers when performing the double click operation on an element in maps.
-     *
-     * @event doubleClick
-     */
-    doubleClick?: EmitType<IMouseEventArgs>;
+     * Triggers when a user clicks on an element in Maps.
+     *
+     * @event onclick
+     */
+    onclick?: EmitType<IMouseEventArgs>;
 
     /**
-     * Triggers when performing the right click operation on an element in maps.
-     *
-     * @event rightClick
-     */
-    rightClick?: EmitType<IMouseEventArgs>;
+     * Triggers when performing the double click operation on an element in maps.
+     *
+     * @event doubleClick
+     */
+    doubleClick?: EmitType<IMouseEventArgs>;
 
     /**
-     * Triggers when resizing the maps.
-     *
-     * @event resize
-     */
-    resize?: EmitType<IResizeEventArgs>;
+     * Triggers when performing the right click operation on an element in maps.
+     *
+     * @event rightClick
+     */
+    rightClick?: EmitType<IMouseEventArgs>;
 
     /**
-     * Triggers before the maps tooltip gets rendered.
-     *
-     * @event tooltipRender
-     */
-    tooltipRender?: EmitType<ITooltipRenderEventArgs>;
+     * Triggers when resizing the maps.
+     *
+     * @event resize
+     */
+    resize?: EmitType<IResizeEventArgs>;
 
     /**
-     * Triggers before the legend gets rendered.
-     *
-     * @event legendRendering
-
-     */
-    legendRendering?: EmitType<ILegendRenderingEventArgs>;
+     * Triggers before the maps tooltip gets rendered.
+     *
+     * @event tooltipRender
+     */
+    tooltipRender?: EmitType<ITooltipRenderEventArgs>;
 
     /**
-     * Triggers after the maps tooltip gets rendered.
-     *
+     * Triggers before the legend gets rendered.
+     *
+     * @event legendRendering
+     * @deprecated
+     */
+    legendRendering?: EmitType<ILegendRenderingEventArgs>;
 
-     * @event tooltipRenderComplete
-     */
-    tooltipRenderComplete?: EmitType<ITooltipRenderCompleteEventArgs>;
+    /**
+     * Triggers after the maps tooltip gets rendered.
+     *
+     * @deprecated
+     * @event tooltipRenderComplete
+     */
+    tooltipRenderComplete?: EmitType<ITooltipRenderCompleteEventArgs>;
 
     /**
-     * Triggers when clicking a shape in maps.
-     *
-     * @event shapeSelected
-     */
-    shapeSelected?: EmitType<IShapeSelectedEventArgs>;
+     * Triggers when clicking a shape in maps.
+     *
+     * @event shapeSelected
+     */
+    shapeSelected?: EmitType<IShapeSelectedEventArgs>;
 
     /**
-     * Triggers when clicking the shape on maps and before the selection is applied.
-     *
-     * @event itemSelection
-     */
-    itemSelection?: EmitType<ISelectionEventArgs>;
+     * Triggers when clicking the shape on maps and before the selection is applied.
+     *
+     * @event itemSelection
+     */
+    itemSelection?: EmitType<ISelectionEventArgs>;
 
     /**
-     * Trigger when mouse move on the shape in maps and before the shape gets highlighted.
-     *
-     * @event itemHighlight
-     */
-    itemHighlight?: EmitType<ISelectionEventArgs>;
+     * Trigger when mouse move on the shape in maps and before the shape gets highlighted.
+     *
+     * @event itemHighlight
+     */
+    itemHighlight?: EmitType<ISelectionEventArgs>;
 
     /**
-     * Triggers when mouse move on the shape in maps and before the shape gets highlighted.
-     *
-     * @event shapeHighlight
-     */
-    shapeHighlight?: EmitType<IShapeSelectedEventArgs>;
+     * Triggers when mouse move on the shape in maps and before the shape gets highlighted.
+     *
+     * @event shapeHighlight
+     */
+    shapeHighlight?: EmitType<IShapeSelectedEventArgs>;
 
     /**
-     * Triggers before the maps layer gets rendered.
-     *
-     * @event layerRendering
-     */
-    layerRendering?: EmitType<ILayerRenderingEventArgs>;
+     * Triggers before the maps layer gets rendered.
+     *
+     * @event layerRendering
+     */
+    layerRendering?: EmitType<ILayerRenderingEventArgs>;
 
     /**
-     * Triggers before the maps shape gets rendered.
-     *
-     * @event shapeRendering
-     */
-    shapeRendering?: EmitType<IShapeRenderingEventArgs>;
+     * Triggers before the maps shape gets rendered.
+     *
+     * @event shapeRendering
+     */
+    shapeRendering?: EmitType<IShapeRenderingEventArgs>;
 
     /**
-     * Triggers before the maps marker gets rendered.
-     *
-     * @event markerRendering
-     */
-    markerRendering?: EmitType<IMarkerRenderingEventArgs>;
+     * Triggers before the maps marker gets rendered.
+     *
+     * @event markerRendering
+     */
+    markerRendering?: EmitType<IMarkerRenderingEventArgs>;
 
     /**
-     * Triggers before the maps marker cluster gets rendered.
-     *
-     * @event markerClusterRendering
-     */
-    markerClusterRendering?: EmitType<IMarkerClusterRenderingEventArgs>;
+     * Triggers before the maps marker cluster gets rendered.
+     *
+     * @event markerClusterRendering
+     */
+    markerClusterRendering?: EmitType<IMarkerClusterRenderingEventArgs>;
 
     /**
-     * Triggers when clicking on the maps marker element.
-     *
-     * @event markerClick
-     */
-    markerClick?: EmitType<IMarkerClickEventArgs>;
+     * Triggers when clicking on the maps marker element.
+     *
+     * @event markerClick
+     */
+    markerClick?: EmitType<IMarkerClickEventArgs>;
 
     /**
-     * Triggers when clicking the marker cluster in maps.
-     *
-     * @event markerClusterClick
-     */
-    markerClusterClick?: EmitType<IMarkerClusterClickEventArgs>;
+     * Triggers when clicking the marker cluster in maps.
+     *
+     * @event markerClusterClick
+     */
+    markerClusterClick?: EmitType<IMarkerClusterClickEventArgs>;
 
     /**
-     * Triggers when moving the mouse over the marker cluster element in maps.
-     *
-     * @event markerClusterMouseMove
-     */
-    markerClusterMouseMove?: EmitType<IMarkerClusterMoveEventArgs>;
+     * Triggers when moving the mouse over the marker cluster element in maps.
+     *
+     * @event markerClusterMouseMove
+     */
+    markerClusterMouseMove?: EmitType<IMarkerClusterMoveEventArgs>;
 
     /**
-     * Triggers when moving the mouse over the marker element in maps.
-     *
-     * @event markerMouseMove
-     */
-    markerMouseMove?: EmitType<IMarkerMoveEventArgs>;
+     * Triggers when moving the mouse over the marker element in maps.
+     *
+     * @event markerMouseMove
+     */
+    markerMouseMove?: EmitType<IMarkerMoveEventArgs>;
 
     /**
-     * Triggers before the data-label gets rendered.
-     *
-     * @event dataLabelRendering
-     */
-    dataLabelRendering?: EmitType<ILabelRenderingEventArgs>;
+     * Triggers before the data-label gets rendered.
+     *
+     * @event dataLabelRendering
+     */
+    dataLabelRendering?: EmitType<ILabelRenderingEventArgs>;
 
     /**
-     * Triggers before the bubble element gets rendered on the map.
-     *
-     * @event bubbleRendering
-     */
-    bubbleRendering?: EmitType<IBubbleRenderingEventArgs>;
+     * Triggers before the bubble element gets rendered on the map.
+     *
+     * @event bubbleRendering
+     */
+    bubbleRendering?: EmitType<IBubbleRenderingEventArgs>;
 
     /**
-     * Triggers when performing the click operation on the bubble element in maps.
-     *
-     * @event bubbleClick
-     */
-    bubbleClick?: EmitType<IBubbleClickEventArgs>;
+     * Triggers when performing the click operation on the bubble element in maps.
+     *
+     * @event bubbleClick
+     */
+    bubbleClick?: EmitType<IBubbleClickEventArgs>;
 
     /**
-     * Triggers when hovering the mouse on the bubble element in maps.
-     *
-     * @event bubbleMouseMove
-     */
-    bubbleMouseMove?: EmitType<IBubbleMoveEventArgs>;
+     * Triggers when hovering the mouse on the bubble element in maps.
+     *
+     * @event bubbleMouseMove
+     */
+    bubbleMouseMove?: EmitType<IBubbleMoveEventArgs>;
 
     /**
-     * Triggers after the animation completed in the maps component.
-     *
-     * @event animationComplete
-     */
-    animationComplete?: EmitType<IAnimationCompleteEventArgs>;
+     * Triggers after the animation completed in the maps component.
+     *
+     * @event animationComplete
+     */
+    animationComplete?: EmitType<IAnimationCompleteEventArgs>;
 
     /**
-     * Triggers before rendering the annotation in maps.
-     *
-     * @event annotationRendering
-     */
-    annotationRendering?: EmitType<IAnnotationRenderingEventArgs>;
+     * Triggers before rendering the annotation in maps.
+     *
+     * @event annotationRendering
+     */
+    annotationRendering?: EmitType<IAnnotationRenderingEventArgs>;
 
     /**
-     * Triggers before the zoom operations in the maps such as zoom in and zoom out.
-     *
-     * @event zoom
-     */
-    zoom?: EmitType<IMapZoomEventArgs>;
+     * Triggers before the zoom operations in the maps such as zoom in and zoom out.
+     *
+     * @event zoom
+     */
+    zoom?: EmitType<IMapZoomEventArgs>;
 
     /**
-     * Triggers before performing the panning operation.
-     *
-     * @event pan
-     */
-    pan?: EmitType<IMapPanEventArgs>;
+     * Triggers before performing the panning operation.
+     *
+     * @event pan
+     */
+    pan?: EmitType<IMapPanEventArgs>;
 
 }