# Interface MapImageLayerExtensionProperties

Properties that can be passed into the constructor for MapImageLayerExtension.

interface MapImageLayerExtensionProperties {
attachmentTypes?: string[];
failureMode?: FailureMode;
featureActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>;
featureSettings?: FeatureSettingsProperties;
featureSourceActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>;
hyperlinks?: (HyperlinkProperties | Hyperlink)[];
iconUrl?: string;
id?: string;
layer?: MapImageLayer | {
$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";
customParameters?: Record<string, unknown>;
effect?: EffectJson;
id?: string;
isReference?: boolean;
itemId?: string;
layers?: SublayerJson[];
layerType: "ArcGISMapServiceLayer";
listMode?: "show" | "hide" | "hide-children";
maxScale?: number;
minScale?: number;
opacity?: number;
refreshInterval?: number;
showLegend?: boolean;
timeAnimation?: boolean;
title?: string;
type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
url?: string;
visibility?: boolean;
visibilityTimeExtent?: [number, number];
visibleLayers?: number[];
};
layerListSettings?: LayerListSettingsProperties;
onAddFeature?: Action;
onEditFeature?: Action;
relationships?: (Relationship | RelationshipProperties)[];
requestHelper?: ArcGISRequestHelper;
schema?: SchemaProperties;
sublayerExtensions?: (MapImageSublayerExtension | MapImageSublayerExtensionProperties)[];
taskSettings?: TaskSettingsProperties;
tpkSource?: string;
visibilityMode?: "inherited" | "independent" | "exclusive";
}

#### Hierarchy (view full)

- LayerExtensionProperties
  - MapImageLayerExtensionProperties

#####
Index

### Properties

attachmentTypes?
failureMode?
featureActions?
featureSettings?
featureSourceActions?
hyperlinks?
iconUrl?
id?
layer?
layerListSettings?
onAddFeature?
onEditFeature?
relationships?
requestHelper?
schema?
sublayerExtensions?
taskSettings?
tpkSource?
visibilityMode?

##
Properties

### `Optional` attachmentTypes

attachmentTypes?: string[]

See data/FeatureSource!FeatureSource.attachmentTypes.

Inherited from LayerExtensionProperties.attachmentTypes

### `Optional` failureMode

failureMode?: FailureMode

See support/InitializableBase!InitializableBase.failureMode.

Inherited from LayerExtensionProperties.failureMode

### `Optional` featureActions

featureActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>

A menu for actions specifically related to features from this source.

Inherited from LayerExtensionProperties.featureActions

### `Optional` featureSettings

featureSettings?: FeatureSettingsProperties

See data/FeatureSource!FeatureSource.featureSettings.

Inherited from LayerExtensionProperties.featureSettings

### `Optional` featureSourceActions

featureSourceActions?: MenuProperties | Menu<MenuItemProperties, MenuProperties, MenuItem<MenuItemProperties, MenuProperties>>

A menu for actions specifically related to this source.

Inherited from LayerExtensionProperties.featureSourceActions

### `Optional` hyperlinks

hyperlinks?: (HyperlinkProperties | Hyperlink)[]

See data/FeatureSource!FeatureSource.hyperlinks.

Inherited from LayerExtensionProperties.hyperlinks

### `Optional` iconUrl

iconUrl?: string

See mapping/_LayerExtension!LayerExtension.iconUrl.

Inherited from LayerExtensionProperties.iconUrl

### `Optional` id

id?: string

The unique ID to assign to the entity. If not specified, one will be generated.

Inherited from LayerExtensionProperties.id

### `Optional` layer

layer?: MapImageLayer | {
$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";
customParameters?: Record<string, unknown>;
effect?: EffectJson;
id?: string;
isReference?: boolean;
itemId?: string;
layers?: SublayerJson[];
layerType: "ArcGISMapServiceLayer";
listMode?: "show" | "hide" | "hide-children";
maxScale?: number;
minScale?: number;
opacity?: number;
refreshInterval?: number;
showLegend?: boolean;
timeAnimation?: boolean;
title?: string;
type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
url?: string;
visibility?: boolean;
visibilityTimeExtent?: [number, number];
visibleLayers?: number[];
}

See mapping/_LayerExtension!LayerExtension.layer.

#### Type declaration

- ##### `Optional`$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?: 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.

- ##### `Optional` 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.

- ##### `Optional` customParameters?: Record<string, unknown>

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

- ##### `Optional` effect?: EffectJson

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

- ##### `Optional` id?: string

  A unique identifying string for the layer.

- ##### `Optional` 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).

- ##### `Optional` itemId?: string

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

- ##### `Optional` layers?: SublayerJson[]

  An array of layer objects defining the styling, geometry, and attribute information for the features.

- ##### layerType: "ArcGISMapServiceLayer"

  Type of the layer.

- ##### `Optional` listMode?: "show" | "hide" | "hide-children"

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

- ##### `Optional` 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.

- ##### `Optional` 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.

- ##### `Optional` opacity?: number

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

- ##### `Optional` 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.

- ##### `Optional` showLegend?: boolean

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

- ##### `Optional` timeAnimation?: boolean

  This property is applicable to layers that support time. If 'true', timeAnimation is enabled.

- ##### `Optional` 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.

- ##### `Optional` 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.

- ##### `Optional` url?: string

  The URL to the layer.

- ##### `Optional` visibility?: boolean

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

- ##### `Optional` 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.

- ##### `Optional` visibleLayers?: number[]

  An array of layers that should appear visible. Used with ArcGIS map services that are not tiled in addition to WMS layers. Array of items of the following types: Number With ArcGIS map services, the array contains integers of the index positions of each visible layer.

Overrides LayerExtensionProperties.layer

### `Optional` layerListSettings

layerListSettings?: LayerListSettingsProperties

See mapping/_LayerExtension!LayerExtension.layerListSettings.

Inherited from LayerExtensionProperties.layerListSettings

### `Optional` onAddFeature

onAddFeature?: Action

See data/FeatureSource!FeatureSource.onAddFeature.

Inherited from LayerExtensionProperties.onAddFeature

### `Optional` onEditFeature

onEditFeature?: Action

See data/FeatureSource!FeatureSource.onEditFeature.

Inherited from LayerExtensionProperties.onEditFeature

### `Optional` relationships

relationships?: (Relationship | RelationshipProperties)[]

See mapping/_LayerExtension!LayerExtension.relationships.

Inherited from LayerExtensionProperties.relationships

### `Optional` requestHelper

requestHelper?: ArcGISRequestHelper

See mapping/_LayerExtension!LayerExtension.requestHelper.

Inherited from LayerExtensionProperties.requestHelper

### `Optional` schema

schema?: SchemaProperties

See data/FeatureSource!FeatureSource.schema.

Inherited from LayerExtensionProperties.schema

### `Optional` sublayerExtensions

sublayerExtensions?: (MapImageSublayerExtension | MapImageSublayerExtensionProperties)[]

See mapping/_LayerExtension!LayerExtension.sublayerExtensions.

Overrides LayerExtensionProperties.sublayerExtensions

### `Optional` taskSettings

taskSettings?: TaskSettingsProperties

See data/FeatureSource!FeatureSource.taskSettings.

Inherited from LayerExtensionProperties.taskSettings

### `Optional` tpkSource

tpkSource?: string

See mapping/_LayerExtension!LayerExtension.tpkSource.

Inherited from LayerExtensionProperties.tpkSource

### `Optional` visibilityMode

visibilityMode?: "inherited" | "independent" | "exclusive"

See mapping/_LayerExtension!LayerExtension.visibilityMode.

Inherited from LayerExtensionProperties.visibilityMode