jmapcloud-ng-core-types 0.3.1 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jmapcloud-ng-core-types",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -29,14 +29,13 @@
29
29
  "homepage": "https://github.com/k2geospatial/jmapcloud-ng-core-types#readme",
30
30
  "devDependencies": {
31
31
  "gulp": "^4.0.2",
32
- "gulp-typedoc-k2": "^3.0.2-k2.1",
33
32
  "typedoc": "^0.24.8"
34
33
  },
35
34
  "dependencies": {
36
35
  "@types/geojson": "^7946.0.7",
37
- "maplibre-gl": "^3.2.1",
38
36
  "@types/react": "^16.8.3",
39
37
  "geojson": "^0.5.0",
38
+ "maplibre-gl": "^3.2.1",
40
39
  "redux": "^4.0.0"
41
40
  }
42
41
  }
package/public/core.d.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Examples are availables <a href="https://doc.k2geospatial.com/jmap/doc/ng_dev/examples.html" target="_blank">here</a>.
5
5
  *
6
- * You can customize JMap Cloud NG Core library by providing startup options ([[JCoreOptions]]).
6
+ * You can customize JMap Cloud NG Core library by providing startup options ({@link JCoreOptions}).
7
7
  *
8
8
  * After being loaded, the **NG Core** library is accessible through the namespace **JMap** in the javascript console. For example :
9
9
  * ```ts
@@ -87,7 +87,7 @@ declare namespace JMap {
87
87
  *
88
88
  * Returns the operating system on witch JMap Cloud NG Core library is running client side.
89
89
  *
90
- * Possible values returned are defined here [[JOPERATING_SYSTEMS]].
90
+ * Possible values returned are defined here {@link JOPERATING_SYSTEMS}.
91
91
  *
92
92
  * @example ```ts
93
93
  *
