jmapcloud-ng-core-types 1.0.9 → 1.0.10

package/all-enums.ts

@@ -139,16 +139,15 @@ export const ALL_LAYER_THEMATIC_FAMILY_TYPES: JLAYER_THEMATIC_FAMILY_TYPES[] = [
 export const ALL_LAYER_STYLE_TYPES: JLAYER_STYLE_TYPES[] = [
   JLAYER_STYLE_TYPES.POINT,
   JLAYER_STYLE_TYPES.LINE,
-  JLAYER_STYLE_TYPES.SURFACE,
-  JLAYER_STYLE_TYPES.ANNOTATION,
   JLAYER_STYLE_TYPES.IMAGE,
-  JLAYER_STYLE_TYPES.MIXED
+  JLAYER_STYLE_TYPES.TEXT,
+  JLAYER_STYLE_TYPES.IMAGE
 ]
 
-export const ALL_LAYER_STYLE_ARROWS: JLAYER_STYLE_ARROWS[] = [
-  JLAYER_STYLE_ARROWS.NONE,
-  JLAYER_STYLE_ARROWS.FORWARD,
-  JLAYER_STYLE_ARROWS.BACKWARD
+export const ALL_LAYER_STYLE_ARROW_TYPES: JLAYER_STYLE_ARROW_TYPES[] = [
+  JLAYER_STYLE_ARROW_TYPES.NONE,
+  JLAYER_STYLE_ARROW_TYPES.FORWARD,
+  JLAYER_STYLE_ARROW_TYPES.BACKWARD
 ]
 
 export const ALL_LAYER_INFORMATION_REPORT_TYPES: JLAYER_INFORMATION_REPORT_TYPES[] = [
@@ -192,16 +191,16 @@ export const ALL_LAYER_DYNAMIC_FILTER_OPERATORS: JLAYER_DYNAMIC_FILTER_OPERATORS
   JLAYER_DYNAMIC_FILTER_OPERATORS.INTERVAL
 ]
 
-export const ALL_LAYER_STYLE_LINE_STROKE_CAP: JLAYER_STYLE_LINE_STROKE_CAP[] = [
-  JLAYER_STYLE_LINE_STROKE_CAP.BUTT,
-  JLAYER_STYLE_LINE_STROKE_CAP.ROUND,
-  JLAYER_STYLE_LINE_STROKE_CAP.SQUARE
+export const ALL_LAYER_STYLE_LINE_CAP: JLAYER_STYLE_LINE_CAP[] = [
+  JLAYER_STYLE_LINE_CAP.BUTT,
+  JLAYER_STYLE_LINE_CAP.ROUND,
+  JLAYER_STYLE_LINE_CAP.SQUARE
 ]
 
-export const ALL_LAYER_STYLE_LINE_STROKE_JOIN: JLAYER_STYLE_LINE_STROKE_JOIN[] = [
-  JLAYER_STYLE_LINE_STROKE_JOIN.MITER,
-  JLAYER_STYLE_LINE_STROKE_JOIN.ROUND,
-  JLAYER_STYLE_LINE_STROKE_JOIN.BEVEL
+export const ALL_LAYER_STYLE_LINE_JOIN: JLAYER_STYLE_LINE_JOIN[] = [
+  JLAYER_STYLE_LINE_JOIN.MITER,
+  JLAYER_STYLE_LINE_JOIN.ROUND,
+  JLAYER_STYLE_LINE_JOIN.BEVEL
 ]
 
 export const ALL_LAYER_METADATA_TYPES: JLAYER_METADATA_TYPES[] = [

package/index.ts

@@ -696,6 +696,7 @@ export interface JMapService {
   isTerrainAvailable(): boolean
   isTerrainActive(): boolean
   setTerrainActive(active: boolean): void
+  setSelectionStyle(layerId: JId, style: JLayerSetSelectionStyleParam): void
   setScaleControlVisibility(isVisible: boolean, position?: JMAP_POSITIONS): void
   setScaleControlUnits(units: "imperial" | "metric" | "nautical"): void
   setScaleControlPosition(position: JMAP_POSITIONS): void

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {

package/public/core.d.ts

@@ -3114,6 +3114,29 @@ declare namespace JMap {
      */
     function setTerrainActive(active: boolean): void
 
+    /**
+     * ***JMap.Map.setSelectionStyle***
+     *
+     * Sets the selection style for a specified JMap Cloud layer.
+     *
+     * When specified symbolData must be a data URL with a base64 encode PNG, JPEG or WEBP image. SVGs are not supported for the moment.
+     *
+     * @param layerId the JMap Cloud layer id
+     * @param style the selection style
+     * @example
+     * ```ts
+     * // define and apply a selection style to a polygone layer
+     * JMap.Map.setSelectionStyle("polygon-layer-id", {type: "POLYGON", fillColor: "#ff0000", borderColor: "#0000ff", borderThickness: 8})
+     *
+     * // define and apply a selection style to a line layer
+     * JMap.Map.setSelectionStyle("line-layer-id",{type:"LINE", lineColor:"#ff0000", lineThickness:4})
+     *
+     * // define and apply a selection style to a point layer
+     * JMap.Map.setSelectionStyle("point-layer-id",{type:"POINT", symbolData:"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAACCElEQVR4XmNgwAH2vHQWjy9TOs/KxvQTyP2PC7NxMP0WlWSrBrKZELoJgI41Rtl6lgK/DG2FQIb8A2J7dDVQYM/IyPAfpFZYgv0akK+MrgADVM/SnS8oyva/eILW/1N/Pf+zsTN9Z8BhAUgtDz8LWB1IPQcX8xcGHGrBoH+LaRDIcJdQyf1A7gcGLEGCC4Mcktag+p+FlfE9kC8BNhAd+MRLP/ZLkgG54i0DPpdgB/a8Aqx/3SKkngLZfeiSDLMPWmgCFfyvnat7Csg9hy5PDJBV4f7Qt9H4PxMT40cglwtFMqNJvdPARvB/aLb8ZiB3NookkcDITvhs5XSd/6JS7DeBXGcUSZ846QvJNSr/FTV5dgK5GSiSRAI7X7GpASmy/0FmAbnNKJLaZvzfp+0x/8/KxngZyDVFkSQSWLiJeqob8v2fuNX0OZB7GEUSmKH+H/nqDkoRv4CYHUWSeMAOTEUwc0AZFAX8P/PfC5bsKAE4zQFL4MtYhAAs4+G0gAYYBYBtxoZxyeESh8mhmQ9RDPImA4nFBAyDgnfWAQv8FjBADLcHYeTwRHchsjguPXCToQAsAYtk9AhDNxxZHJceFNNhikFeBCkCYTTvYsUE9KAADBeiuxQd4xKHyaGZj+k6KmAEQE4BlGKklIgC7KGC6K4gB8NSFVYAdwmIjS6JA5CkhyTFUIBTDwBPxSZtxNLgXwAAAABJRU5ErkJggg=="})
+     * ```
+     */
+    function setSelectionStyle(layerId: JId, style: JLayerSetSelectionStyleParam): void
+
     /**
      * ***JMap.Map.setScaleControlVisibility***
      *

package/public/jmap/layer.d.ts

@@ -65,14 +65,13 @@ declare const enum JLAYER_THEMATIC_FAMILY_TYPES {
 declare const enum JLAYER_STYLE_TYPES {
   POINT = "POINT",
   LINE = "LINE",
-  SURFACE = "SURFACE",
-  ANNOTATION = "ANNOTATION",
-  IMAGE = "IMAGE",
-  MIXED = "MIXED"
+  POLYGON = "POLYGON",
+  TEXT = "TEXT",
+  IMAGE = "IMAGE"
 }
 
 // ALL_LAYER_STYLE_ARROWS in all-enum.ts
-declare const enum JLAYER_STYLE_ARROWS {
+declare const enum JLAYER_STYLE_ARROW_TYPES {
   NONE = "NONE",
   FORWARD = "FORWARD",
   BACKWARD = "BACKWARD"
@@ -122,15 +121,15 @@ declare const enum JLAYER_DYNAMIC_FILTER_OPERATORS {
   INTERVAL = "INTERVAL"
 }
 
-// ALL_LAYER_STYLE_LINE_STROKE_CAP in all-enum.ts
-declare const enum JLAYER_STYLE_LINE_STROKE_CAP {
+// ALL_LAYER_STYLE_LINE_CAP in all-enum.ts
+declare const enum JLAYER_STYLE_LINE_CAP {
   BUTT = "BUTT",
   ROUND = "ROUND",
   SQUARE = "SQUARE"
 }
 
-// ALL_LAYER_STYLE_LINE_STROKE_JOIN in all-enum.ts
-declare const enum JLAYER_STYLE_LINE_STROKE_JOIN {
+// ALL_LAYER_STYLE_LINE_JOIN in all-enum.ts
+declare const enum JLAYER_STYLE_LINE_JOIN {
   MITER = "MITER",
   ROUND = "ROUND",
   BEVEL = "BEVEL"
@@ -301,7 +300,8 @@ declare interface JLayer extends JLayerTreeElement {
   forms: JLayerForm[]
   hasInformationReport: boolean
   informationReports: JLayerInformationReport[]
-  spatialDataSourceId: string // For JMap Cloud only
+  spatialDataSourceId: string
+  selectionStyleId: string
   dynamicFilter: JDynamicFilter
 }
 
@@ -400,7 +400,7 @@ declare interface JLayerThematicConditionScaledStyle {
 
 declare interface JLayerThematicCategory {
   title: string
-  style: JLayerStyle
+  style: JLayerBaseStyle
   enabled: boolean
   nullValueCategory: boolean
   index: number
@@ -461,101 +461,70 @@ declare interface JLayerStyleRuleConditionExpression {
   attribute: JLayerAttribute
 }
 
-declare interface JLayerStyle {
-  styleType: JLAYER_STYLE_TYPES
+declare interface JLayerBaseStyle {
+  type: JLAYER_STYLE_TYPES
+  id: string
+  name: string
+  /**
+   * @deprecated
+   * this property will be removed once the legacy support for JMS thematics will be removed
+   */
   imageSampleInBase64: string
-  transparencyPerCent: number
-}
-
-declare interface JLayerStyleVector extends JLayerStyle {
-  antiAliasing: boolean
-}
-
-declare interface JLayerStylePoint extends JLayerStyleVector {
-  styleType: JLAYER_STYLE_TYPES.POINT
-  symbolScale: number
-  symbolRotationInDegree: number
-  symbolProportionalSizeEnabled: boolean
-  symbolProportionalSize: number
-  symbolRotateWithMapEnabled: boolean
-  symbolOffsetX: number
-  symbolOffsetY: number
-  symbolVector: JLayerStyleSymbolVector | null
-  symbolImage: JLayerStyleSymbolImage | null
+  transparency: number
 }
 
-declare interface JLayerStyleLineStroke {
-  width: number
-  cap: JLAYER_STYLE_LINE_STROKE_CAP
-  join: JLAYER_STYLE_LINE_STROKE_JOIN
+declare interface JLayerImageStyle extends JLayerBaseStyle {
+  type: JLAYER_STYLE_TYPES.IMAGE
 }
 
-declare interface JLayerStyleLineStrokeBasic extends JLayerStyleLineStroke {
-  miterLimit: number
-  dash: number[]
-  dash_phase: number
+declare interface JLayerPointStyle extends JLayerBaseStyle {
+  type: JLAYER_STYLE_TYPES.POINT
+  size: number
+  rotation: number
+  rotationLocked: boolean
+  proportional: boolean
+  proportionalScale: number
+  symbolOffset: [number, number]
+  symbolData: string
 }
 
-declare interface JLayerStyleLine extends JLayerStyleVector {
-  styleType: JLAYER_STYLE_TYPES.LINE
-  lineColor: JRGBColor
+declare interface JLayerLineStyle extends JLayerBaseStyle {
+  type: JLAYER_STYLE_TYPES.LINE
   lineThickness: number
-  arrowType: JLAYER_STYLE_ARROWS
-  arrowPositionFromLeftInPerCent: number
-  stroke: JLayerStyleLineStroke
-}
-
-declare interface JLayerStyleSurface extends JLayerStyleVector {
-  styleType: JLAYER_STYLE_TYPES.SURFACE
-  fillColor: JRGBColor
+  lineColor: string
+  arrowType: JLAYER_STYLE_ARROW_TYPES
+  arrowPosition: number
+  lineCap: JLAYER_STYLE_LINE_CAP
+  lineJoin: JLAYER_STYLE_LINE_JOIN
+  dashPattern: number[]
+  patternData: string
+}
+
+declare interface JLayerPolygonStyle extends JLayerBaseStyle {
+  type: JLAYER_STYLE_TYPES.POLYGON
+  fillColor: string
+  borderColor: string
   transparentFill: boolean
-  borderColor: JRGBColor
-  borderTransparencyInPercent: number
   borderThickness: number
-  surfacePattern: string
-  patternColor: JRGBColor
-  patternTransparentFill: boolean
-}
-
-declare interface JLayerStyleAnnotation extends JLayerStyleVector {
-  styleType: JLAYER_STYLE_TYPES.ANNOTATION
-  textFont: string
-  textColor: JRGBColor
-  textBold: boolean
-  textItalic: boolean
-  textUnderlined: boolean
-  textStrikeThrough: boolean
-  textOutlined: boolean
-  textOutlineColor: JRGBColor
-}
-
-declare interface JLayerStyleMixed extends JLayerStyleVector {
-  styleType: JLAYER_STYLE_TYPES.MIXED
-  point: JLayerStylePoint
-  line: JLayerStyleLine
-  surface: JLayerStyleSurface
-  text: JLayerStyleAnnotation
-}
-
-declare interface JLayerStyleSymbolImage {
-  absoluteFilePath: string
+  borderTransparency: number
+  borderDashPattern: number[]
+  borderPatternData: string
+  patternData: string
 }
 
-declare interface JLayerStyleSymbolVector {
-  vectorSymbol: string
-  borderThickness: number
-  borderColor: JRGBColor
-  transparentFill: boolean
-  fillColor: JRGBColor
+declare interface JLayerTextStyle extends JLayerBaseStyle {
+  type: JLAYER_STYLE_TYPES.TEXT
+  textColor: string
+  outlineColor: string
+  bold: boolean
+  italic: boolean
 }
 
-declare interface JRGBColor {
-  red: number
-  green: number
-  blue: number
-  alpha: number
-  hexa: string
-}
+declare type JLayerSetSelectionStyleParam =
+  | (Pick<JLayerLineStyle, "type"> & Partial<Pick<JLayerLineStyle, "lineColor" | "lineThickness">>)
+  | (Pick<JLayerPolygonStyle, "type"> &
+      Partial<Pick<JLayerPolygonStyle, "fillColor" | "borderColor" | "borderThickness">>)
+  | (Pick<JLayerPointStyle, "type"> & Partial<Pick<JLayerPointStyle, "symbolData">>)
 
 declare interface JLayerSetLayersVisibilityParams {
   layerId: JId