@syncfusion/ej2-angular-maps 20.4.54-ngcc → 21.1.35-ngcc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  import { ViewContainerRef } from '@angular/core';
2
2
  import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
3
3
  /**
4
- * Layer Directive
4
+ * Represents the directive to define the layer of the maps.
5
5
  * ```html
6
6
  * <e-layers>
7
7
  * <e-layer></e-layer>
@@ -17,126 +17,131 @@ export declare class LayerDirective extends ComplexBase<LayerDirective> {
17
17
  childNavigationLineSettings: any;
18
18
  tags: string[];
19
19
  /**
20
- * Sets and gets the type of the layer in maps.
20
+ * Gets or sets the type of the layer in maps. There are two types: Layer and SubLayer.
21
21
  * @default Layer
22
22
  */
23
23
  type: any;
24
24
  /**
25
- * Sets and gets the duration for the animation of layers in maps.
25
+ * Gets or sets the duration of the animation of layers when the zooming is performed in maps.
26
26
  * @default 0
27
27
  */
28
28
  animationDuration: any;
29
29
  /**
30
- * Sets and gets the Bing map type for the layer. If you use shape data with BingMapType without using layer type as Bing,
31
- * then the map will render based on shape data since default layer type will be set as Geometry.
30
+ * Gets or sets the Bing map type for the layer. If you set GeoJSON data in the map and set the `BingMapType` value without setting the layer type as "Bing",
31
+ * then the map will be rendered based on the provided shape data since the default layer type will be set as "Geometry".
32
32
 
33
33
  * @default Aerial
34
34
  */
35
35
  bingMapType: any;
36
36
  /**
37
- * Sets and gets the options for customizing the bubble in maps.
37
+ * Gets or sets the options for customizing the bubbles in maps.
38
38
  */
39
39
  bubbleSettings: any;
40
40
  /**
41
- * Sets and gets the options for customizing the data-label in maps.
41
+ * Gets or sets the options for customizing the data labels in maps.
42
42
  */
43
43
  dataLabelSettings: any;
44
44
  /**
45
- * * Sets and gets the data source for the layer.
46
- * * The data source can contain data that can be bound to the tooltip, marker, and bubble.
45
+ * Gets or sets the data source for the layer.
46
+ * The data bound to the shapes using data source can be used to display the tooltip, marker, and bubble.
47
47
  * @isobservable true
48
48
  * @default []
49
49
  */
50
50
  dataSource: any;
51
51
  /**
52
- * Sets and gets the geometry type for the layer in maps.
52
+ * Gets or sets the geometry type for the layer in maps. There are two types: Geographic and Normal.
53
+ * * Geographic type renders the shape maps with geographical coordinate system.
54
+ * * Normal type renders the shape maps using default coordinate system.
53
55
  * @default Geographic
54
56
  */
55
57
  geometryType: any;
56
58
  /**
57
- * Sets and gets the options for customizing the shapes when the mouse has hovered on maps.
59
+ * Gets or sets the options for customizing the shapes when the mouse hovers over maps.
58
60
  */
59
61
  highlightSettings: any;
60
62
  /**
61
- * Sets and gets the settings for shapes that is selected at the time of rendering.
63
+ * Gets or sets the settings for the shapes to be selected when the maps rendering initially.
64
+ * The initial selection of shapes will be performed only when the selection functionality of layer is enabled.
62
65
  */
63
66
  initialShapeSelection: any;
64
67
  /**
65
- * Sets and gets the key for the tile map layer in maps.
68
+ * Gets or sets the key for the online map provider to render in the layer of the maps.
66
69
 
67
70
  * @default ''
68
71
  */
69
72
  key: any;
70
73
  /**
71
- * Sets and gets the type of the layer in maps. If we use layer type with shape data property in layer of the maps
74
+ * Gets or sets the type of the layer in maps. If we use layer type with shape data property in layer of the maps
72
75
  * then map will render based on the provided layer type.
73
76
 
74
77
  * @default Geometry
75
78
  */
76
79
  layerType: any;
77
80
  /**
78
- * Sets and gets the options for customizing the cluster of markers in maps.
81
+ * Gets or sets the options for customizing the cluster of markers in maps.
79
82
  */
80
83
  markerClusterSettings: any;
81
84
  /**
82
- * Sets and gets the options for customizing the marker in maps.
85
+ * Gets or sets the options for customizing the markers in maps.
83
86
  */
84
87
  markerSettings: any;