@@ -230,7 +230,7 @@ declare namespace JMap {
230
230
  /**
231
231
  * **JMap.Server.getIdentityProviderById**
232
232
  *
233
- * Returns the specified Identity Provider. Provider Ids can be derived from [[JMap.Server.getAllIdentityProvidersById]]
233
+ * Returns the specified Identity Provider. Provider Ids can be derived from {@link JMap.Server.getAllIdentityProvidersById}
234
234
  *
235
235
  * @throws if specified provider id is not valid or not found, or if the server is not ready (info from server has not been fetched). Call JMap.Server.isReady() to know this information.
236
236
  * @param providerId the provider identity id
@@ -369,9 +369,9 @@ declare namespace JMap {
369
369
  /**
370
370
  * **JMap.Geocoding.forwardSearch**
371
371
  *
372
- * Proceeds with a forward geocoding search. Some characters are not permitted in search strings (see [[JMap.Geocoding.getInvalidSearchStringCharacters]]).
372
+ * Proceeds with a forward geocoding search. Some characters are not permitted in search strings (see {@link JMap.Geocoding.getInvalidSearchStringCharacters}).
373
373
  * Calling this method may not trigger immediately a forward geocoding search if the string is too short, or if the method is repetitively called too fast.
374
- * You can set an event listener to have access to the forward search results (see [[TBD]]). Search Reasults are also available in the redux store under store-->geocoding-->results
374
+ * You can set an event listener to have access to the forward search results. Search Reasults are also available in the redux store under store-->geocoding-->results
375
375
  *
376
376
  * @param searchText The place name to search for. Can be an address, a region's name, or a geographical location expressed as "longitude,latitude" (ex: "-73.576321,45.495757" )
377
377
  * @param options an optional JGeocodingOptions object
@@ -395,7 +395,7 @@ declare namespace JMap {
395
395
  /**
396
396
  * **JMap.Geocoding.displayForwardSearchResult**
397
397
  *
398
- * Will display on the map the result of a [[JMap.Geocoding.forwardSearch]] single result.
398
+ * Will display on the map the result of a {@link JMap.Geocoding.forwardSearch} single result.
399
399
  *
400
400
  * @param forwardSearchResult A JGeocodingResult object
401
401
  * @throws If geocoding is not enabled, or if an unexpected error occurs
@@ -442,7 +442,7 @@ declare namespace JMap {
442
442
  *
443
443
  * Returns false if the JMap Cloud NG Core library has been started with option that disable the geolocation.
444
444
  *
445
- * See startup parameter [[JCoreOption.geolocationEnabled]].
445
+ * See startup parameter {@link JCoreOptions.geolocationEnabled}.
446
446
  *
447
447
  * @example ```ts
448
448
  *
@@ -739,7 +739,7 @@ declare namespace JMap {
739
739
  * @param parameterName: the name of the parameter
740
740
  * @param fn: the function that will be processed when the property changed
741
741
  *
742
- * @returns the listener id, can be used to remove the listener with [[JMap.History.removePropertyChangeListener]]
742
+ * @returns the listener id, can be used to remove the listener with {@link JMap.History.removePropertyChangeListener}
743
743
  *
744
744
  * @throws Error if parameterName is not a valid string or fn is not a function
745
745
  *
@@ -759,7 +759,7 @@ declare namespace JMap {
759
759
  * **JMap.History.removePropertyChangeListener**
760
760
  *
761
761
  * You can detach a property listener by its id that has been returned when it has been created
762
- * with function [[JMap.History.onParameterChange]].
762
+ * with function {@link JMap.History.onParameterChange}.
763
763
  *
764
764
  * After that the listener will be destroyed.
765
765
  *
@@ -945,7 +945,7 @@ declare namespace JMap {
945
945
  * Shows or hides a specific layer thematic category on the map.
946
946
  *
947
947
  * @throws Error if layer or thematic is not found, or if an invalid param is provided
948
- * @param params a [[JLayerThematicSetCategoryVisibilityParams]] object
948
+ * @param params a {@link JLayerThematicSetCategoryVisibilityParams} object
949
949
  * @example ```ts
950
950
  *
951
951
  * // Hide the first category of thematic id=3 of layer id=7
@@ -988,7 +988,7 @@ declare namespace JMap {
988
988
  * Works only for JMap Cloud server.
989
989
  *
990
990
  * @throws Error if layer or thematic is not found, or thematic is not a style rule thematic, or if an invalid param is provided
991
- * @param params a [[JLayerThematicSetConditionVisibilityParams]] object
991
+ * @param params a {@link JLayerThematicSetConditionVisibilityParams} object
992
992
  * @example ```ts
993
993
  *
994
994
  * // Hide condition of thematic id="ac7b197c-ca14-4295-b349-8cba6a4dc631" of layer id="53ff7632-0d5e-497a-a1b0-25ce3f941023"
@@ -2451,7 +2451,7 @@ declare namespace JMap {
2451
2451
  /**
2452
2452
  * **JMap.Geometry.getFeatureFromLine**
2453
2453
  *
2454
- * Returns a line feature from a line object ([[JLine]]).
2454
+ * Returns a line feature from a line object ({@link JLine}).
2455
2455
  *
2456
2456
  * @param line A line array
2457
2457
  * @example ```ts
@@ -2483,7 +2483,7 @@ declare namespace JMap {
2483
2483
  /**
2484
2484
  * **JMap.Geometry.getPolygonFeatureFromCircle**
2485
2485
  *
2486
- * Returns a polygon feature from a circle object ([[JCircle]]).
2486
+ * Returns a polygon feature from a circle object ({@link JCircle}).
2487
2487
  *
2488
2488
  * @param circle A circle object
2489
2489
  * @param units unit of the radius
@@ -2499,7 +2499,7 @@ declare namespace JMap {
2499
2499
  /**
2500
2500
  * **JMap.Geometry.getFeatureFromPolygon**
2501
2501
  *
2502
- * Returns a polygon feature from a polygon array ([[JPolygon]]).
2502
+ * Returns a polygon feature from a polygon array ({@link JPolygon}).
2503
2503
  *
2504
2504
  * @param polygon A polygon array
2505
2505
  * @example ```ts
@@ -2514,7 +2514,7 @@ declare namespace JMap {
2514
2514
  /**
2515
2515
  * **JMap.Geometry.getBboxFromFeature**
2516
2516
  *
2517
- * Returns the feature geometry boundary box ([[JBoundaryBox]]).
2517
+ * Returns the feature geometry boundary box ({@link JBoundaryBox}).
2518
2518
  *
2519
2519
  * @param feature A feature object
2520
2520
  * @example ```ts
@@ -3711,7 +3711,7 @@ declare namespace JMap {
3711
3711
  *
3712
3712
  * Display a pulsing dot on the map to hilite a location, with options
3713
3713
  *
3714
- * Flashed feature can be immediatly removed using [[JMap.Map.clearFlashingLocations]]
3714
+ * Flashed feature can be immediatly removed using {@link JMap.Map.clearFlashingLocations}
3715
3715
  *
3716
3716
  * @param location a JLocation
3717
3717
  * @param options (see example)
@@ -3756,7 +3756,7 @@ declare namespace JMap {
3756
3756
  *
3757
3757
  * Display a collection of pulsing dots on the map to hilite several locations, with options
3758
3758
  *
3759
- * Flashed features can be immediatly removed using [[JMap.Map.clearFlashingLocations]]
3759
+ * Flashed features can be immediatly removed using {@link JMap.Map.clearFlashingLocations}
3760
3760
  *
3761
3761
  * @param locations an array of JLocations
3762
3762
  * @param options (see example)
@@ -3799,7 +3799,7 @@ declare namespace JMap {
3799
3799
  /**
3800
3800
  * **JMap.Map.clearFlashingLocations**
3801
3801
  *
3802
- * Immediatly remove all flashed locations on the map that have been displayed using [[JMap.Map.flashLocation]] or [[JMap.Map.flashLocations]]
3802
+ * Immediatly remove all flashed locations on the map that have been displayed using {@link JMap.Map.flashLocation} or {@link JMap.Map.flashLocations}
3803
3803
  *
3804
3804
  * @example ```ts
3805
3805
  *
@@ -4142,7 +4142,7 @@ declare namespace JMap {
4142
4142
  *
4143
4143
  * So we defined our own map interactors for JMap, and we also allow you to create and register your own interactors.
4144
4144
  *
4145
- * An interactor is a JS object that define 4 functions (for more details consult interface [[JMapInteractor]]) :
4145
+ * An interactor is a JS object that define 4 functions (for more details consult interface {@link JMapInteractor}) :
4146
4146
  * ```ts
4147
4147
  * - init(map: maplibregl.Map): void
4148
4148
  * - activate(): void
@@ -4664,7 +4664,7 @@ declare namespace JMap {
4664
4664
  * @throws Error if layer is not found or location format is not good
4665
4665
  * @param layerId The JMap layer id
4666
4666
  * @param location The location where you want feature selection
4667
- * @param params selection parameters, see [[JMapSelectionParams]]
4667
+ * @param params selection parameters, see {@link JMapSelectionParams}
4668
4668
  * @returns The features array
4669
4669
  * @example ```ts
4670
4670
  *
@@ -4686,7 +4686,7 @@ declare namespace JMap {
4686
4686
  * @throws Error if layer is not found or if circle format is not good
4687
4687
  * @param layerId The JMap layer id
4688
4688
  * @param circle The circle
4689
- * @param params selection parameters, see [[JMapSelectionParams]]
4689
+ * @param params selection parameters, see {@link JMapSelectionParams}
4690
4690
  * @returns The features array
4691
4691
  * @example ```ts
4692
4692
  *
@@ -4715,7 +4715,7 @@ declare namespace JMap {
4715
4715
  * @throws Error if layer is not found or if line format is not good
4716
4716
  * @param layerId The JMap layer id
4717
4717
  * @param line The line
4718
- * @param params selection parameters, see [[JMapSelectionParams]]
4718
+ * @param params selection parameters, see {@link JMapSelectionParams}
4719
4719
  * @returns The features array
4720
4720
  * @example ```ts
4721
4721
  *
@@ -4741,7 +4741,7 @@ declare namespace JMap {
4741
4741
  * @throws Error if layer is not found or if line format is not good
4742
4742
  * @param layerId The JMap layer id
4743
4743
  * @param polygon The line
4744
- * @param params selection parameters, see [[JMapSelectionParams]]
4744
+ * @param params selection parameters, see {@link JMapSelectionParams}
4745
4745
  * @returns The features array
4746
4746
  * @example ```ts
4747
4747
  *
@@ -4772,7 +4772,7 @@ declare namespace JMap {
4772
4772
  *
4773
4773
  * @throws Error if location format is not good
4774
4774
  * @param location The location where you want feature selection
4775
- * @param params selection parameters, see [[JMapSelectionParams]]
4775
+ * @param params selection parameters, see {@link JMapSelectionParams}
4776
4776
  * @returns The new feature selection
4777
4777
  * @example ```ts
4778
4778
  *
@@ -4789,7 +4789,7 @@ declare namespace JMap {
4789
4789
  *
4790
4790
  * @throws Error if circle format is not good
4791
4791
  * @param circle The circle
4792
- * @param params selection parameters, see [[JMapSelectionParams]]
4792
+ * @param params selection parameters, see {@link JMapSelectionParams}
4793
4793
  * @returns The new feature selection
4794
4794
  * @example ```ts
4795
4795
  *
@@ -4810,7 +4810,7 @@ declare namespace JMap {
4810
4810
  *
4811
4811
  * @throws Error if line format is not good
4812
4812
  * @param line The line
4813
- * @param params selection parameters, see [[JMapSelectionParams]]
4813
+ * @param params selection parameters, see {@link JMapSelectionParams}
4814
4814
  * @returns The new feature selection
4815
4815
  * @example ```ts
4816
4816
  *
@@ -4832,7 +4832,7 @@ declare namespace JMap {
4832
4832
  *
4833
4833
  * @throws Error if polygon format is not good
4834
4834
  * @param polygon The polygon
4835
- * @param params selection parameters, see [[JMapSelectionParams]]
4835
+ * @param params selection parameters, see {@link JMapSelectionParams}
4836
4836
  * @returns The new feature selection
4837
4837
  * @example ```ts
4838
4838
  *
@@ -5030,7 +5030,7 @@ declare namespace JMap {
5030
5030
  *
5031
5031
  * Returns true if basemaps are disabled.
5032
5032
  *
5033
- * Can be disabled with option disableBasemaps [[JCoreOptions]] in JS options, or with url param "ngDisableBasemaps=true".
5033
+ * Can be disabled with option disableBasemaps {@link JCoreOptions} in JS options, or with url param "ngDisableBasemaps=true".
5034
5034
  *
5035
5035
  * @example ```ts
5036
5036
  *
@@ -5874,7 +5874,7 @@ declare namespace JMap {
5874
5874
  /**
5875
5875
  * **JMap.Project.isChangeDisabled**
5876
5876
  *
5877
- * Returns true if the project change has been disabled by startup option "disableProjectChange" (see [[JCoreOptions]]).
5877
+ * Returns true if the project change has been disabled by startup option "disableProjectChange" (see {@link JCoreOptions}).
5878
5878
  *
5879
5879
  * Notice that as long the first project has not been loaded, this method returns false even if the parameter is true.
5880
5880
  *
@@ -6167,7 +6167,7 @@ declare namespace JMap {
6167
6167
  *
6168
6168
  * For JMapCloud only.
6169
6169
  *
6170
- * Sets and returns Session Data specific to a JMap Cloud organization. You need to be previously authenticated via the [[JMap.User.login]] method before calling this method.
6170
+ * Sets and returns Session Data specific to a JMap Cloud organization. You need to be previously authenticated via the {@link JMap.User.login} method before calling this method.
6171
6171
  * This method can also be used to switch between organizations while a user is already logged in.
6172
6172
  *
6173
6173
  * @throws Error if user is not authenticated
@@ -6203,7 +6203,7 @@ declare namespace JMap {
6203
6203
  /**
6204
6204
  * **JMap.User.loginWithIdentityProvider**
6205
6205
  *
6206
- * Logs in the user using the specified Identity Provider. See [[JMap.Server.getAllIdentityProvidersById]] for info about Identity providers
6206
+ * Logs in the user using the specified Identity Provider. See {@link JMap.Server.getAllIdentityProvidersById} for info about Identity providers
6207
6207
  *
6208
6208
  * @example ```ts
6209
6209
  *
@@ -6261,9 +6261,9 @@ declare namespace JMap {
6261
6261
  *
6262
6262
  * This process is a bit different for JMap Server than for JMap CLoud.
6263
6263
  *
6264
- * For JMap Server, you need to fetch a session token from the REST API, and call [[JMap.User.setToken]] without spedifying the organization Id.
6264
+ * For JMap Server, you need to fetch a session token from the REST API, and call {@link JMap.User.setToken} without spedifying the organization Id.
6265
6265
  *
6266
- * For JMap Cloud, you need to fetch a ***refresh token*** from the JMap Cloud Rest API, and pass this refresh token, along with the the optional organisation Id, to the [[JMap.User.setToken]] method. Beware that a refresh token can only be used once, it is invalidated afterward
6266
+ * For JMap Cloud, you need to fetch a ***refresh token*** from the JMap Cloud Rest API, and pass this refresh token, along with the the optional organisation Id, to the {@link JMap.User.setToken} method. Beware that a refresh token can only be used once, it is invalidated afterward
6267
6267
  *
6268
6268
  * Fetching data from a REST API can be done with the curl command-line tool (https://curl.haxx.se/docs/)
6269
6269
  *
@@ -6610,7 +6610,7 @@ declare namespace JMap {
6610
6610
  *
6611
6611
  * @example ```ts
6612
6612
  *
6613
- * // Supported locales can be retrieved by calling [[JMap.Language.getLocales()]]
6613
+ * // Supported locales can be retrieved by calling JMap.Language.getLocales()
6614
6614
  * const locale = "fr"
6615
6615
  * JMap.Language.setLocale(locale)
6616
6616
  * ```
@@ -6627,11 +6627,11 @@ declare namespace JMap {
6627
6627
  * in your bundle for the current locale.
6628
6628
  *
6629
6629
  * @throws if bundle is invalid or already defined
6630
- * @param bundle a [[JTranslationBundle]] object
6630
+ * @param bundle a {@link JTranslationBundle} object
6631
6631
  *
6632
6632
  * @example ```ts
6633
6633
  *
6634
- * // Supported locales can be retrieved by calling [[JMap.Language.getLocales()]]
6634
+ * // Supported locales can be retrieved by calling JMap.Language.getLocales()
6635
6635
  *
6636
6636
  * const bundle = {
6637
6637
  * id: "my-custom-bundle-id",
@@ -6718,7 +6718,7 @@ declare namespace JMap {
6718
6718
  *
6719
6719
  * @example ```ts
6720
6720
  *
6721
- * // Supported locales can be retrieved by calling [[JMap.Language.getLocales()]]
6721
+ * // Supported locales can be retrieved by calling JMap.Language.getLocales()
6722
6722
  *
6723
6723
  * const bundle = {
6724
6724
  * id: "my-custom-bundle-id",
@@ -6987,7 +6987,7 @@ declare namespace JMap {
6987
6987
  *
6988
6988
  * Here you can manage all JMap Cloud NG Core high level event listeners.
6989
6989
  *
6990
- * Click to see all events available: ***[[JMap.Event.Main.on]]***.
6990
+ * Click to see all events available: ***{@link JMap.Event.Main.on}***.
6991
6991
  */
6992
6992
  namespace Main {
6993
6993
  /**
@@ -7110,7 +7110,7 @@ declare namespace JMap {
7110
7110
  *
7111
7111
  * Here you can manage all query event listeners.
7112
7112
  *
7113
- * Click to see all events available: ***[[JMap.Event.Query.on]]***.
7113
+ * Click to see all events available: ***{@link JMap.Event.Query.on}***.
7114
7114
  */
7115
7115
  namespace Query {
7116
7116
  /**
@@ -7254,7 +7254,7 @@ declare namespace JMap {
7254
7254
  *
7255
7255
  * Here you can manage all geocoding event listeners.
7256
7256
  *
7257
- * Click to see all events available: ***[[JMap.Event.Geocoding.on]]***.
7257
+ * Click to see all events available: ***{@link JMap.Event.Geocoding.on}***.
7258
7258
  */
7259
7259
  namespace Geocoding {
7260
7260
  /**
@@ -7445,7 +7445,7 @@ declare namespace JMap {
7445
7445
  *
7446
7446
  * Here you can manage all JMap Cloud NG map context event listeners.
7447
7447
  *
7448
- * Click to see all events available: ***[[JMap.Event.MapContext.on]]***.
7448
+ * Click to see all events available: ***{@link JMap.Event.MapContext.on}***.
7449
7449
  */
7450
7450
  namespace MapContext {
7451
7451
  /**
@@ -7664,7 +7664,7 @@ declare namespace JMap {
7664
7664
  *
7665
7665
  * Here you can manage all extension event listeners.
7666
7666
  *
7667
- * List of events are located in ***[[JMap.Event.Extension.on]]***.
7667
+ * List of events are located in ***{@link JMap.Event.Extension.on}***.
7668
7668
  */
7669
7669
  namespace Extension {
7670
7670
  /**
@@ -7788,7 +7788,7 @@ declare namespace JMap {
7788
7788
  *
7789
7789
  * Here you can manage all form event listeners.
7790
7790
  *
7791
- * Click to see all events available: ***[[JMap.Event.Form.on]]***.
7791
+ * Click to see all events available: ***{@link JMap.Event.Form.on}***.
7792
7792
  */
7793
7793
  namespace Form {
7794
7794
  /**
@@ -8001,7 +8001,7 @@ declare namespace JMap {
8001
8001
  *
8002
8002
  * Here you can manage all project related event listeners.
8003
8003
  *
8004
- * Click to see all events available: ***[[JMap.Event.Project.on]]***.
8004
+ * Click to see all events available: ***{@link JMap.Event.Project.on}***.
8005
8005
  */
8006
8006
  namespace Project {
8007
8007
  /**
@@ -8153,7 +8153,7 @@ declare namespace JMap {
8153
8153
  *
8154
8154
  * Here you can manage all layer related event listeners.
8155
8155
  *
8156
- * Click to see all events available: ***[[JMap.Event.Layer.on]]***.
8156
+ * Click to see all events available: ***{@link JMap.Event.Layer.on}***.
8157
8157
  */
8158
8158
  namespace Layer {
8159
8159
  /**
@@ -8379,7 +8379,7 @@ declare namespace JMap {
8379
8379
  *
8380
8380
  * This event is triggered when some dynamic filters are set.
8381
8381
  *
8382
- * Could happen when a map context is applied, or when we use the method [[JMap.Layer.DynamicFilter.set]].
8382
+ * Could happen when a map context is applied, or when we use the method {@link JMap.Layer.DynamicFilter.set}.
8383
8383
  *
8384
8384
  * @param listenerId Your listener id (must be unique for all layer events)
8385
8385
  * @param fn Your listener function
@@ -8548,7 +8548,7 @@ declare namespace JMap {
8548
8548
  *
8549
8549
  * Here you can manage all map related event listeners.
8550
8550
  *
8551
- * Click to see all events available: ***[[JMap.Event.Map.on]]***.
8551
+ * Click to see all events available: ***{@link JMap.Event.Map.on}***.
8552
8552
  */
8553
8553
  namespace Map {
8554
8554
  /**
@@ -9108,7 +9108,7 @@ declare namespace JMap {
9108
9108
  *
9109
9109
  * Here you can manage all photo event listeners.
9110
9110
  *
9111
- * Click to see all events available: ***[[JMap.Event.Photo.on]]***.
9111
+ * Click to see all events available: ***{@link JMap.Event.Photo.on}***.
9112
9112
  */
9113
9113
  namespace Photo {
9114
9114
  /**
@@ -9198,7 +9198,7 @@ declare namespace JMap {
9198
9198
  *
9199
9199
  * Here you can manage all feature related event listeners.
9200
9200
  *
9201
- * Click to see all events available: ***[[JMap.Event.Feature.on]]***.
9201
+ * Click to see all events available: ***{@link JMap.Event.Feature.on}***.
9202
9202
  */
9203
9203
  namespace Feature {
9204
9204
  /**
@@ -9325,7 +9325,7 @@ declare namespace JMap {
9325
9325
  *
9326
9326
  * Here you can manage all language related event listeners.
9327
9327
  *
9328
- * Click to see all events available: ***[[JMap.Event.Language.on]]***.
9328
+ * Click to see all events available: ***{@link JMap.Event.Language.on}***.
9329
9329
  */
9330
9330
  namespace Language {
9331
9331
  /**
@@ -9413,7 +9413,7 @@ declare namespace JMap {
9413
9413
  *
9414
9414
  * Here you can manage all user related event listeners.
9415
9415
  *
9416
- * Click to see all events available: ***[[JMap.Event.User.on]]***.
9416
+ * Click to see all events available: ***{@link JMap.Event.User.on}***.
9417
9417
  */
9418
9418
  namespace User {
9419
9419
  /**
@@ -9510,7 +9510,7 @@ declare namespace JMap {
9510
9510
  *
9511
9511
  * Here you can manage all mouseover related event listeners.
9512
9512
  *
9513
- * List of events are located in ***[[JMap.Event.MouseOver.on]]***.
9513
+ * List of events are located in ***{@link JMap.Event.MouseOver.on}***.
9514
9514
  */
9515
9515
  namespace MouseOver {
9516
9516
  /**
@@ -9712,7 +9712,7 @@ declare namespace JMap {
9712
9712
  *
9713
9713
  * This mecanism provide a clean way to integrate in JMap your own extension plugin.
9714
9714
  *
9715
- * You can create an object that implement the interface [[JCoreExtension]], and register it
9715
+ * You can create an object that implement the interface {@link JCoreExtension}, and register it
9716
9716
  * from this section.
9717
9717
  *
9718
9718
  * By example you register an extension with id="***MyCompany***"".
@@ -10100,7 +10100,7 @@ declare namespace JMap {
10100
10100
  *
10101
10101
  * Returns the currently displayed form.
10102
10102
  *
10103
- * Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.
10103
+ * Use {@link JMap.Form.hasDisplayedForm} to know if a form is currently displayed.
10104
10104
  *
10105
10105
  * @throws if no layer is displayed
10106
10106
  * @example ```ts
@@ -10119,7 +10119,7 @@ declare namespace JMap {
10119
10119
  *
10120
10120
  * Resets the currently displayed form.
10121
10121
  *
10122
- * Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.
10122
+ * Use {@link JMap.Form.hasDisplayedForm} to know if a form is currently displayed.
10123
10123
  *
10124
10124
  * @throws if no layer is displayed
10125
10125
  * @example ```ts
@@ -10142,7 +10142,7 @@ declare namespace JMap {
10142
10142
  *
10143
10143
  * Index starts at 0 (attribute form), 1 (first external form), etc...
10144
10144
  *
10145
- * Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.
10145
+ * Use {@link JMap.Form.hasDisplayedForm} to know if a form is currently displayed.
10146
10146
  *
10147
10147
  * @param tabIndex the tab index
10148
10148
  * @throws if no layer is displayed, if index is invalid.
@@ -10305,7 +10305,7 @@ declare namespace JMap {
10305
10305
  * const layerId = 3
10306
10306
  * const featureId = 4
10307
10307
  * // in this exemple we fetch the feature from the server, but we could get from the map
10308
- * // with the following method [[JMap.Map.getRenderedFeatures]]
10308
+ * // with the following method JMap.Map.getRenderedFeatures
10309
10309
  * const feature = await JMap.Feature.getById(layerId, featureId)
10310
10310
  * // opens form update dialog for one element of layer id=3
10311
10311
  * JMap.Form
@@ -11377,7 +11377,7 @@ declare namespace JMap {
11377
11377
  *
11378
11378
  * Throws an Error if the passed Id is not a valid JMap Id, otherwise does nothing. You can use this method as a safeguard in your methods that accept JMap Ids.
11379
11379
  * JMap.Util.checkJmapId always run a strict check on the passed value, i.e. the string "123" will not pass. If you want the value to be compliant, you
11380
- * can use [[JMap.Util.getJmapIdAsIntegerIfPossible]] to transform it.
11380
+ * can use {@link JMap.Util.getJmapIdAsIntegerIfPossible} to transform it.
11381
11381
  *
11382
11382
  *
11383
11383
  * @param id The JMap Id to validate
@@ -11674,7 +11674,7 @@ declare namespace JMap {
11674
11674
  *
11675
11675
  * Updates a map context meta-data (= data that describe the context), without changing the map data.
11676
11676
  *
11677
- * The map context map's data will not be changed, for that use [[JMap.MapContext.update]] function.
11677
+ * The map context map's data will not be changed, for that use {@link JMap.MapContext.update} function.
11678
11678
  *
11679
11679
  * The map-context meta-data is persisted server-side.
11680
11680
  *
@@ -6,9 +6,9 @@ declare interface JExtensionServerOverride {
6
6
  /**
7
7
  * The extension's override unique identifier.
8
8
  *
9
- * For JMap CLoud, this would be the [[JCoreExtension.jmapCloudExtensionUrn]] property of your extension
9
+ * For JMap CLoud, this would be the {@link JCoreExtension.jmapCloudExtensionUrn} property of your extension
10
10
  *
11
- * For JMap Server, this would be the [[JCoreExtension.serverExtensionId]] property of your extension
11
+ * For JMap Server, this would be the {@link JCoreExtension.serverExtensionId} property of your extension
12
12
  *
13
13
  */
14
14
  extensionUniqueIdentifier: string
@@ -84,11 +84,11 @@ declare interface JCoreExtension {
84
84
  *
85
85
  * This parameter is used to uniquely identify your extension among all other JMap Cloud extensions.
86
86
  *
87
- * This parameter can be set alongside [[JCoreExtension.serverExtensionId]] if your extension is also available for JMap Server.
87
+ * This parameter can be set alongside {@link JCoreExtension.serverExtensionId} if your extension is also available for JMap Server.
88
88
  *
89
89
  * If set, this parameter ***must*** be a {@link https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)|UUID v4 string}. Each Jmap Cloud extension must have a unique identifier, so you have to make sure that each of your extensions defines a unique `jmapCloudExtensionUrn`.
90
90
  *
91
- * JMap Cloud ***only*** supports [[JCoreExtension.isProjectExtension|Project extensions]]
91
+ * JMap Cloud ***only*** supports {@link JCoreExtension.isProjectExtension|Project extensions}
92
92
  *
93
93
  */
94
94
  jmapCloudExtensionUrn?: string
@@ -113,7 +113,7 @@ declare interface JCoreExtension {
113
113
  startBeforeMapIsReady?: boolean
114
114
  /**
115
115
  * You can provide a translation bundle for your extesion. All translations will be handled by the JMap Cloud NG
116
- * translation engine. See [[JMap.Language.addBundle]] for more details on bundles
116
+ * translation engine. See {@link JMap.Language.addBundle} for more details on bundles
117
117
  */
118
118
  translationBundle?: JTranslationBundle
119
119
  /**
@@ -147,7 +147,7 @@ declare interface JCoreExtension {
147
147
  *
148
148
  * Like that you can develop UI component that react to the redux state changes.
149
149
  *
150
- * You can get the data store using this function : [[JMap.getDataStore]], and then dispatch
150
+ * You can get the data store using this function : {@link JMap.getDataStore}, and then dispatch
151
151
  * your own actions.
152
152
  *
153
153
  * A redux reducer is a pure JS function that take the current reducer state (can be undefined first time)
@@ -157,7 +157,7 @@ declare interface JCoreExtension {
157
157
  /**
158
158
  * You can provide a renderMouseOver function.
159
159
  *
160
- * If set, this function has to return a [[JExtensionMouseOver]], and it will be displayed
160
+ * If set, this function has to return a {@link JExtensionMouseOver}, and it will be displayed
161
161
  * at the end of the standard mouseover.
162
162
  *
163
163
  * @param layer The JMap layer object
@@ -263,9 +263,9 @@ declare interface JCoreOptions {
263
263
  /**
264
264
  * The JMap user's session token.
265
265
  *
266
- * If you don't use the library with an anonymous user (see the [[***JCoreOptions.anonymous***]] parameter in this section), you must provide a JMap Server session token or a JMap Cloud refresh token to the JMap library.
266
+ * If you don't use the library with an anonymous user (see the ***{@link JCoreOptions.anonymous}*** parameter in this section), you must provide a JMap Server session token or a JMap Cloud refresh token to the JMap library.
267
267
  *
268
- * To get a session or refresh token, you can use the JMap Rest API on your JMap Server. See [[JMap.User.setToken]] for detailed examples on how to fetch a token through JMap's REST API.
268
+ * To get a session or refresh token, you can use the JMap Rest API on your JMap Server. See {@link JMap.User.setToken} for detailed examples on how to fetch a token through JMap's REST API.
269
269
  *
270
270
  * So to start the library using the fetched token you can configure your startup options like this :
271
271
  * ```html
@@ -328,7 +328,7 @@ declare interface JCoreOptions {
328
328
  /**
329
329
  * The JMap Cloud organization id associated with the refresh token.
330
330
  *
331
- * For JMap CLoud only. Only taken into account if a refresh token has been passed via the [[JCoreOptions.token]] startup option (or the equivalent hash parameter version)
331
+ * For JMap CLoud only. Only taken into account if a refresh token has been passed via the {@link JCoreOptions.token} startup option (or the equivalent hash parameter version)
332
332
  * ***or*** if the "anonymous" option has been passed, together with a project id.
333
333
  *
334
334
  * You can pass this organization id to open a session on JMap Cloud via the startup options.
@@ -394,14 +394,14 @@ declare interface JCoreOptions {
394
394
  /**
395
395
  * All map related options.
396
396
  *
397
- * Click on [[JCoreMapOptions]] to get details.
397
+ * Click on {@link JCoreMapOptions} to get details.
398
398
  */
399
399
  map?: JCoreMapOptions
400
400
 
401
401
  /**
402
402
  * Optional extensions.
403
403
  *
404
- * Click [[JCoreExtension]] to get details about how defining an extension.
404
+ * Click {@link JCoreExtension} to get details about how defining an extension.
405
405
  */
406
406
  extensions?: JCoreExtension[]
407
407
 
@@ -413,7 +413,7 @@ declare interface JCoreOptions {
413
413
  /**
414
414
  * If set to any of the locales supported by JMap, will define the default locale, bypassing browser or user-defined locale.
415
415
  *
416
- * Supported locales can be retrieved by calling [[JMap.User.getLocales()]]
416
+ * Supported locales can be retrieved by calling {@link JMap.Language.getLocales}
417
417
  */
418
418
  locale?: string
419
419
 
@@ -476,7 +476,7 @@ declare interface JCoreOptions {
476
476
  *
477
477
  * If provided, will use the corresponding basemap as the default basemap.
478
478
  *
479
- * If the id is unknown, will do nothing. To get all basemaps ids in the project, use [[JMap.Map.Basemap.getAllIds()]]
479
+ * If the id is unknown, will do nothing. To get all basemaps ids in the project, use {@link JMap.Map.Basemap.getAllIds}
480
480
  *
481
481
  * Using the id "none" will use no basemap at startup.
482
482
  *