Interface SubtypeSubtypeGroupLayerJson

Subtype group layers can be created by referencing a layer from a feature service that contains subtypes. Each subtype in the feature service layer can be a separate layer in the subtype group layer, and be given its own display and editing properties. With respect to layer blending, subtype group layers follow the same rules as group layers. See https://developers.arcgis.com/web-map-specification/objects/subtypeSubtypeGroupLayer/.

interface SubtypeSubtypeGroupLayerJson {
    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";
    customParameters?: Record<string, unknown>;
    effect?: EffectJson;
    id?: string;
    itemId?: string;
    layerDefinition?: LayerDefinitionJson;
    layerType: "SubtypeGroupLayer";
    listMode?: LayerListMode;
    maxScale?: number;
    minScale?: number;
    opacity?: number;
    refreshInterval?: number;
    showLegend?: boolean;
    timeAnimation?: boolean;
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    url?: string;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
}

Hierarchy

Properties

blendMode? customParameters? effect? id? itemId? layerDefinition? layerType listMode? maxScale? minScale? opacity? refreshInterval? showLegend? timeAnimation? title? type? url? visibility? visibilityTimeExtent?

Properties

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.

OptionalcustomParameters

customParameters?: Record<string, unknown>

A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types.

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.

OptionalitemId

itemId?: string

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

OptionallayerDefinition

layerDefinition?: LayerDefinitionJson

A layerDefinition object defining the attribute schema and drawing information for the layer.

layerType

layerType

String indicating the layer type.

OptionallistMode

listMode?: LayerListMode

Indicates how the layer should display in the table of contents. The known values are listed below. See support/esri!ListMode.

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.

OptionalrefreshInterval

refreshInterval?: number

When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm.

OptionalshowLegend

showLegend?: boolean

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

OptionaltimeAnimation

timeAnimation?: boolean

Indicates whether to disable time animation if the layer supports it.

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.

Optionalurl

url?: string

The URL to the layer. If the layer is not from a web service but rather a feature collection, then the url property is omitted.

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