85
88
  /**
86
- * Sets and gets the options for customizing the navigation line in maps.
89
+ * Gets or sets the options for customizing the navigation lines in maps.
87
90
  */
88
91
  navigationLineSettings: any;
89
92
  /**
90
- * Sets and gets the query to select particular data from the shape data.
93
+ * Gets or sets the query to select particular data from the layer data source.
91
94
  * This property is applicable only when the data source is created by data manager.
92
95
  * @default null
93
96
  */
94
97
  query: any;
95
98
  /**
96
- * Sets and gets the options for customizing the shapes when clicking the shapes in maps.
99
+ * Gets or sets the options for customizing the shapes when clicking on the shapes in maps.
97
100
  */
98
101
  selectionSettings: any;
99
102
  /**
100
- * Sets and gets the shape data for the maps to render.
103
+ * Gets or sets the data for the maps to render.
104
+ * The data is normally JSON object with GeoJSON format that defines the shapes and geometries of the map.
101
105
  * @isobservable true
102
106
  * @default null
103
107
  */
104
108
  shapeData: any;
105
109
  /**
106
- * Sets and gets the path for the shape from the shape data in maps.
110
+ * Gets or sets the field name from the GeoJSON data to map the shape to the data defined in the layer data source.
107
111
  * @default 'name'
108
112
  */
109
113
  shapeDataPath: any;
110
114
  /**
111
- * Sets and gets the path for the layers from the layer data source in maps.
115
+ * Gets or sets the field name from the data source to map the shape to the data defined in the layer data source.
112
116
  * @default 'name'
113
117
  */
114
118
  shapePropertyPath: any;
115
119
  /**
116
- * Sets and gets the options to customize the shape of the maps.
120
+ * Gets or sets the options to customize the shape of the maps.
117
121
  */
118
122
  shapeSettings: any;
119
123
  /**
120
- * Sets and gets the type of the static maps.
124
+ * Gets or sets the type of the static maps.
121
125
 
122
126
  * @default RoadMap
123
127
  */
124
128
  staticMapType: any;
125
129
  /**
126
- * Sets and gets the options for customizing the toggle state of shapes when selecting the legend in maps.
130
+ * Gets or sets the options for customizing the toggle state of shapes when selecting the legend in maps.
127
131
  */
128
132
  toggleLegendSettings: any;
129
133
  /**
130
- * Sets and gets the options for customizing the tooltip for the layers, markers, and bubbles in maps.
134
+ * Gets or sets the options for customizing the tooltip of the layers in maps.
131
135
  */
132
136
  tooltipSettings: any;
133
137
  /**
134
- * Sets and gets the template for the map using the url.
138
+ * Gets or sets the URL of the online map providers.
139
+ * The online map providers will be rendered only when the shape data is not set and layer type is set with default value.
135
140
  * @default ''
136
141
  */
137
142
  urlTemplate: any;
138
143
  /**
139
- * Enables or disables the visibility state for the layers in maps.
144
+ * Enables or disables the visibility of the layers in maps.
140
145
  * @default true
141
146
  */
142
147
  visible: any;
@@ -7,7 +7,8 @@ export declare const inputs: string[];
7
7
  export declare const outputs: string[];
8
8
  export declare const twoWays: string[];
9
9
  /**
10
- * Represents Maps Component
10
+ * Represents the Angular Maps component.
11
+ * 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.
11
12
  * ```html
12
13
  * <ej-maps></ej-maps>
13
14
  * ```
@@ -38,6 +39,8 @@ export declare class MapsComponent extends Maps implements IComponentBase {
38
39
  markerClusterClick: any;
39
40
  markerClusterMouseMove: any;
40
41
  markerClusterRendering: any;
42
+ markerDragEnd: any;
43
+ markerDragStart: any;
41
44
  markerMouseMove: any;
42
45
  markerRendering: any;
43
46
  onclick: any;
@@ -1,7 +1,7 @@
1
1
  import { ViewContainerRef } from '@angular/core';
2
2
  import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
3
3
  /**
4
- * Layer Directive
4
+ * Represents the directive to define the markers in the maps.
5
5
  * ```html
6
6
  * <e-layers>
7
7
  * <e-layer>
@@ -17,30 +17,30 @@ export declare class MarkerDirective extends ComplexBase<MarkerDirective> {
17
17
  private viewContainerRef;
18
18
  directivePropList: any;
19
19
  /**
20
- * Sets and gets the delay time for the animation in marker.
20
+ * Gets or sets the delay time for the animation in marker.
21
21
  * @default 0
22
22
  */
