@itwin/map-layers 4.0.0-dev.24 → 4.0.0-dev.28

package/CHANGELOG.md

@@ -13,6 +13,11 @@ Wed, 08 Feb 2023 14:58:40 GMT
 - Fix Map Layers widget not updating after an iModel gets geolocated.
 -  Use EmptyLocalization for localization in tests to increase test performance
 
+## 3.5.6
+Fri, 24 Feb 2023 16:02:47 GMT
+
+_Version update only_
+
 ## 3.5.5
 Thu, 26 Jan 2023 22:53:28 GMT
 
@@ -43,7 +48,7 @@ Wed, 07 Dec 2022 19:12:37 GMT
 
 ### Updates
 
-- MapLayers widget's preferences UI now support edit,delete buttons without having an iModel ID. Also fix an issue with edit. 
+- MapLayers widget's preferences UI now support edit,delete buttons without having an iModel ID. Also fix an issue with edit.
 - Unpin classnames package
 
 ## 3.4.7
@@ -521,7 +526,7 @@ Mon, 24 May 2021 15:58:39 GMT
 
 ### Updates
 
-- Fix 'npm run cover' that would never complete. 
+- Fix 'npm run cover' that would never complete.
 - Exposed the map masking option in the map layers settings UI.
 - Move map tile trees to Viewport to handle synching correctly
 - Update to latest classnames package
@@ -596,7 +601,7 @@ Tue, 09 Mar 2021 20:28:13 GMT
 
 ### Updates
 
-- Restored base layer visibility button in map manager. 
+- Restored base layer visibility button in map manager.
 - Updated to use TypeScript 4.1
 - begin rename project from iModel.js to iTwin.js
 
@@ -621,7 +626,7 @@ Thu, 18 Feb 2021 22:10:13 GMT
 ### Updates
 
 - Provide default props to map-layers widget when used as an extension.
-- ArcGIS token-based authentification support: MapLayerManager now monitor provider status and display a warning icon when there is a authentifiation error while loading tiles.  User is allowed to provide credentials without the need to fully re-attach the layer.  Invalid credentials feedback is now provided.  It is now possible to save an ArcGIS layer requiring authentification in the settings service, althoug redentials wont be persisted. 
+- ArcGIS token-based authentification support: MapLayerManager now monitor provider status and display a warning icon when there is a authentifiation error while loading tiles.  User is allowed to provide credentials without the need to fully re-attach the layer.  Invalid credentials feedback is now provided.  It is now possible to save an ArcGIS layer requiring authentification in the settings service, althoug redentials wont be persisted.
 
 ## 2.11.2
 Thu, 18 Feb 2021 02:50:59 GMT

package/lib/cjs/MapLayerPreferences.d.ts

