@siemens/maps-ng 47.11.0

package/components/si-map/si-map.component.d.ts

@@ -0,0 +1,406 @@
+/**
+ * Copyright (c) Siemens 2016 - 2025
+ * SPDX-License-Identifier: MIT
+ */
+import { AfterViewChecked, AfterViewInit, ElementRef, OnChanges, OnDestroy, SimpleChanges, Type } from '@angular/core';
+import { Coordinate } from 'ol/coordinate';
+import Feature, { FeatureLike } from 'ol/Feature';
+import Map from 'ol/Map';
+import MapBrowserEvent from 'ol/MapBrowserEvent';
+import Overlay, { Positioning } from 'ol/Overlay';
+import { StyleLike } from 'ol/style/Style';
+import { SiMapPopoverComponent } from './components/si-map-popover/si-map-popover.component';
+import { SiMapTooltipComponent } from './components/si-map-tooltip/si-map-tooltip.component';
+import { ColorPalette } from './models/color-palette.type';
+import { MapPoint } from './models/map-point.interface';
+import { OverlayNativeProperties } from './models/overlay-native-properties.interface';
+import { SelectCluster } from './services/SelectCluster';
+import * as i0 from "@angular/core";
+interface ClusterHolder {
+    feature?: Feature;
+}
+export declare class SiMapComponent implements AfterViewInit, OnChanges, OnDestroy, AfterViewChecked {
+    /**
+     * Points to be rendered on the map as features.
+     */
+    readonly points: import("@angular/core").ModelSignal<MapPoint[] | undefined>;
+    /**
+     * Payload of a geo-JSON object.
+     */
+    readonly geoJson: import("@angular/core").InputSignal<any>;
+    /**
+     * Callback function to add custom styling to the drawn geo-JSON features.
+     */
+    readonly styleFunction: import("@angular/core").InputSignal<StyleLike | undefined>;
+    /**
+     * Projection format used to render the geo-JSON payload.
+     *
+     * @defaultValue 'EPSG:3857'
+     */
+    readonly geoJsonProjection: import("@angular/core").InputSignal<string>;
+    /**
+     * Enable or disable animation of markers.
+     *
+     * @defaultValue false
+     */
+    readonly markerAnimation: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Enable or disable clustering of points on the map.
+     *
+     * @defaultValue false
+     */
+    readonly cluster: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Defines which colors should be used when points are grouped. Grouping means
+     * that points are painted with their group color and they are displayed as
+     * series in donut chart inside cluster.
+     *
+     * @defaultValue 'status'
+     */
+    readonly groupColors: import("@angular/core").InputSignal<Record<number, string> | ColorPalette>;
+    /**
+     * - **overlay**: Layer for popup element, an element to be displayed over the
+     *   map and attached to a single map location.
+     * - **controls**: List of controls to activate for map, additional controls
+     *   like full screen, etc. can be added here.
+     */
+    readonly nativeProperties: import("@angular/core").InputSignal<OverlayNativeProperties | undefined>;
+    /**
+     * Type of background map, for example `'https://api.maptiler.com/maps/voyager/style.json?key=xxx'`
+     * (Token key is required). The styleJson defines the tiler source and the
+     * used styles for different layers, should only be used if the siemens
+     * default styles by using `maptilerKey` isn't good enough.
+     */
+    readonly styleJson: import("@angular/core").InputSignal<any>;
+    /**
+     * Option to switch on/off the display of tooltip while hovering over single
+     * point.
+     *
+     * @defaultValue false
+     */
+    readonly displayTooltipOnHover: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Option to switch on/off the display of popover when clicked.
+     * Default set to true (on).
+     *
+     * @defaultValue true
+     */
+    readonly displayPopoverOnClick: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Option to switch on/off popover when hovered.
+     * Default is set to false (off)
+     *
+     * @defaultValue false
+     */
+    readonly displayPopoverOnHover: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Provide your key for MapTiler, this will use the default siemens element
+     * styles which can be used in both light and dark mode. Shouldn't be used
+     * together with styleJson.
+     */
+    readonly maptilerKey: import("@angular/core").InputSignal<string | undefined>;
+    /**
+     * Option to switch on/off the display of tooltip while hovering over cluster.
+     *
+     * @defaultValue false
+     */
+    readonly displayTooltipOnClusterHover: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Defines range in which points are clustered. In pixels.
+     *
+     * @defaultValue DEFAULT_CLUSTER_DISTANCE
+     */
+    readonly clusterDistance: import("@angular/core").InputSignal<number>;
+    /**
+     * Zoom level when calling the `select()` method on the component.
+     * Defaults to 10.
+     *
+     * @defaultValue DEFAULT_FEATURE_SELECT_ZOOM
+     */
+    readonly featureSelectZoom: import("@angular/core").InputSignal<number>;
+    /**
+     * Max zoom level which is used when clicking on feature on the map.
+     * Defaults to 15.
+     *
+     * @defaultValue DEFAULT_FEATURE_CLICK_ZOOM
+     */
+    readonly featureClickZoom: import("@angular/core").InputSignal<number>;
+    /**
+     * Max zoom level for clicking on a cluster on the map. Defaults to 15.
+     *
+     * @defaultValue DEFAULT_CLUSTER_CLICK_ZOOM
+     */
+    readonly clusterClickZoom: import("@angular/core").InputSignal<number>;
+    /**
+     * Max zoom level on load or when clicking the reset button. Defaults to 5.
+     *
+     * @defaultValue DEFAULT_GLOBAL_ZOOM
+     */
+    readonly globalZoom: import("@angular/core").InputSignal<number>;
+    /**
+     * When enabled, features will be automatically zoom to on click.
+     *
+     * @defaultValue false
+     */
+    readonly autoZoomFeatureClick: import("@angular/core").InputSignal<boolean>;
+    /**
+     * When disabled, clusters will no longer automatically be zoomed to on click.
+     *
+     * @defaultValue true
+     */
+    readonly autoZoomClusterClick: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Custom popover component
+     */
+    readonly popoverComponent: import("@angular/core").InputSignal<Type<any> | undefined>;
+    /**
+     * Custom popover component for clustering
+     */
+    readonly clusterPopoverComponent: import("@angular/core").InputSignal<Type<any> | undefined>;
+    /**
+     * Custom popover component
+     */
+    readonly popoverComponentProps: import("@angular/core").InputSignal<any>;
+    /**
+     * Close the popover on click
+     *
+     * @defaultValue true
+     */
+    readonly popoverCloseOnClick: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Padding (in pixels) applied to the map view when zooming to a cluster, preventing points from being clipped at the edges.
+     * Specified as [top, right, bottom, left].
+     *
+     * @defaultValue [20, 20, 20, 20]
+     */
+    readonly fitClusterPadding: import("@angular/core").InputSignal<[number, number, number, number]>;
+    /**
+     * For Point geometry, padding (in pixels) to be cleared to fit the point inside the view after a click on it.
+     * Values in the array are: [top, right, bottom, left].
+     *
+     * @defaultValue [20, 20, 20, 20]
+     */
+    readonly fitPointPadding: import("@angular/core").InputSignal<number[]>;
+    /**
+     * For GeoJson, padding (in pixels) to be cleared to fit the GeoJson inside the view after a click on it.
+     * Values in the array are: [top, right, bottom, left].
+     *
+     * @defaultValue [20, 20, 20, 20]
+     */
+    readonly fitGeoJsonPadding: import("@angular/core").InputSignal<number[]>;
+    /**
+     * Cutoff text for tooltips, when cluster combines more than 4 features
+     *
+     * @deprecated Use `SiMapTooltipComponent` instead to set the `moreText` input e.g. `<si-map ...><si-map-tooltip [moreText]="'KEY_MORE'" /></si-map>`.
+     *
+     * @defaultValue
+     * ```
+     * $localize`:@@SI_MAPS.TOOLTIP_MORE_TEXT:and {{length}} more...`
+     * ```
+     */
+    readonly moreText: import("@angular/core").InputSignal<import("@siemens/element-translate-ng/translate").TranslatableString>;
+    /**
+     * Show multiple worlds, including points that cross the 180th meridian.
+     *
+     * @defaultValue true
+     */
+    readonly multiWorld: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Show the label permanently next to the point.
+     * Normally the label is shown on hover or click.
+     * By enabling this it will always be visible next to the marker.
+     *
+     * @defaultValue false
+     */
+    readonly alwaysShowLabels: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Maximum number of characters per line for always displayed labels of a point.
+     * If the label exceeds this limit, it will be wrapped or trimmed.
+     * If set to 0, label trimming will be disabled.
+     * This setting is effective only when {@link alwaysShowLabels} is enabled.
+     * Important: Changing this is not recommended in most cases and may cause issues with positioning of the labels.
+     *
+     * @defaultValue 20
+     */
+    readonly maxLabelLineLength: import("@angular/core").InputSignal<number>;
+    /**
+     * Maximum number of lines for always displayed labels of a point.
+     * If the label exceeds this limit, it will be trimmed.
+     * This setting is effective only when {@link alwaysShowLabels} is enabled and {@link maxLabelLineLength} is not 0.
+     * Important: Changing this is not recommended in most cases and may cause issues with positioning of the labels.
+     *
+     * @defaultValue 3
+     */
+    readonly maxLabelLines: import("@angular/core").InputSignal<number>;
+    /**
+     * Emitted when points on the map are selected or de-selected
+     */
+    readonly pointsSelected: import("@angular/core").OutputEmitterRef<MapPoint[]>;
+    /**
+     * Emitted when the points are available as features. So consumers can call methods like `zoomToPoints()` on the actual point list.
+     */
+    readonly pointsRefreshed: import("@angular/core").OutputEmitterRef<void>;
+    protected readonly popover: import("@angular/core").Signal<SiMapPopoverComponent>;
+    protected readonly popoverElement: import("@angular/core").Signal<ElementRef<any>>;
+    protected readonly defaultTooltip: import("@angular/core").Signal<SiMapTooltipComponent | undefined>;
+    protected readonly projectedTooltip: import("@angular/core").Signal<SiMapTooltipComponent | undefined>;
+    protected readonly tooltip: import("@angular/core").Signal<SiMapTooltipComponent>;
+    protected readonly mapReference: import("@angular/core").Signal<ElementRef<HTMLElement>>;
+    /** OpenLayers map instance. */
+    map?: Map;
+    tooltipOverlay: Overlay;
+    popoverOverlay: Overlay;
+    /** @defaultValue false */
+    isClicked: boolean;
+    /** @defaultValue [] */
+    features: Feature[];
+    selected?: Feature;
+    targetFeature?: Feature;
+    protected attributionsLabel: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected zoomInLabel: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected zoomOutLabel: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected zoomToDefaultLabel: import("@siemens/element-translate-ng/translate").TranslatableString;
+    protected clusterInteraction?: SelectCluster;
+    private selectedCluster?;
+    private darkTheme;
+    private readonly mapService;
+    private readonly ngZone;
+    private readonly translateService;
+    constructor();
+    private layerFilter;
+    ngOnChanges(changes: SimpleChanges): void;
+    ngAfterViewInit(): void;
+    ngAfterViewChecked(): void;
+    ngOnDestroy(): void;
+    onThemeSwitchInternal(event: Event): void;
+    onThemeSwitch(dark: boolean): void;
+    /**
+     * @deprecated has no effect and will be removed in v48
+     */
+    onResize(): void;
+    private removePixelRatioListener;
+    private readonly updatePixelRatio;
+    /**
+     * Changes the pixel ration in OL which is not supported directly by OL.
+     */
+    private changeOpenLayerPixelRation;
+    /**
+     * Initialize map and it's layers
+     */
+    init(): void;
+    private centerValid;
+    private fixCenter;
+    /**
+     * Setting up the layers for the map (cluster/vector layer)
+     */
+    private setLayers;
+    /**
+     * Setting up the geoJson layer
+     */
+    setGeoJsonLayer(): void;
+    private setTheme;
+    private refreshLayersStyle;
+    /**
+     * Set Map style
+     * @param dark - boolean if dark theme should be active or not
+     * @param key - the api key for the maptiler styleJSON
+     * @param styleJSON - a preexisting styleJSON as url with key already provided
+     */
+    setMapStyle(dark?: boolean, key?: string, styleJSON?: string): void;
+    /**
+     * Set mapbox styles
+     * @param styleJSON - the styleJSON as a JSON object
+     */
+    mapboxStyles(styleJSON: any): void;
+    /**
+     * Create overlay for tooltip and popover
+     * @param nativeProperties - native properties
+     * @param container - to create overlay in
+     * @param position - overlay positioning
+     */
+    createOverlay(container: HTMLElement, position: Positioning, nativeProperties?: OverlayNativeProperties, isTooltip?: boolean): Overlay;
+    /**
+     * On feature hovering show tooltip and change cursor style
+     * @param event - A hovering event
+     */
+    onFeatureHover(event: MapBrowserEvent<UIEvent>): void;
+    /** Display tooltip on hovering over feature type of Feature. */
+    displayTooltip(feats: FeatureLike[]): void;
+    private doShowTooltip;
+    /**
+     * Clicking on cluster event
+     * @param event - openlayers event
+     */
+    onClusterClick(event: MapBrowserEvent<UIEvent>): void;
+    private emitSelection;
+    /**
+     * Zoom to cluster features
+     * @param clusterFeatures - features to zoom in
+     */
+    zoomCluster(clusterFeatures: Feature[]): void;
+    /**
+     * Close popup
+     */
+    closePopup(): boolean;
+    /**
+     * Return features inside feature object in case of cluster enabled/disabled
+     * @param feat - feature to get features from
+     */
+    featureCallback(feat: FeatureLike, clusterHolder?: ClusterHolder): Feature[] | undefined;
+    /**
+     * Zoom to features, gets coordinates of points and creates bounding extent
+     * @param points - list of points to zoom in, if empty all points will be zoomed to, need to be the same reference as the input
+     * @param zoomLevel - number for level to zoom in
+     */
+    zoomToPoints(points: MapPoint[], zoomLevel: number, shouldAnimate?: boolean): void;
+    /**
+     * Zoom to features, gets coordinates of features and creates bounding extent
+     * @param features - list of features to zoom in, if empty all features will be zoomed to
+     * @param zoomLevel - number for level to zoom in
+     */
+    zoomToFeatures(features: Feature[], zoomLevel: number, shouldAnimate?: boolean): void;
+    /**
+     * Zoom to GeoJson using coordinates of point of click
+     * @param coordinate - coordinates of point of click
+     * @param zoomLevel - number for level to zoom in
+     */
+    zoomToGeoJson(coordinate: Coordinate, zoomLevel: number, shouldAnimate?: boolean): void;
+    private zoomToCoordinates;
+    /**
+     * Refresh points with new set of points
+     * @param points - to refresh with
+     */
+    refresh(points: MapPoint[], zoomToFeatures?: boolean): void;
+    private doRefresh;
+    clear(): void;
+    private doClear;
+    /**
+     * Selecting the certain point on map with API
+     * @param point - which select
+     */
+    select(point: MapPoint, maxZoomLevel?: number): void;
+    private doSelect;
+    /** API for feature clicking with extra properties. */
+    featureClick(feature: Feature, event?: any, zoom?: boolean): void;
+    private setPopOver;
+    /**
+     * Show tooltip with content on hover over feature
+     * @param feature - to show popup on
+     */
+    showTooltipContent(feature: Feature): boolean;
+    /** Sends data into cluster tooltip based on number of
+     * @param features - in it
+     * */
+    showClusterTooltipContent(features: Feature[], cluster?: Feature): boolean;
+    hideOverlays(): void;
+    private getFeatureCoordinate;
+    /**
+     * Calculates cluster center coordinates (lon, lat) for cluster tooltip positioning base on
+     * @param features - (lon, lan)
+     */
+    private calculateClusterCoordinates;
+    private showClusterPopover;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiMapComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SiMapComponent, "si-map", never, { "points": { "alias": "points"; "required": false; "isSignal": true; }; "geoJson": { "alias": "geoJson"; "required": false; "isSignal": true; }; "styleFunction": { "alias": "styleFunction"; "required": false; "isSignal": true; }; "geoJsonProjection": { "alias": "geoJsonProjection"; "required": false; "isSignal": true; }; "markerAnimation": { "alias": "markerAnimation"; "required": false; "isSignal": true; }; "cluster": { "alias": "cluster"; "required": false; "isSignal": true; }; "groupColors": { "alias": "groupColors"; "required": false; "isSignal": true; }; "nativeProperties": { "alias": "nativeProperties"; "required": false; "isSignal": true; }; "styleJson": { "alias": "styleJson"; "required": false; "isSignal": true; }; "displayTooltipOnHover": { "alias": "displayTooltipOnHover"; "required": false; "isSignal": true; }; "displayPopoverOnClick": { "alias": "displayPopoverOnClick"; "required": false; "isSignal": true; }; "displayPopoverOnHover": { "alias": "displayPopoverOnHover"; "required": false; "isSignal": true; }; "maptilerKey": { "alias": "maptilerKey"; "required": false; "isSignal": true; }; "displayTooltipOnClusterHover": { "alias": "displayTooltipOnClusterHover"; "required": false; "isSignal": true; }; "clusterDistance": { "alias": "clusterDistance"; "required": false; "isSignal": true; }; "featureSelectZoom": { "alias": "featureSelectZoom"; "required": false; "isSignal": true; }; "featureClickZoom": { "alias": "featureClickZoom"; "required": false; "isSignal": true; }; "clusterClickZoom": { "alias": "clusterClickZoom"; "required": false; "isSignal": true; }; "globalZoom": { "alias": "globalZoom"; "required": false; "isSignal": true; }; "autoZoomFeatureClick": { "alias": "autoZoomFeatureClick"; "required": false; "isSignal": true; }; "autoZoomClusterClick": { "alias": "autoZoomClusterClick"; "required": false; "isSignal": true; }; "popoverComponent": { "alias": "popoverComponent"; "required": false; "isSignal": true; }; "clusterPopoverComponent": { "alias": "clusterPopoverComponent"; "required": false; "isSignal": true; }; "popoverComponentProps": { "alias": "popoverComponentProps"; "required": false; "isSignal": true; }; "popoverCloseOnClick": { "alias": "popoverCloseOnClick"; "required": false; "isSignal": true; }; "fitClusterPadding": { "alias": "fitClusterPadding"; "required": false; "isSignal": true; }; "fitPointPadding": { "alias": "fitPointPadding"; "required": false; "isSignal": true; }; "fitGeoJsonPadding": { "alias": "fitGeoJsonPadding"; "required": false; "isSignal": true; }; "moreText": { "alias": "moreText"; "required": false; "isSignal": true; }; "multiWorld": { "alias": "multiWorld"; "required": false; "isSignal": true; }; "alwaysShowLabels": { "alias": "alwaysShowLabels"; "required": false; "isSignal": true; }; "maxLabelLineLength": { "alias": "maxLabelLineLength"; "required": false; "isSignal": true; }; "maxLabelLines": { "alias": "maxLabelLines"; "required": false; "isSignal": true; }; }, { "points": "pointsChange"; "pointsSelected": "pointsSelected"; "pointsRefreshed": "pointsRefreshed"; }, ["projectedTooltip"], ["si-map-tooltip"], true, never>;
+}
+export {};

