Interface BingLayerJson

Indicates if working with Microsoft Bing layers. There are three layer types associated with Bing Layers: BingMapsAerial, BingMapsRoad, and BingMapsHybrid.

See https://developers.arcgis.com/web-map-specification/objects/bingLayer/.

interface BingLayerJson {
    bingKey: string;
    blendMode?:
        | "invert"
        | "normal"
        | "lighter"
        | "multiply"
        | "color"
        | "average"
        | "color-burn"
        | "color-dodge"
        | "darken"
        | "destination-atop"
        | "destination-in"
        | "destination-out"
        | "destination-over"
        | "difference"
        | "exclusion"
        | "hard-light"
        | "hue"
        | "lighten"
        | "luminosity"
        | "minus"
        | "overlay"
        | "plus"
        | "reflect"
        | "saturation"
        | "screen"
        | "soft-light"
        | "source-atop"
        | "source-in"
        | "source-out"
        | "vivid-light"
        | "xor";
    canShareBingPublic: boolean;
    effect?: EffectJson;
    id?: string;
    isReference?: boolean;
    itemId?: string;
    layerType: "BingMapsAerial" | "BingMapsHybrid" | "BingMapsRoad";
    maxScale?: number;
    minScale?: number;
    opacity?: number;
    portalUrl: string;
    showLegend?: boolean;
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
}

Hierarchy (view full)

Properties

bingKey blendMode? canShareBingPublic effect? id? isReference? itemId? layerType maxScale? minScale? opacity? portalUrl showLegend? title? type? visibility? visibilityTimeExtent?

Properties

bingKey

bingKey: string

String value that unlocks the use of Bing layers in a web map.

OptionalblendMode

blendMode?:
    | "invert"
    | "normal"
    | "lighter"
    | "multiply"
    | "color"
    | "average"
    | "color-burn"
    | "color-dodge"
    | "darken"
    | "destination-atop"
    | "destination-in"
    | "destination-out"
    | "destination-over"
    | "difference"
    | "exclusion"
    | "hard-light"
    | "hue"
    | "lighten"
    | "luminosity"
    | "minus"
    | "overlay"
    | "plus"
    | "reflect"
    | "saturation"
    | "screen"
    | "soft-light"
    | "source-atop"
    | "source-in"
    | "source-out"
    | "vivid-light"
    | "xor"

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

canShareBingPublic

canShareBingPublic: boolean

Boolean value indicating whether the Bing key can be shared to the public.

Optionaleffect

effect?: EffectJson

Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.

Optionalid

id?: string

A unique identifying string for the layer.

OptionalisReference

isReference?: boolean

This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).

OptionalitemId

itemId?: string

Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.

layerType

layerType: "BingMapsAerial" | "BingMapsHybrid" | "BingMapsRoad"

The type of layer.

OptionalmaxScale

maxScale?: number

A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.

OptionalminScale

minScale?: number

A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.

Optionalopacity

opacity?: number

The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.

portalUrl

portalUrl: string

A string value representing the URL to the portal/organization. Calls should be made to this property to retrieve the Bing key. If the key is not made accessible to the public or if canShareBingPublic is false, any web maps using Bing layers will not work.

OptionalshowLegend

showLegend?: boolean

Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.

Optionaltitle

title?: string

A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.

Optionaltype

type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType

(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.

Optionalvisibility

visibility?: boolean

Determines whether the layer is initially visible in the web map.

OptionalvisibilityTimeExtent

visibilityTimeExtent?: [number, number]

Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.

Settings

Member Visibility

On This Page

Properties