@@ -1,89 +1,89 @@
-import { MapLayerSource } from "@itwin/core-frontend";
-import { BeEvent, GuidString } from "@itwin/core-bentley";
-/** @internal */
-export interface MapLayerPreferencesContent {
-    url: string;
-    name: string;
-    formatId: string;
-    transparentBackground: boolean | undefined;
-}
-/** @internal */
-export declare enum MapLayerSourceChangeType {
-    Added = 0,
-    Removed = 1,
-    Replaced = 2
-}
-/** @internal */
-export interface MapLayerSourceArg {
-    readonly source: MapLayerSource;
-    readonly iTwinId: GuidString;
-    readonly iModelId: GuidString;
-}
-/** A wrapper around user preferences to provide a way to store [[MapLayerSettings]].
- *
- * Note: This is currently internal only and used directly by the MapLayersExtension. It makes use of the IModelApp.authorizationClient if it exists.
- *
- * @internal
- */
-export declare class MapLayerPreferences {
-    /** Event raised whenever a source is added, replaced or removed:
-     *    changeType : Type of changed occurred.
-     *    oldSource : Source that was removed or replaced.
-     *    newSource : Source that was added or replacement of oldSource.
-     *
-     * @see [[MapLayerSourceChangeType]]
-     */
-    static readonly onLayerSourceChanged: BeEvent<(changeType: MapLayerSourceChangeType, oldSource?: MapLayerSource | undefined, newSource?: MapLayerSource | undefined) => void>;
-    /** Store the Map Layer source preference. If the same setting exists at a higher level, an error will be thrown and the setting will not be updated.
-     *
-     * Returns false if the settings object would override some other settings object in a larger scope i.e. storing settings on model when
-     * a project setting exists with same name or map layer url.
-     * @param source source to be stored on the setting service
-     * @param storeOnIModel if true store the settings object on the model, if false store it on the project
-     */
-    static storeSource(source: MapLayerSource, iTwinId: GuidString, iModelId?: GuidString, storeOnIModel?: boolean): Promise<boolean>;
-    /** Replace the old map layer source with a new map layer source.
-     *
-     * The source is replaced at the same level that the original source is defined. (i.e. if the old source is defined at a project level, the new source will also be defined there.)
-     *
-     * @param oldSource
-     * @param newSource
-     * @param iTwinId
-     * @param iModelId
-     */
-    static replaceSource(oldSource: MapLayerSource, newSource: MapLayerSource, iTwinId: GuidString, iModelId?: GuidString): Promise<void>;
-    /** Deletes the provided MapLayerSource by name from both the iTwin or iModel level.
-     *
-     * @param source The source to delete. The name is used to identify the source.
-     * @param iTwinId
-     * @param iModelId
-     */
-    static deleteByName(source: MapLayerSource, iTwinId: GuidString, iModelId?: GuidString): Promise<void>;
-    /** Deletes the current setting with the provided key if it is defined at the same preference level.
-     *
-     * If the preference is defined within a different level, false will be returned indicating the setting should not be overriden.
-     *
-     * The two potential preference levels are iTwin and iModel.
-     *
-     * @param url
-     * @param name
-     * @param iTwinId
-     * @param iModelId
-     * @param storeOnIModel
-     */
-    private static delete;
-    /** Attempts to get a map layer based off a specific url.
-     * @param url
-     * @param iTwinId
-     * @param iModelId
-     */
-    static getByUrl(url: string, iTwinId: string, iModelId?: string): Promise<MapLayerPreferencesContent | undefined>;
-    /** Get all MapLayerSources from the user's preferences, iTwin setting and iModel settings.
-     * @param iTwinId id of the iTwin
-     * @param iModelId id of the iModel
-     * @throws if any of the calls to grab settings fail.
-     */
-    static getSources(iTwinId: GuidString, iModelId?: GuidString): Promise<MapLayerSource[]>;
-    private static get _preferenceNamespace();
-}
+import { MapLayerSource } from "@itwin/core-frontend";
+import { BeEvent, GuidString } from "@itwin/core-bentley";
+/** @internal */
+export interface MapLayerPreferencesContent {
+    url: string;
+    name: string;
+    formatId: string;
+    transparentBackground: boolean | undefined;
+}
+/** @internal */
+export declare enum MapLayerSourceChangeType {
+    Added = 0,
+    Removed = 1,
+    Replaced = 2
+}
+/** @internal */
+export interface MapLayerSourceArg {
+    readonly source: MapLayerSource;
+    readonly iTwinId: GuidString;
+    readonly iModelId: GuidString;
+}
+/** A wrapper around user preferences to provide a way to store [[MapLayerSettings]].
+ *
+ * Note: This is currently internal only and used directly by the MapLayersExtension. It makes use of the IModelApp.authorizationClient if it exists.
+ *
+ * @internal
+ */
+export declare class MapLayerPreferences {
+    /** Event raised whenever a source is added, replaced or removed:
+     *    changeType : Type of changed occurred.
+     *    oldSource : Source that was removed or replaced.
+     *    newSource : Source that was added or replacement of oldSource.
+     *
+     * @see [[MapLayerSourceChangeType]]
+     */
+    static readonly onLayerSourceChanged: BeEvent<(changeType: MapLayerSourceChangeType, oldSource?: MapLayerSource | undefined, newSource?: MapLayerSource | undefined) => void>;
+    /** Store the Map Layer source preference. If the same setting exists at a higher level, an error will be thrown and the setting will not be updated.
+     *
+     * Returns false if the settings object would override some other settings object in a larger scope i.e. storing settings on model when
+     * a project setting exists with same name or map layer url.
+     * @param source source to be stored on the setting service
+     * @param storeOnIModel if true store the settings object on the model, if false store it on the project
+     */
+    static storeSource(source: MapLayerSource, iTwinId: GuidString, iModelId?: GuidString, storeOnIModel?: boolean): Promise<boolean>;
+    /** Replace the old map layer source with a new map layer source.
+     *
+     * The source is replaced at the same level that the original source is defined. (i.e. if the old source is defined at a project level, the new source will also be defined there.)
+     *
+     * @param oldSource
+     * @param newSource
+     * @param iTwinId
+     * @param iModelId
+     */
+    static replaceSource(oldSource: MapLayerSource, newSource: MapLayerSource, iTwinId: GuidString, iModelId?: GuidString): Promise<void>;
+    /** Deletes the provided MapLayerSource by name from both the iTwin or iModel level.
+     *
+     * @param source The source to delete. The name is used to identify the source.
+     * @param iTwinId
+     * @param iModelId
+     */
+    static deleteByName(source: MapLayerSource, iTwinId: GuidString, iModelId?: GuidString): Promise<void>;
+    /** Deletes the current setting with the provided key if it is defined at the same preference level.
+     *
+     * If the preference is defined within a different level, false will be returned indicating the setting should not be overriden.
+     *
+     * The two potential preference levels are iTwin and iModel.
+     *
+     * @param url
+     * @param name
+     * @param iTwinId
+     * @param iModelId
+     * @param storeOnIModel
+     */
+    private static delete;
+    /** Attempts to get a map layer based off a specific url.
+     * @param url
+     * @param iTwinId
+     * @param iModelId
+     */
+    static getByUrl(url: string, iTwinId: string, iModelId?: string): Promise<MapLayerPreferencesContent | undefined>;
+    /** Get all MapLayerSources from the user's preferences, iTwin setting and iModel settings.
+     * @param iTwinId id of the iTwin
+     * @param iModelId id of the iModel
+     * @throws if any of the calls to grab settings fail.
+     */
+    static getSources(iTwinId: GuidString, iModelId?: GuidString): Promise<MapLayerSource[]>;
+    private static get _preferenceNamespace();
+}
 //# sourceMappingURL=MapLayerPreferences.d.ts.map