jmapcloud-ng-core-types 2.0.13-qa.2 → 2.0.13-qa.3

package/index.d.ts

@@ -12,9 +12,11 @@ export type {
   JFormState,
   JGeocodingState,
   JGeolocationState,
+  JLegendState,
   JLanguageState,
   JLayerState,
   JMapContextState,
+  JMapLegendMode,
   JMapState,
   JProjectState,
   JServerState,
@@ -521,6 +523,7 @@ export interface JMapService {
   Selection: JMapSelectionService
   Basemap: JMapBasemapService
   Attribution: JMapAttributionService
+  Legend: JMapLegendService
   getMap(): maplibregl.Map
   getMapJSLib(): any
   getDomContainerId(): string
@@ -610,6 +613,14 @@ export interface JMapService {
   getPixelRatio(): number
 }
 
+export interface JMapLegendService {
+  getVisible(): boolean
+  isControlVisible(): boolean
+  setControlVisibility(isVisible: boolean): void
+  setMode(mode: JMapLegendMode): void
+  setVisible(isVisible: boolean): void
+}
+
 export interface JMapBasemapService {
   getAllIds(): string[]
   isActive(): boolean

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "2.0.13-qa.2",
+  "version": "2.0.13-qa.3",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "types": "ambient.d.ts",

package/public/core.d.ts

@@ -4356,6 +4356,74 @@ export namespace JMap {
      *
      */
     function getPixelRatio(): number
+    /**
+     * **JMap.Map.Legend**
+     *
+     * This section contains map legend related methods.
+     */
+    namespace Legend {
+      /**
+       * **JMap.Map.Legend.getVisible**
+       *
+       * Returns whether the map legend is currently visible.
+       *
+       * @example
+       * ```ts
+       * JMap.Map.Legend.getVisible()
+       * ```
+       */
+      function getVisible(): boolean
+      /**
+       * **JMap.Map.Legend.isControlVisible**
+       *
+       * Returns true if the legend button is visible on the map.
+       *
+       * @example
+       * ```ts
+       * JMap.Map.Legend.isControlVisible()
+       * ```
+       */
+      function isControlVisible(): boolean
+      /**
+       * **JMap.Map.Legend.setControlVisibility**
+       *
+       * Changes the legend button visibility on the map.
+       *
+       * @param isVisible true to display the legend button, false to hide
+       * @example
+       * ```ts
+       * JMap.Map.Legend.setControlVisibility(true)
+       * JMap.Map.Legend.setControlVisibility(false)
+       * ```
+       */
+      function setControlVisibility(isVisible: boolean): void
+      /**
+       * **JMap.Map.Legend.setMode**
+       *
+       * Changes the map legend mode.
+       *
+       * @param mode `"dynamic"` to only show what is currently visible on the map, `"static"` to always show all legend-enabled layers
+       * @example
+       * ```ts
+       * JMap.Map.Legend.setMode("dynamic")
+       * JMap.Map.Legend.setMode("static")
+       * ```
+       */
+      function setMode(mode: JMapLegendMode): void
+      /**
+       * **JMap.Map.Legend.setVisible**
+       *
+       * Changes the map legend visibility.
+       *
+       * @param isVisible true to display the legend, false to hide it
+       * @example
+       * ```ts
+       * JMap.Map.Legend.setVisible(true)
+       * JMap.Map.Legend.setVisible(false)
+       * ```
+       */
+      function setVisible(isVisible: boolean): void
+    }
     /**
      * **JMap.Map.resetRasterLayerTransparency**
      *

package/public/jmap/layer.d.ts

@@ -330,6 +330,7 @@ export interface JLayer extends JLayerTreeElement {
   // TODO JMAP8-3266 : use a localized type instad of a graphQL one
   dynamicFilters: JDynamicFilterGraphQL[]
   allowClientSideEditing: boolean
+  includeInLegend: boolean
   baseFilter?: JAnyFilterCondition
 }
 

package/public/jmap/map.d.ts

@@ -397,6 +397,18 @@ export interface JCoreMapOptions {
    * ```
    */
   navigationHistoryControlVisible?: boolean
+  /**
+   * By default the legend button is visible on the map.
+   *
+   * But if ***legendControlVisible*** is false, it will be hidden on the map.
+   */
+  legendControlVisible?: boolean
+  /**
+   * By default the legend panel is hidden.
+   *
+   * But if ***legendVisible*** is true, it will be displayed on startup.
+   */
+  legendVisible?: boolean
   /**
    * By default the scale control panel is visible.
    *

package/public/state.d.ts

@@ -19,6 +19,7 @@ export interface JCoreState {
   map: JMapState
   project: JProjectState
   layer: JLayerState
+  legend: JLegendState
   table: JTableState
   user: JUserState
   language: JLanguageState
@@ -98,6 +99,16 @@ export interface JGeolocationState {
   currentLocation: JLocation | undefined
 }
 
+export type JMapLegendMode = "dynamic" | "static"
+
+export interface JLegendState {
+  height: string
+  mode: JMapLegendMode
+  position: JLocation
+  visible: boolean
+  width: string
+}
+
 export interface JMapState {
   pitch: number
   rotation: number
@@ -122,6 +133,7 @@ export interface JMapState {
   isTerrainActive: boolean
   isScaleControlVisible: boolean
   isInitialExtentControlVisible: boolean
+  isLegendControlVisible: boolean
   isMapRotationControlVisible: boolean
   isTerrainControlVisible: boolean
   isMapInfoControlVisible: boolean