23
23
  animationDelay: any;
24
24
  /**
25
- * Sets and gets the duration time for animating the marker.
25
+ * Gets or sets the duration time for animating the marker.
26
26
  * @default 1000
27
27
  */
28
28
  animationDuration: any;
29
29
  /**
30
- * Sets and gets the options for customizing the color and width of the border for the marker in maps.
30
+ * Gets or sets the options for customizing the style properties of the border of the marker in maps.
31
31
  */
32
32
  border: any;
33
33
  /**
34
- * Sets and gets the value path from the marker data source to apply color for the marker.
34
+ * Gets or sets the field name from the marker data source based on which the color is applied for the marker.
35
35
  * @default null
36
36
  */
37
37
  colorValuePath: any;
38
38
  /**
39
- * Sets and gets the dash-array for the marker.
39
+ * Gets or sets the dash-array for the marker.
40
40
  */
41
41
  dashArray: any;
42
42
  /**
43
- * Sets and gets the data source for the marker.
43
+ * Gets or sets the data source for the marker.
44
44
  * The data source for the marker will contain latitude and longitude values to specify the location
45
45
  * of the marker.
46
46
  * The data source can contain data such as color, shape, and other details that can be bound to the color, shape,
@@ -50,90 +50,96 @@ export declare class MarkerDirective extends ComplexBase<MarkerDirective> {
50
50
  */
51
51
  dataSource: any;
52
52
  /**
53
- * Sets and gets the color for the marker in maps.
53
+ * Enables or disables marker drag and drop functionality at any location on the map.
54
+ * @default false
55
+ */
56
+ enableDrag: any;
57
+ /**
58
+ * Gets or sets the color for the marker in maps.
54
59
  * @default '#FF471A'
55
60
  */
56
61
  fill: any;
57
62
  /**
58
- * Sets and gets the height of the marker in maps.
63
+ * Gets or sets the height of the marker in maps.
59
64
  * @default 10
60
65
  */
61
66
  height: any;
62
67
  /**
63
- * Sets and gets the options to customize the marker while the mouse has hovered on the marker in maps.
68
+ * Gets or sets the options to customize the marker when the mouse hovers over the markers in maps.
64
69
  */
65
70
  highlightSettings: any;
66
71
  /**
67
- * Sets and gets the URL for rendering the marker as image.
72
+ * Gets or sets the URL for rendering the marker as image. This property acts as image source for all the markers in a marker settings.
68
73
  */
69
74
  imageUrl: any;
70
75
  /**
71
- * Sets and gets the value path from the marker data source for the image of the marker.
76
+ * Gets or sets the field name from the marker data source based on which the image source for the image type marker is got individually.
72
77
  * @default null
73
78
  */
74
79
  imageUrlValuePath: any;
75
80
  /**
76
- * To select the shape at the rendering time.
81
+ * Gets or sets the options to select the markers at the initial rendering time of the maps.
82
+ * The initial selection of markers will be performed only when the selection functionality of marker is enabled.
77
83
  */
78
84
  initialMarkerSelection: any;
79
85
  /**
80
- * Defines the value path from the marker data source for setting latitude for a set of markers.
86
+ * Defines the field name from the marker data source for setting latitude for a set of markers.
81
87
  */
82
88
  latitudeValuePath: any;
83
89
  /**
84
- * Sets and gets the text for the legend from the marker data source.
90
+ * Gets or sets the field name from the marker data source to render legend item text for the marker legend.
85
91
  * @default ''
86
92
  */
87
93
  legendText: any;
88
94
  /**
89
- * Defines the value path from the marker data source for setting longitude for a set of markers.
95
+ * Defines the field name from the marker data source for setting longitude for a set of markers.
90
96
  */
91
97
  longitudeValuePath: any;
92
98
  /**
93
- * Sets and gets the position to move the marker by setting specific value.
99
+ * Gets or sets the offset value from which the marker must be rendered from the intended position.
94
100
  */
95
101
  offset: any;
96
102
  /**
97
- * Sets and gets the opacity for the marker in maps.
103
+ * Gets or sets the opacity for the marker in maps.
98
104
  * @default 1
99
105
  */
100
106
  opacity: any;
101
107
  /**
102
- * Sets and gets the query to select particular data from the marker data.
108
+ * Gets or sets the query to select particular data from the marker data source.
103
109
  * This property is applicable only when the data source is created by data manager.
104
110
  * @default null
105
111
  */
