@progress/kendo-angular-map 19.1.2-develop.1 → 19.1.2-develop.3

package/directives.d.ts

@@ -10,6 +10,6 @@ import { ShapeLayerComponent } from './map/shape-layer.component';
 import { TileLayerComponent } from './map/tile-layer.component';
 import { BubbleTooltipComponent, BubbleTooltipTemplateDirective, MarkerTooltipComponent, MarkerTooltipTemplateDirective, ShapeTooltipComponent, ShapeTooltipTemplateDirective } from './tooltip';
 /**
-* Utility array that contains all `Map` related components and directives.
-*/
+ * Utility array that contains all `Map` related components and directives.
+ */
 export declare const KENDO_MAP: readonly [typeof BubbleLayerComponent, typeof BubbleTooltipComponent, typeof BubbleTooltipTemplateDirective, typeof LayersComponent, typeof MapComponent, typeof MarkerLayerComponent, typeof MarkerTooltipComponent, typeof MarkerTooltipTemplateDirective, typeof ShapeLayerComponent, typeof ShapeTooltipComponent, typeof ShapeTooltipTemplateDirective, typeof TileLayerComponent];

package/esm2022/directives.mjs

@@ -10,8 +10,8 @@ import { ShapeLayerComponent } from './map/shape-layer.component';
 import { TileLayerComponent } from './map/tile-layer.component';
 import { BubbleTooltipComponent, BubbleTooltipTemplateDirective, MarkerTooltipComponent, MarkerTooltipTemplateDirective, ShapeTooltipComponent, ShapeTooltipTemplateDirective, } from './tooltip';
 /**
-* Utility array that contains all `Map` related components and directives.
-*/
+ * Utility array that contains all `Map` related components and directives.
+ */
 export const KENDO_MAP = [
     BubbleLayerComponent,
     BubbleTooltipComponent,

package/esm2022/events/before-reset-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired immediately before the map is reset. This event is typically used for cleanup by layer implementers.
+ * Arguments for the `beforeReset` event.
+ * Fires immediately before the map resets. Layer implementers typically use this event for cleanup.
  */
 export class BeforeResetEvent extends BaseEvent {
     /**

package/esm2022/events/map-click-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when the user clicks on the map.
+ * Arguments for the `mapClick` event.
+ * Fires when you click on the map.
  */
 export class MapClickEvent extends BaseEvent {
     /**
@@ -12,7 +13,7 @@ export class MapClickEvent extends BaseEvent {
      */
     location;
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/events/marker-activate-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when a marker has been displayed and has a DOM element assigned.
+ * Arguments for the `markerActivate` event.
+ * Fires when a marker displays and has a DOM element assigned.
  */
 export class MarkerActivateEvent extends BaseEvent {
     /**

package/esm2022/events/marker-click-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when a marker has been clicked or tapped.
+ * Arguments for the `markerClick` event.
+ * Fires when the user clicks or taps a marker.
  */
 export class MarkerClickEvent extends BaseEvent {
     /**

package/esm2022/events/marker-created-event.mjs

@@ -4,9 +4,10 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Fired when a marker has been created and is about to be displayed.
+ * Arguments for the `markerCreated` event.
+ * Fires once the map has created a marker, and just before the map displays it.
  *
- * Cancelling the event will prevent the marker from being shown.
+ * Cancelling the event prevents displaying the marker.
  */
 export class MarkerCreatedEvent extends PreventableEvent {
     /**

package/esm2022/events/pan-end-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fires after the map viewport has been moved.
+ * Arguments for the `panEnd` event.
+ * Fires after the map viewport completes panning.
  */
 export class PanEndEvent extends BaseEvent {
     /**
@@ -16,7 +17,7 @@ export class PanEndEvent extends BaseEvent {
      */
     center;
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/events/pan-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired while the map viewport is being moved.
+ * Arguments for the `pan` event.
+ * Fires while the map viewport is being moved.
  */
 export class PanEvent extends BaseEvent {
     /**
@@ -16,7 +17,7 @@ export class PanEvent extends BaseEvent {
      */
     center;
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/events/reset-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when the map is reset.
+ * Arguments for the `reset` event.
+ * Fires when the map resets.
  *
  * This typically occurs on initial load and after a zoom/center change.
  */

package/esm2022/events/shape-click-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when a shape is clicked or tapped.
+ * Arguments for the `shapeClick` event.
+ * Fires when a shape is clicked or tapped.
  */
 export class ShapeClickEvent extends BaseEvent {
     /**
@@ -16,7 +17,7 @@ export class ShapeClickEvent extends BaseEvent {
      */
     shape;
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/events/shape-created-event.mjs

@@ -4,7 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when a shape is created, but is not rendered yet.
+ * Arguments for the `shapeCreated` event.
+ * Fires when a shape is created, but is not rendered yet.
  */
 export class ShapeCreatedEvent extends BaseEvent {
     /**
@@ -20,7 +21,7 @@ export class ShapeCreatedEvent extends BaseEvent {
      */
     dataItem;
     /**
-     * The shape location
+     * The shape location.
      */
     location;
     /**

package/esm2022/events/shape-feature-created-event.mjs

@@ -4,11 +4,12 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when a [GeoJSON Feature](https://geojson.org/geojson-spec.html#feature-objects) is created on a shape layer.
+ * Arguments for the `shapeFeatureCreated` event.
+ * Fires when a [GeoJSON Feature](https://geojson.org/geojson-spec.html#feature-objects) is created on a shape layer.
  */
 export class ShapeFeatureCreatedEvent extends BaseEvent {
     /**
-     * The original data item for this Feature. Members include `geometries` and `properties`.
+     * The original data item for this Feature. Includes `geometries` and `properties` members.
      */
     dataItem;
     /**
@@ -16,7 +17,7 @@ export class ShapeFeatureCreatedEvent extends BaseEvent {
      */
     layer;
     /**
-     * The group containing feature shape instances.
+     * The group that contains feature shape instances.
      */
     group;
     /**

package/esm2022/events/shape-mouse-enter-event.mjs

@@ -4,10 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when the mouse enters a shape.
+ * Arguments for the `shapeMouseEnter` event.
+ * Fires when the mouse enters a shape.
  *
- * > This event will fire reliably only for shapes that have set fill color.
- * > The opacity can still be set to 0 so the shapes appear to have no fill.
+ * > This event fires reliably only for shapes that have a set fill color.
+ * > You can still set the opacity to 0 so the shapes appear to have no fill.
  */
 export class ShapeMouseEnterEvent extends BaseEvent {
     /**
@@ -19,7 +20,7 @@ export class ShapeMouseEnterEvent extends BaseEvent {
      */
     shape;
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/events/shape-mouse-leave-event.mjs

@@ -4,10 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when the mouse leaves a shape.
+ * Arguments for the `shapeMouseLeave` event.
+ * Fires when the mouse leaves a shape.
  *
- * > This event will fire reliably only for shapes that have set fill color.
- * > The opacity can still be set to 0 so the shapes appear to have no fill.
+ * > This event fires reliably only for shapes that have a set fill color.
+ * > You can still set the opacity to 0 so the shapes appear to have no fill.
  */
 export class ShapeMouseLeaveEvent extends BaseEvent {
     /**
@@ -19,7 +20,7 @@ export class ShapeMouseLeaveEvent extends BaseEvent {
      */
     shape;
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/events/zoom-end-event.mjs

@@ -4,11 +4,12 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Fired when the map zoom level has changed.
+ * Arguments for the `zoomEnd` event.
+ * Fires when the map zoom level changes.
  */
 export class ZoomEndEvent extends BaseEvent {
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/events/zoom-start-event.mjs

@@ -4,13 +4,13 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Fired when the map zoom level is about to change.
- *
- * Cancelling the event will prevent the user action.
+ * Arguments for the `zoomStart` event.
+ * Fires when the map zoom level is about to change.
+ * Cancel the event to prevent the user action.
  */
 export class ZoomStartEvent extends PreventableEvent {
     /**
-     * The source DOM event instance
+     * The source DOM event instance.
      */
     originalEvent;
     /**

package/esm2022/map/bubble-layer.component.mjs

@@ -12,44 +12,66 @@ import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 import * as i3 from "@angular/platform-browser";
 /**
- * A vector shape layer for bubble maps. [See example](slug:bubble_layers_map).
+ * Represents the Kendo UI BubbleLayer component for Angular. Displays data as bubbles on vector shape layers for bubble maps.
+ *
+ * @example
+ * ```typescript
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-map>
+ *       <kendo-map-bubble-layer
+ *         [data]="bubbleData"
+ *         locationField="location"
+ *         valueField="population"
+ *         [maxSize]="50"
+ *         [minSize]="10">
+ *       </kendo-map-bubble-layer>
+ *     </kendo-map>
+ *   `
+ * })
+ * export class AppComponent {
+ *   public bubbleData = [
+ *     { location: [40.7128, -74.0060], population: 8000000 }
+ *   ];
+ * }
+ * ```
  */
 export class BubbleLayerComponent extends LayerComponent {
     configurationService;
     collectionService;
     sanitizer;
     /**
-     * The array of data items for this layer.
+     * Sets the array of data items for this layer.
      */
     data;
     /**
-     * The data item field which contains the symbol location.
-     *
-     * The field should be an array with two numbers - latitude and longitude in decimal degrees.
+     * Sets the data item field which contains the symbol location.
+     * The field should be an array with two numbers &mdash; latitude and longitude in decimal degrees.
      */
     locationField;
     /**
-     * The value field for the symbols used to determine their relative size.
+     * Sets the value field for the symbols used to determine their relative size.
      * The data item field should be a number.
      */
     valueField;
     /**
-     * The symbol to use for bubble layers.
+     * Sets the symbol to use for bubble layers.
      */
     symbol;
     /**
-     * The default style for symbols.
+     * Sets the default style for symbols.
      */
     style;
     /**
-     * The maximum symbol size for bubble layer symbols.
+     * Sets the maximum symbol size for bubble layer symbols.
      *
      * @default 100
      */
     maxSize;
     /**
-     * The minimum symbol size for bubble layer symbols.
-     * Setting non-zero value will distort symbol area to value ratio.
+     * Sets the minimum symbol size for bubble layer symbols.
+     * Setting a non-zero value will distort the symbol area to value ratio.
      *
      * @default 0
      */

package/esm2022/map/layers.component.mjs

@@ -10,7 +10,26 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 /**
- * A collection of one or more layers.
+ * Represents the Kendo UI Layers component for Angular. Contains a collection of one or more map layers.
+ *
+ * @example
+ * ```typescript
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-map>
+ *       <kendo-map-layers>
+ *         <kendo-map-tile-layer [urlTemplate]="tileUrl"></kendo-map-tile-layer>
+ *         <kendo-map-shape-layer [data]="shapeData"></kendo-map-shape-layer>
+ *       </kendo-map-layers>
+ *     </kendo-map>
+ *   `
+ * })
+ * export class AppComponent {
+ *   public tileUrl = (args: any) => `https://tile.openstreetmap.org/${args.z}/${args.x}/${args.y}.png`;
+ *   public shapeData = [];
+ * }
+ * ```
  */
 export class LayersComponent extends CollectionComponent {
     configurationService;

package/esm2022/map/marker-layer.component.mjs

@@ -12,30 +12,50 @@ import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 import * as i3 from "@angular/platform-browser";
 /**
- * A vector shape layer for bubble maps. [See example](slug:marker_layers_map).
+ * Represents the Kendo UI MarkerLayer component for Angular. Displays data as markers on vector shape layers for marker maps.
+ *
+ * @example
+ * ```typescript
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-map>
+ *       <kendo-map-marker-layer
+ *         [data]="markerData"
+ *         locationField="location"
+ *         titleField="title"
+ *         shape="pin">
+ *       </kendo-map-marker-layer>
+ *     </kendo-map>
+ *   `
+ * })
+ * export class AppComponent {
+ *   public markerData = [
+ *     { location: [40.7128, -74.0060], title: "New York" }
+ *   ];
+ * }
+ * ```
  */
 export class MarkerLayerComponent extends LayerComponent {
     configurationService;
     collectionService;
     sanitizer;
     /**
-     * The array of data items for this layer.
+     * Sets the array of data items for this layer.
      */
     data;
     /**
-     * The data item field which contains the marker location.
-     *
-     * The field should be an array with two numbers - latitude and longitude in decimal degrees.
+     * Sets the data item field which contains the marker location.
+     * The field should be an array with two numbers &mdash; latitude and longitude in decimal degrees.
      */
     locationField;
     /**
-     * The data item field which contains the marker title.
+     * Sets the data item field which contains the marker title.
      */
     titleField;
     /**
-     * The default marker shape for data-bound markers. Supported marker shapes are "pinTarget and "pin".
-     *
-     * Marker shapes are implemented as CSS classes on the marker element (`span.k-marker`). For example "pinTarget" is rendered as `k-marker-pin-target`.
+     * Sets the default marker shape for data-bound markers. Supported marker shapes are `pinTarget` and `pin`.
+     * Marker shapes are implemented as CSS classes on the marker element (`span.k-marker`). For example `pinTarget` is rendered as `k-marker-pin-target`.
      */
     shape;
     constructor(configurationService, collectionService, sanitizer) {

package/esm2022/map/shape-layer.component.mjs

@@ -12,18 +12,37 @@ import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 import * as i3 from "@angular/platform-browser";
 /**
- * Defines a vector shape layer bound to GeoJSON data. [See example](slug:shape_layers_map).
+ * Represents the Kendo UI ShapeLayer component for Angular. Defines a vector shape layer bound to GeoJSON data.
+ *
+ * @example
+ * ```typescript
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-map>
+ *       <kendo-map-shape-layer
+ *         [data]="geoJsonData"
+ *         [style]="shapeStyle">
+ *       </kendo-map-shape-layer>
+ *     </kendo-map>
+ *   `
+ * })
+ * export class AppComponent {
+ *   public geoJsonData = { type: "FeatureCollection", features: [] };
+ *   public shapeStyle = { fill: { color: "#007acc" }, stroke: { color: "#ffffff" } };
+ * }
+ * ```
  */
 export class ShapeLayerComponent extends LayerComponent {
     configurationService;
     collectionService;
     sanitizer;
     /**
-     * The array of data items for this layer.
+     * Sets the array of data items for this layer.
      */
     data;
     /**
-     * The default style for shapes.
+     * Sets the default style for shapes.
      */
     style;
     constructor(configurationService, collectionService, sanitizer) {

package/esm2022/map/tile-layer.component.mjs

@@ -12,26 +12,44 @@ import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 import * as i3 from "@angular/platform-browser";
 /**
- * Defines a vector shape layer bound to GeoJSON data. [See example](slug:tile_layers_map).
+ * Represents the Kendo UI TileLayer component for Angular. Displays raster map tiles from various sources.
+ *
+ * @example
+ * ```typescript
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-map>
+ *       <kendo-map-tile-layer
+ *         [urlTemplate]="tileUrlTemplate"
+ *         [subdomains]="['a', 'b', 'c']"
+ *         [tileSize]="256">
+ *       </kendo-map-tile-layer>
+ *     </kendo-map>
+ *   `
+ * })
+ * export class AppComponent {
+ *   public tileUrlTemplate = (args: any) => `https://${args.subdomain}.tile.openstreetmap.org/${args.z}/${args.x}/${args.y}.png`;
+ * }
+ * ```
  */
 export class TileLayerComponent extends LayerComponent {
     configurationService;
     collectionService;
     sanitizer;
     /**
-     * The size of the image tile in pixels.
+     * Sets the size of the image tile in pixels.
      *
      * @default 256
      */
     tileSize;
     /**
-     * A list of subdomains to use for loading tiles.
-     *
-     * Alternating between different subdomains allows more requests to be executed in parallel.
+     * Sets a list of subdomains to use for loading tiles.
+     * Alternating between different subdomains allows more requests to execute in parallel.
      */
     subdomains;
     /**
-     * A function that returns an image URL for each tile position.
+     * Sets a function that returns an image URL for each tile position.
      */
     urlTemplate;
     constructor(configurationService, collectionService, sanitizer) {