@itwin/core-common/lib/esm/BackgroundMapProvider.d.ts

iTwin.js components common to frontend and backend

/** @packageDocumentation
 * @module DisplayStyles
 */
import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
 * @public
 * @extensions
 */
export declare enum BackgroundMapType {
    Street = 1,
    Aerial = 2,
    Hybrid = 3
}
/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.
 * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).
 * @public
 * @extensions
 */
export type BackgroundMapProviderName = "BingProvider" | "MapBoxProvider";
/** JSON representation of a [[BackgroundMapProvider]].
 * @see [[BaseMapLayerProps.provider]].
 * @public
 */
export interface BackgroundMapProviderProps {
    /** The name of the provider. Default: "BingProvider" */
    name?: BackgroundMapProviderName;
    /** The type of imagery to display. Default: Hybrid. */
    type?: BackgroundMapType;
}
/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
 * @public
 */
export declare class BackgroundMapProvider {
    /** The name of the provider. */
    readonly name: BackgroundMapProviderName;
    /** The type of map imagery provided. */
    readonly type: BackgroundMapType;
    private constructor();
    /** Create a provider from its JSON representation. */
    static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider;
    /** Convert this provider to its JSON representation. */
    toJSON(): BackgroundMapProviderProps;
    /** @internal */
    static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider;
    /** Return true if this provider is equivalent to `other`. */
    equals(other: BackgroundMapProvider): boolean;
    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
     */
    clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider;
}
//# sourceMappingURL=BackgroundMapProvider.d.ts.map