106
112
  query: any;
107
113
  /**
108
- * Sets and gets the options to customize the marker while selecting the marker in maps.
114
+ * Gets or sets the options to customize the marker while selecting the marker in maps.
109
115
  */
110
116
  selectionSettings: any;
111
117
  /**
112
- * Sets and gets the shape of the marker in maps.
118
+ * Gets or sets the shape of the marker in maps.
113
119
  * @default Balloon
114
120
  */
115
121
  shape: any;
116
122
  /**
117
- * Sets and gets the value path from the marker data source to set the shape of the marker.
123
+ * Gets or sets the field name from the marker data source based on which the shape for individual markers are set.
118
124
  * @default null
119
125
  */
120
126
  shapeValuePath: any;
121
127
  /**
122
- * Sets and gets the options to customize the tooltip for the marker in maps.
128
+ * Gets or sets the options to customize the tooltip of the marker in maps.
123
129
  */
124
130
  tooltipSettings: any;
125
131
  /**
126
- * Enables or disables the visibility state of the marker based on the marker data source in maps.
132
+ * Enables or disables the visibility of the markers in maps.
127
133
  * @default false
128
134
  */
129
135
  visible: any;
130
136
  /**
131
- * Sets and gets the width of the marker in maps.
137
+ * Gets or sets the width of the marker in maps.
132
138
  * @default 10
133
139
  */
134
140
  width: any;
135
141
  /**
136
- * Sets and gets the template for the marker.
142
+ * Gets or sets the template for the marker to render custom elements.
137
143
  * @default null
138
144
  */
139
145
  template: any;
@@ -1,7 +1,7 @@
1
1
  import { ViewContainerRef } from '@angular/core';
2
2
  import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
3
3
  /**
4
- * Layer Directive
4
+ * Represents the directive to define the navigation lines in the maps.
5
5
  * ```html
6
6
  * <e-layers>
7
7
  * <e-layer>
@@ -17,39 +17,40 @@ export declare class NavigationLineDirective extends ComplexBase<NavigationLineD
17
17
  private viewContainerRef;
18
18
  directivePropList: any;
19
19
  /**
20
- * Sets and gets the angle of curve connecting different locations in maps.
20
+ * Gets or sets the angle of the curve connecting different locations in maps.
21
21
  * @default 0
22
22
  */
23
23
  angle: any;
24
24
  /**
25
- * Sets and gets the options to customize the arrow for the navigation line in maps.
25
+ * Gets or sets the options to customize the arrow for the navigation line in maps.
26
26
  */
27
27
  arrowSettings: any;
28
28
  /**
29
- * Sets and gets the color for the navigation lines in maps.
29
+ * Gets or sets the color for the navigation lines in maps.
30
+ * @default 'black'
30
31
  */
31
32
  color: any;
32
33
  /**
33
- * Sets and gets the dash-array for the navigation lines drawn in maps.
34
+ * Gets or sets the dash-array for the navigation lines drawn in maps.
34
35
  * @default ''
35
36
  */
36
37
  dashArray: any;
37
38
  /**
38
- * Sets and gets the highlight settings of the navigation line in maps.
39
+ * Gets or sets the highlight settings of the navigation line in maps.
39
40
  */
40
41
  highlightSettings: any;
41
42
  /**
42
- * Sets and gets the latitude value for the navigation lines drawn in maps.
43
+ * Gets or sets the latitude value for the navigation lines to be drawn in maps.
43
44
  * @default []
44
45
  */
45
46
  latitude: any;
46
47
  /**
47
- * Sets and gets the longitude for the navigation lines drawn in maps.
48
+ * Gets or sets the longitude for the navigation lines to be drawn in maps.
48
49
  * @default []
49
50
  */
50
51
  longitude: any;
51
52
  /**
52
- * Sets and gets the selection settings of the navigation line in maps.
53
+ * Gets or sets the selection settings of the navigation line in maps.
53
54
  */
54
55
  selectionSettings: any;
55
56
  /**
@@ -58,7 +59,7 @@ export declare class NavigationLineDirective extends ComplexBase<NavigationLineD
58
59
  */
59
60
  visible: any;
60
61
  /**
61
- * Sets and gets the width of the navigation lines in maps.
62
+ * Gets or sets the width of the navigation lines in maps.
62
63
  * @default 1
63
64
  */
64
65
  width: any;