@map-colonies/react-components 3.11.0 → 3.12.0

package/CHANGELOG.md

@@ -3,6 +3,32 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.12.0](https://github.com/MapColonies/shared-components/compare/@map-colonies/react-components@3.11.0...@map-colonies/react-components@3.12.0) (2022-08-04)
+
+
+### Bug Fixes
+
+* legend sidebar ([cdca0cc](https://github.com/MapColonies/shared-components/commit/cdca0ccd1f8ee21a575557cc6c13903beaed8ca2))
+* legends style tweaks ([eec1f08](https://github.com/MapColonies/shared-components/commit/eec1f083fa22c818cb55ab3e4d947b61e428f215))
+* lint and prettier ([68bf8f6](https://github.com/MapColonies/shared-components/commit/68bf8f64321043ee1d00d46c08f834698bf18276))
+* map legends final tweaks ([9b00733](https://github.com/MapColonies/shared-components/commit/9b00733594716a0d19eff17249cd2280ca8704a3))
+* map legends fine tuning ([de59b02](https://github.com/MapColonies/shared-components/commit/de59b02a657000e24f962dfc0c405a73f8d4ba11))
+* map legends props to single prop ([5fafca0](https://github.com/MapColonies/shared-components/commit/5fafca0705d1bbee29e80121c09c19fd9c2a959f))
+* map legends styles ([1355962](https://github.com/MapColonies/shared-components/commit/135596209224f52c11d28a2b85f2b470c1980936))
+* pr rejects and prettier ([2fbeb20](https://github.com/MapColonies/shared-components/commit/2fbeb206e2f86589128d21e2ac14e5a57090d7f2))
+* prettier ([f12096a](https://github.com/MapColonies/shared-components/commit/f12096a9839beddad1553ade17c338a07414d882))
+* X btn wrong place ([9ff0ca0](https://github.com/MapColonies/shared-components/commit/9ff0ca0ef928db12d47b1bd428967feadb411d10))
+
+
+### Features
+
+* add sidebar for the cesium viewer ([81dfe0b](https://github.com/MapColonies/shared-components/commit/81dfe0bdd38d7dcaa131e7b5e24000767b794d81))
+* implement legends sidebar and create story ([60e9b58](https://github.com/MapColonies/shared-components/commit/60e9b587aadb866a9ce14d6508c39239fdfd03fb))
+
+
+
+
+
 # [3.11.0](https://github.com/MapColonies/shared-components/compare/@map-colonies/react-components@3.10.5...@map-colonies/react-components@3.11.0) (2022-05-02)
 
 

package/dist/cesium-map/layers/imagery.layer.js

@@ -50,14 +50,18 @@ var CesiumImageryLayer = function (props) {
     var meta = props.meta, restProps = __rest(props, ["meta"]);
     var mapViewer = map_1.useCesiumMap();
     react_1.useLayoutEffect(function () {
-        var _a;
-        (_a = mapViewer.layersManager) === null || _a === void 0 ? void 0 : _a.addMetaToLayer(meta, function (layer, idx) {
+        var _a, _b;
+        (_a = mapViewer.layersManager) === null || _a === void 0 ? void 0 : _a.addMetaToLayer(meta, 
+        /* eslint-disable */
+        (_b = meta.searchLayerPredicate) !== null && _b !== void 0 ? _b : (function (layer, idx) {
             if (meta !== undefined) {
-                // eslint-disable-next-line
-                return layer._imageryProvider._resource._url === meta.url;
+                return (layer._imageryProvider._resource._url ===
+                    meta.options.url);
             }
             return false;
-        });
+        })
+        /* eslint-enable */
+        );
     }, [meta, mapViewer]);
     return react_1.default.createElement(resium_1.ImageryLayer, __assign({}, restProps));
 };

package/dist/cesium-map/layers-manager.d.ts

@@ -1,7 +1,8 @@
-import { ImageryLayer } from 'cesium';
+import { ImageryLayer, Event } from 'cesium';
 import { RCesiumOSMLayerOptions, RCesiumWMSLayerOptions, RCesiumWMTSLayerOptions, RCesiumXYZLayerOptions } from './layers';
 import { CesiumViewer } from './map';
 import { IBaseMap } from './settings/settings';
+import { IMapLegend } from './map-legend';
 export interface ICesiumImageryLayer extends InstanceType<typeof ImageryLayer> {
     meta?: Record<string, unknown>;
 }
@@ -21,10 +22,16 @@ export interface IVectorLayer {
     zIndex: number;
     url: string;
 }
+export declare type LegendExtractor = (layers: (any & {
+    meta: any;
+})[]) => IMapLegend[];
 declare class LayerManager {
     mapViewer: CesiumViewer;
     private readonly layers;
-    constructor(mapViewer: CesiumViewer);
+    legendsList: IMapLegend[];
+    layerUpdated: Event;
+    private readonly legendsExtractor?;
+    constructor(mapViewer: CesiumViewer, legendsExtractor?: LegendExtractor, onLayersUpdate?: () => void);
     addMetaToLayer(meta: any, layerPredicate: (layer: ImageryLayer, idx: number) => boolean): void;
     setBaseMapLayers(baseMap: IBaseMap): void;
     addRasterLayer(layer: IRasterLayer, index: number, parentId: string): void;
@@ -40,6 +47,7 @@ declare class LayerManager {
     showAllNotBase(isShow: boolean): void;
     get(layerId: string): ICesiumImageryLayer | undefined;
     findLayerByPOI(x: number, y: number): ICesiumImageryLayer[] | undefined;
+    private setLegends;
     private getBaseLayersCount;
     private findLayerById;
     private updateLayersOrder;

package/dist/cesium-map/layers-manager.js

@@ -22,16 +22,29 @@ var point_geojson_1 = require("./tools/geojson/point.geojson");
 var INC = 1;
 var DEC = -1;
 var LayerManager = /** @class */ (function () {
-    function LayerManager(mapViewer) {
+    function LayerManager(mapViewer, legendsExtractor, onLayersUpdate) {
+        var _this = this;
         this.mapViewer = mapViewer;
         // eslint-disable-next-line
         this.layers = this.mapViewer.imageryLayers._layers;
+        this.legendsList = [];
+        this.legendsExtractor = legendsExtractor;
+        this.layerUpdated = new cesium_1.Event();
+        if (onLayersUpdate) {
+            this.layerUpdated.addEventListener(onLayersUpdate, this);
+        }
+        this.mapViewer.imageryLayers.layerRemoved.addEventListener(function () {
+            _this.setLegends();
+            _this.layerUpdated.raiseEvent();
+        });
     }
     /* eslint-disable */
     LayerManager.prototype.addMetaToLayer = function (meta, layerPredicate) {
         var layer = this.layers.find(layerPredicate);
         if (layer) {
             layer.meta = meta;
+            this.setLegends();
+            this.layerUpdated.raiseEvent();
         }
     };
     /* eslint-enable */
@@ -192,6 +205,11 @@ var LayerManager = /** @class */ (function () {
             return ((_a = layer2.meta) === null || _a === void 0 ? void 0 : _a.zIndex) - ((_b = layer1.meta) === null || _b === void 0 ? void 0 : _b.zIndex);
         });
     };
+    LayerManager.prototype.setLegends = function () {
+        if (typeof this.legendsExtractor !== 'undefined') {
+            this.legendsList = this.legendsExtractor(this.layers);
+        }
+    };
     LayerManager.prototype.getBaseLayersCount = function () {
         var baseLayers = this.layers.filter(function (layer) {
             var parentId = lodash_1.get(layer.meta, 'parentBasetMapId');

package/dist/cesium-map/map-legend/MapLegend.css

@@ -0,0 +1,135 @@
+.mapLegendSidebarContainer {
+  width: 340px;
+  height: 100%;
+  position: relative;
+  overflow-y: auto;
+  overflow-x: hidden;
+  font-size: 16px;
+}
+
+/* Disable drawer animation */
+
+.mapLegendSidebarContainer.mdc-drawer--animate {
+  transform: translateX(0) !important;
+  transition: none !important;
+}
+
+.mapLegendSidebarContainer.mdc-drawer--dismissible {
+  position: relative;
+}
+
+div.MuiPaper-root {
+  transition: none !important;
+}
+
+.mapLegendCloseBtn {
+  position: absolute;
+  top: 0;
+  right: 0;
+  cursor: pointer;
+  width: 50px;
+  height: 50px;
+  padding: 20px;
+  font-size: 24px;
+}
+
+body[dir='rtl'] .mapLegendCloseBtn {
+  right: unset;
+  left: 0;
+}
+
+.mapLegendToggleContainer {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+.mapLegendIcon {
+  width: 2.5rem;
+  height: 2.5rem;
+}
+
+.sidebarHeaderContainer {
+  text-align: center;
+  margin-top: 40px;
+}
+
+.sidebarTitle {
+  font-size: 1.5rem;
+  font-weight: bold;
+}
+
+.mapLegend {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  gap: 4px;
+  padding: 10px 14px;
+}
+
+.layerNameContainer {
+  width: 90%;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+}
+
+.layerName {
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
+.legendImg {
+  width: 90%;
+  height: 150px;
+  border: 1px solid black;
+  border-radius: 5px;
+  object-fit: cover;
+  cursor: pointer;
+}
+
+.legendActionsContainer {
+  display: flex;
+  flex-direction: row;
+  align-self: center;
+}
+
+.legendAction:not(:last-child)::after {
+  content: '|';
+  margin: 0px 4px;
+}
+
+.mapLegendsList {
+  display: flex;
+  flex-direction: column;
+  padding: 20px 0px;
+  width: 100%;
+  height: 90%;
+}
+
+.legendAction {
+  text-decoration: underline;
+  cursor: pointer;
+  font-size: 1.1rem;
+  transition: all 0.1s ease-in-out;
+  width: max-content;
+}
+
+.legendAction:hover {
+  filter: brightness(1.2);
+}
+
+.noLegendsContainer {
+  width: 100%;
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+}
+
+.noLegendsMsg {
+  text-align: center;
+}

package/dist/cesium-map/map-legend/MapLegend.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import './MapLegend.css';
+export interface IMapLegend {
+    layer?: string;
+    legendDoc?: string;
+    legendImg?: string;
+    legend?: Record<string, unknown>[];
+}
+interface MapLegendProps {
+    legend: IMapLegend;
+    docText?: string;
+    imgText?: string;
+}
+export declare const MapLegend: React.FC<MapLegendProps>;
+export {};

package/dist/cesium-map/map-legend/MapLegend.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapLegend = void 0;
+var react_core_1 = require("@map-colonies/react-core");
+var react_1 = __importStar(require("react"));
+var box_1 = require("../../box");
+require("./MapLegend.css");
+var MapLegend = function (_a) {
+    var _b = _a.legend, legendImg = _b.legendImg, legendDoc = _b.legendDoc, layer = _b.layer, docText = _a.docText, imgText = _a.imgText;
+    var handleLegendImgOpen = react_1.useCallback(function () {
+        // Open image in a new tab.
+        window.open(legendImg, '_blank');
+    }, [legendImg]);
+    var handleLegendDocOpen = react_1.useCallback(function () {
+        // Open doc in a new tab.
+        window.open(legendDoc, '_blank');
+    }, [legendDoc]);
+    var renderLayerName = react_1.useCallback(function () {
+        var MAX_LAYER_NAME_LENGTH = 15;
+        var layerNameContainer = (react_1.default.createElement(box_1.Box, { className: "layerNameContainer" },
+            react_1.default.createElement("h3", { style: { maxWidth: MAX_LAYER_NAME_LENGTH + "ch" }, className: "layerName" }, layer)));
+        if ((layer !== null && layer !== void 0 ? layer : '').length > MAX_LAYER_NAME_LENGTH) {
+            return react_1.default.createElement(react_core_1.Tooltip, { content: layer }, layerNameContainer);
+        }
+        return layerNameContainer;
+    }, [layer]);
+    var renderLinks = react_1.useCallback(function () {
+        return [
+            typeof legendImg === 'string' && (react_1.default.createElement("a", { className: "legendAction", href: legendImg, target: "_blank", referrerPolicy: "noreferrer" }, imgText)),
+            typeof legendDoc === 'string' && (react_1.default.createElement("a", { className: "legendAction", href: legendDoc, target: "_blank", referrerPolicy: "noreferrer" }, docText)),
+        ];
+    }, [legendImg, imgText, legendDoc, docText]);
+    return (react_1.default.createElement(box_1.Box, { className: "mapLegend" },
+        renderLayerName(),
+        react_1.default.createElement("img", { alt: "Map Legend", className: "legendImg", src: legendImg, onClick: handleLegendImgOpen }),
+        react_1.default.createElement(box_1.Box, { className: "legendActionsContainer" }, renderLinks())));
+};
+exports.MapLegend = MapLegend;

package/dist/cesium-map/map-legend/MapLegendList.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { IMapLegend } from './MapLegend';
+import './MapLegend.css';
+interface MapLegendListProps {
+    legends: IMapLegend[];
+    actionsTexts: {
+        docText: string;
+        imgText: string;
+    };
+    noLegendsText: string;
+}
+export declare const MapLegendList: React.FC<MapLegendListProps>;
+export {};

package/dist/cesium-map/map-legend/MapLegendList.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapLegendList = void 0;
+var react_1 = __importStar(require("react"));
+var box_1 = require("../../box");
+var MapLegend_1 = require("./MapLegend");
+require("./MapLegend.css");
+var MapLegendList = function (_a) {
+    var legends = _a.legends, _b = _a.actionsTexts, docText = _b.docText, imgText = _b.imgText, noLegendsText = _a.noLegendsText;
+    var handleNoLegends = react_1.useCallback(function () {
+        return (react_1.default.createElement(box_1.Box, { className: "noLegendsContainer" },
+            react_1.default.createElement("h2", { className: "noLegendsMsg" }, noLegendsText)));
+    }, [noLegendsText]);
+    var renderList = react_1.useCallback(function () {
+        if (!legends.length) {
+            return handleNoLegends();
+        }
+        return legends.map(function (legend, i) {
+            return (react_1.default.createElement(MapLegend_1.MapLegend, { key: legend.layer + "_" + i, legend: legend, docText: docText, imgText: imgText }));
+        });
+    }, [legends]);
+    return react_1.default.createElement(box_1.Box, { className: "mapLegendsList" }, renderList());
+};
+exports.MapLegendList = MapLegendList;

package/dist/cesium-map/map-legend/MapLegendSidebar.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import { IMapLegend } from './MapLegend';
+import './MapLegend.css';
+interface MapLegendSidebarProps {
+    isOpen: boolean;
+    toggleSidebar: () => void;
+    title?: string;
+    noLegendsText?: string;
+    legends?: IMapLegend[];
+    actionsTexts?: {
+        docText: string;
+        imgText: string;
+    };
+}
+export declare const MapLegendSidebar: React.FC<MapLegendSidebarProps>;
+export {};

package/dist/cesium-map/map-legend/MapLegendSidebar.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapLegendSidebar = void 0;
+var react_core_1 = require("@map-colonies/react-core");
+var react_1 = __importDefault(require("react"));
+require("./MapLegend.css");
+var MapLegendList_1 = require("./MapLegendList");
+var MapLegendSidebar = function (_a) {
+    var isOpen = _a.isOpen, toggleSidebar = _a.toggleSidebar, _b = _a.title, title = _b === void 0 ? 'Map Legends' : _b, _c = _a.noLegendsText, noLegendsText = _c === void 0 ? 'No legends to display...' : _c, _d = _a.legends, legends = _d === void 0 ? [] : _d, _e = _a.actionsTexts, actionsTexts = _e === void 0 ? { docText: 'Docs', imgText: 'View Image' } : _e;
+    return isOpen ? (react_1.default.createElement(react_core_1.Drawer, { className: "mapLegendSidebarContainer", modal: false, dismissible: true, open: isOpen },
+        react_1.default.createElement(react_core_1.DrawerHeader, { className: "sidebarHeaderContainer" },
+            react_1.default.createElement(react_core_1.DrawerTitle, { className: "sidebarTitle" }, title)),
+        react_1.default.createElement(react_core_1.DrawerContent, { className: "sidebarContent" },
+            react_1.default.createElement(react_core_1.Icon, { onClick: toggleSidebar, className: "mapLegendCloseBtn", icon: { icon: 'close', size: 'small' } }),
+            react_1.default.createElement(MapLegendList_1.MapLegendList, { noLegendsText: noLegendsText, legends: legends, actionsTexts: actionsTexts })))) : null;
+};
+exports.MapLegendSidebar = MapLegendSidebar;

package/dist/cesium-map/map-legend/MapLegendToggle.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import './MapLegend.css';
+interface MapLegendProps {
+    onClick: () => void;
+}
+export declare const MapLegendToggle: React.FC<MapLegendProps>;
+export {};

package/dist/cesium-map/map-legend/MapLegendToggle.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapLegendToggle = void 0;
+var react_1 = __importDefault(require("react"));
+var react_core_1 = require("@map-colonies/react-core");
+var box_1 = require("../../box");
+require("./MapLegend.css");
+var legendIcon = (react_1.default.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", "enable-background": "new 0 0 24 24", height: "24", width: "24", viewBox: "0 0 612 612" },
+    react_1.default.createElement("g", { xmlns: "http://www.w3.org/2000/svg" },
+        react_1.default.createElement("path", { d: "M322.4,173.9l-129,16.2l-4.6,21.4l25.3,4.7c16.5,3.9,19.8,9.9,16.2,26.4l-41.5,195.3c-10.9,50.5,5.9,74.3,45.5,74.3   c30.7,0,66.3-14.2,82.5-33.6l4.9-23.4c-11.3,9.9-27.7,13.9-38.6,13.9c-15.5,0-21.1-10.9-17.1-30L322.4,173.9z" }),
+        react_1.default.createElement("circle", { cx: "270.1", cy: "56.3", r: "56.3" }))));
+var MapLegendToggle = function (_a) {
+    var onClick = _a.onClick;
+    return (react_1.default.createElement(box_1.Box, { onClick: onClick, className: "mapLegendToggleContainer" },
+        react_1.default.createElement(react_core_1.Icon, { icon: legendIcon, className: "mapLegendIcon" })));
+};
+exports.MapLegendToggle = MapLegendToggle;

package/dist/cesium-map/map-legend/index.d.ts

@@ -0,0 +1,3 @@
+export * from './MapLegendToggle';
+export * from './MapLegendSidebar';
+export type { IMapLegend } from './MapLegend';

package/dist/cesium-map/map-legend/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./MapLegendToggle"), exports);
+__exportStar(require("./MapLegendSidebar"), exports);

package/dist/cesium-map/map.css

@@ -40,7 +40,7 @@ body[dir='rtl'] .toolsContainer {
 
 .sideToolsContainer {
   display: flex;
-  flex-direction: column;
+  flex-direction: row;
   gap: 8px;
   z-index: 2000;
   position: absolute;
@@ -52,3 +52,8 @@ body[dir='rtl'] .sideToolsContainer {
   left: 40px;
   right: unset;
 }
+
+.viewer {
+  display: flex;
+  flex-direction: row;
+}

package/dist/cesium-map/map.d.ts

@@ -3,7 +3,8 @@ import { ViewerProps } from 'resium/dist/types/src/Viewer/Viewer';
 import { Viewer as CesiumViewerCls, TerrainProvider } from 'cesium';
 import { Proj } from '../utils/projections';
 import { IBaseMaps } from './settings/settings';
-import LayerManager from './layers-manager';
+import { IMapLegend } from './map-legend';
+import LayerManager, { LegendExtractor } from './layers-manager';
 import { CesiumSceneModeEnum } from './map.types';
 import './map.css';
 export declare class CesiumViewer extends CesiumViewerCls {
@@ -23,6 +24,16 @@ export interface IContextMenuData {
     };
     handleClose: () => void;
 }
+interface ILegends {
+    legendsList?: IMapLegend[];
+    emptyText?: string;
+    title?: string;
+    actionsTexts?: {
+        docText: string;
+        imgText: string;
+    };
+    mapLegendsExtractor?: LegendExtractor;
+}
 export interface CesiumMapProps extends ViewerProps {
     showMousePosition?: boolean;
     showScale?: boolean;
@@ -41,6 +52,10 @@ export interface CesiumMapProps extends ViewerProps {
         width: number;
         dynamicHeightIncrement?: number;
     };
+    legendSidebarTitle?: string;
+    noLegendsText?: string;
+    legends?: ILegends;
 }
 export declare const useCesiumMap: () => CesiumViewer;
 export declare const CesiumMap: React.FC<CesiumMapProps>;
+export {};