Interface FeatureLayerBaseProperties

Properties that can be specified for the FeatureLayerExtensionBaseProperties.layer property.

interface FeatureLayerBaseProperties {
    $portalItem?: PortalItemLike;
    $ref?: string | LayerReference;
    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";
    capabilities?: string;
    customParameters?: Record<string, unknown>;
    definitionEditor?: DefinitionEditorJson;
    disablePopup?: boolean;
    effect?: EffectJson;
    featureCollection?: FeatureCollectionJson;
    featureCollectionType?: "route" | "markup" | "notes";
    formInfo?: FormInfoJson;
    id?: string;
    itemId?: string;
    layerDefinition?: LayerDefinitionJson;
    layerType: "ArcGISFeatureLayer";
    listMode?: LayerListMode;
    maxScale?: number;
    minScale?: number;
    mode?:
        | 0
        | 1
        | 2
        | 6;
    opacity?: number;
    popupInfo?: PopupInfoJson;
    refreshInterval?: number;
    screenSizePerspective?: boolean;
    showLabels?: boolean;
    showLegend?: boolean;
    subtypeCode?: string | number;
    timeAnimation?: boolean;
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    url?: string;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
    visibleLayers?: number[];
}

Hierarchy (view full)

Properties

$portalItem? $ref? blendMode? capabilities? customParameters? definitionEditor? disablePopup? effect? featureCollection? featureCollectionType? formInfo? id? itemId? layerDefinition? layerType listMode? maxScale? minScale? mode? opacity? popupInfo? refreshInterval? screenSizePerspective? showLabels? showLegend? subtypeCode? timeAnimation? title? type? url? visibility? visibilityTimeExtent? visibleLayers?

Properties

Optional$portalItem

$portalItem?: PortalItemLike

When present, mapping/_LayerExtension!LayerExtension.layer will be loaded from the given web layer in Portal. The web layer can be specified either as a PortalItem object, or simply using the portal item ID.

Optional$ref

$ref?: string | LayerReference

A reference to an existing layer, which is the ID or title of the layer (or both). In this case, the layer extension will attempt to find an existing layer instead of creating one.

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.

Optionalcapabilities

capabilities?: string

A comma-separated string listing which editing operations are allowed on an editable feature service. Available operations include: Create | Delete | Query | Update | Editing.

OptionalcustomParameters

customParameters?: Record<string, unknown>

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

OptionaldefinitionEditor

definitionEditor?: DefinitionEditorJson

Stores interactive filters.

OptionaldisablePopup

disablePopup?: boolean

Indicates whether to allow a client to ignore popups defined by the service item.

Optionaleffect

effect?: EffectJson

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

OptionalfeatureCollection

featureCollection?: FeatureCollectionJson

A featureCollection object defining a layer of features whose geometry and attributes will be stored directly within the web map. This is only used when no url property is supplied.

OptionalfeatureCollectionType

featureCollectionType?: "route" | "markup" | "notes"

Indicates the type of features in the feature collection. If featureCollectionType is missing, it means the feature collection is a regular single-layer or multi-layer feature collection.

OptionalformInfo

formInfo?: FormInfoJson

A formInfo object defining the content of the form when you are editing a feature.

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

The type of layer.

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.

Optionalmode

mode?:
    | 0
    | 1
    | 2
    | 6

Used with ArcGIS feature services and individual layers in ArcGIS map services, this property determines how the features are retrieved from the server. This property is represented as 0, 1, or 2.

  • 0: Snapshot mode. Immediately retrieves all features when the map is loaded.
  • 1: On-demand mode. Features within the current view extent are retrieved as the user navigates the map. This is the default and the most common way to use feature services in web maps.
  • 2: Selection-only mode. No features are initially retrieved. This mode is used when you have a map service and a feature service from the same parent URL that are working together in the same map, with the map service being used for display and the feature service used for editing.

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.

OptionalpopupInfo

popupInfo?: PopupInfoJson

A PopupInfo object defining the content of pop-up windows when you click or query a feature.

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.

OptionalscreenSizePerspective

screenSizePerspective?: boolean

Apply perspective scaling to screen-size symbols.

OptionalshowLabels

showLabels?: boolean

Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.

OptionalshowLegend

showLegend?: boolean

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

OptionalsubtypeCode

subtypeCode?: string | number

The feature subtype code identifying the layer. Used with SubtypeGroupLayers.

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, than 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.

OptionalvisibleLayers

visibleLayers?: number[]

An array of sublayer ids that should appear visible. Used with feature layers that are based on feature collections.

Settings

Member Visibility

On This Page

Properties