package/components/si-map/si-map.module.d.ts

@@ -0,0 +1,9 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./si-map.component";
+import * as i2 from "./components/si-map-popover/si-map-popover.component";
+import * as i3 from "./components/si-map-tooltip/si-map-tooltip.component";
+export declare class SiMapModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiMapModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SiMapModule, never, [typeof i1.SiMapComponent, typeof i2.SiMapPopoverComponent, typeof i3.SiMapTooltipComponent], [typeof i1.SiMapComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SiMapModule>;
+}

package/fesm2022/siemens-maps-ng-translate.mjs

@@ -0,0 +1,21 @@
+import { SI_TRANSLATABLE_VALUES } from '@siemens/element-translate-ng/translate';
+
+/* eslint-disable */
+
+const provideSiMapsTranslatableOverrides = values => ({
+    useValue: values,
+    multi: true,
+    provide: SI_TRANSLATABLE_VALUES
+});
+
+/**
+ * Copyright (c) Siemens 2016 - 2025
+ * SPDX-License-Identifier: MIT
+ */
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { provideSiMapsTranslatableOverrides };
+//# sourceMappingURL=siemens-maps-ng-translate.mjs.map

package/fesm2022/siemens-maps-ng-translate.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"siemens-maps-ng-translate.mjs","sources":["../../../../projects/maps-ng/translate/si-translatable-keys.interface.ts","../../../../projects/maps-ng/translate/si-translatable-overrides.provider.ts","../../../../projects/maps-ng/translate/index.ts","../../../../projects/maps-ng/translate/siemens-maps-ng-translate.ts"],"sourcesContent":["/* eslint-disable */\n\n// Auto-generated file. Run 'npm run build:all:update-translatable-keys' to update.\n\nexport interface SiTranslatableKeys {\n  'SI_MAPS.ATTRIBUTIONS_BUTTON'?: string;\n  'SI_MAPS.TOOLTIP_MORE_TEXT'?: string;\n  'SI_MAPS.ZOOM_IN_BUTTON'?: string;\n  'SI_MAPS.ZOOM_OUT_BUTTON'?: string;\n  'SI_MAPS.ZOOM_TO_DEFAULT_BUTTON'?: string;\n}\n","/**\n * Copyright (c) Siemens 2016 - 2025\n * SPDX-License-Identifier: MIT\n */\nimport { Provider } from '@angular/core';\nimport { SI_TRANSLATABLE_VALUES } from '@siemens/element-translate-ng/translate';\n\nimport { SiTranslatableKeys } from './si-translatable-keys.interface';\n\nexport const provideSiMapsTranslatableOverrides: (\n  values: SiTranslatableKeys\n) => Provider = values => ({\n  useValue: values,\n  multi: true,\n  provide: SI_TRANSLATABLE_VALUES\n});\n","/**\n * Copyright (c) Siemens 2016 - 2025\n * SPDX-License-Identifier: MIT\n */\nexport * from './si-translatable-keys.interface';\nexport * from './si-translatable-overrides.provider';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;AAAA;;MCSa,kCAAkC,GAE/B,MAAM,KAAK;AACzB,IAAA,QAAQ,EAAE,MAAM;AAChB,IAAA,KAAK,EAAE,IAAI;AACX,IAAA,OAAO,EAAE;AACV,CAAA;;ACfD;;;AAGG;;ACHH;;AAEG;;;;"}