@itwin/map-layers 4.0.0-dev.41 → 4.0.0-dev.47

package/README.md

@@ -1,32 +1,32 @@
-# MapLayers Extension/Package
-
-Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
-
-An iTwin.js Extension that adds a widget for attaching and updating map attachments in a view:
-
-This extension serves as an example of a extension that can be added to iTwin.js host applications.
-See <http://itwinjs.org> for comprehensive documentation on the iTwin.js API and the various constructs used in this sample.
-
-This package can also be installed into an application and the method MapLayersUI.initialized() called during the host IModelApps initialize processing.
-
-## Development Setup
-
-1. Select and prepare an iTwin.js host application. You can use the [ui-test-app] to host the extension, for example.
-2. The dependencies are installed as part of "rush install" in the iTwin.js repository.
-3. Build the extension as part of the "rush build" in the iTwin.js repository, or separately build using the npm build command.
-
-    ```sh
-    npm run build
-    ```
-
-4. Start the host application - go to its directory and run:
-
-    ```sh
-    npm run start:servers
-    ```
-
-5. Open a web browser (e.g., Chrome), and browse to http://localhost:3000.
-
-## Contributing
-
-[Contributing to iTwin.js](https://github.com/iTwin/itwinjs-core/blob/master/CONTRIBUTING.md)
+# MapLayers Extension/Package
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+An iTwin.js Extension that adds a widget for attaching and updating map attachments in a view:
+
+This extension serves as an example of a extension that can be added to iTwin.js host applications.
+See <http://itwinjs.org> for comprehensive documentation on the iTwin.js API and the various constructs used in this sample.
+
+This package can also be installed into an application and the method MapLayersUI.initialized() called during the host IModelApps initialize processing.
+
+## Development Setup
+
+1. Select and prepare an iTwin.js host application. You can use the [ui-test-app] to host the extension, for example.
+2. The dependencies are installed as part of "rush install" in the iTwin.js repository.
+3. Build the extension as part of the "rush build" in the iTwin.js repository, or separately build using the npm build command.
+
+    ```sh
+    npm run build
+    ```
+
+4. Start the host application - go to its directory and run:
+
+    ```sh
+    npm run start:servers
+    ```
+
+5. Open a web browser (e.g., Chrome), and browse to http://localhost:3000.
+
+## Contributing
+
+[Contributing to iTwin.js](https://github.com/iTwin/itwinjs-core/blob/master/CONTRIBUTING.md)

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