# Interface WMSSublayerProperties

Properties that can be specified for the WMSSublayerExtensionProperties.sublayer property.

interface WMSSublayerProperties {
$ref?: string | number | SublayerReference;
$sublayerType?: string;
defaultVisibility?: boolean;
definitionEditor?: DefinitionEditorJson;
disablePopup?: boolean;
featureSet?: FeatureSetJson;
field?: FieldJson;
id?: string | number;
layerDefinition?: LayerDefinitionJson;
layerUrl?: string;
legendUrl?: string;
maxScale?: number;
minScale?: number;
name?: string;
nextObjectId?: number;
parentLayerId?: number;
popupInfo?: PopupInfoJson;
queryable?: boolean;
showLegend?: boolean;
showPopup?: boolean;
subLayerIds?: number[];
title?: string;
visible?: boolean;
}

#### Hierarchy (view full)

- SublayerProperties
- WMSSublayerJson
  - WMSSublayerProperties

#####
Index

### Properties

$ref?
$sublayerType?
defaultVisibility?
definitionEditor?
disablePopup?
featureSet?
field?
id?
layerDefinition?
layerUrl?
legendUrl?
maxScale?
minScale?
name?
nextObjectId?
parentLayerId?
popupInfo?
queryable?
showLegend?
showPopup?
subLayerIds?
title?
visible?

##
Properties

### `Optional`$ref

$ref?: string | number | SublayerReference

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

Inherited from SublayerProperties.$ref

### `Optional`$sublayerType

$sublayerType?: string

The type of sublayer. This property is required when calling mapping/_SublayerExtension!SublayerExtension.create.

Inherited from SublayerProperties.$sublayerType

### `Optional` defaultVisibility

defaultVisibility?: boolean

Default visibility of the layers in the map service.

Inherited from SublayerProperties.defaultVisibility

### `Optional` definitionEditor

definitionEditor?: DefinitionEditorJson

An object that provides interactive filters.

Inherited from SublayerProperties.definitionEditor

### `Optional` disablePopup

disablePopup?: boolean

Indicates whether to allow a client to ignore the popups defined on the layer. The popupInfo object could be saved in the map or item.

Inherited from SublayerProperties.disablePopup

### `Optional` featureSet

featureSet?: FeatureSetJson

A featureSet object containing the geometry and attributes of the features in the layer. Used with feature collections only.

Inherited from SublayerProperties.featureSet

### `Optional` field

field?: FieldJson

Information about each field in a layer.

NOTE: This is how it's typed and documented in the web map spec, but is almost certainly total nonsense.

Inherited from SublayerProperties.field

### `Optional` id

id?: string | number

A number indicating the index position of the layer in the WMS or map service.

Inherited from SublayerProperties.id

### `Optional` layerDefinition

layerDefinition?: LayerDefinitionJson

An array of LayerDefinition objects defining the attribute schema and drawing information for the layer.

Inherited from SublayerProperties.layerDefinition

### `Optional` layerUrl

layerUrl?: string

A URL to a service that should be used for all queries against the layer. Used with hosted tiled map services on ArcGIS Online when there is an associated feature service that allows for queries.

Inherited from SublayerProperties.layerUrl

### `Optional` legendUrl

legendUrl?: string

A string URL to a legend graphic for the layer.

Inherited from WMSSublayerJson.legendUrl

### `Optional` maxScale

maxScale?: number

Represents the maximum scale at which the layer definition will be applied.

Inherited from SublayerProperties.maxScale

### `Optional` minScale

minScale?: number

Represents the minimum scale at which the layer definition will be applied.

Inherited from SublayerProperties.minScale

### `Optional` name

name?: string

(Deprecated, use title instead.) A name for the layer.

Inherited from WMSSublayerJson.name

### `Optional` nextObjectId

nextObjectId?: number

Iterates within a feature set. Number objectId value is incremented +1 based on last Object ID defined for the feature in a feature set.

Inherited from SublayerProperties.nextObjectId

### `Optional` parentLayerId

parentLayerId?: number

If working with nested layers, this is the numeric value indicating the layer id of the next layer (parent) directly above the current referenced layer.

Inherited from SublayerProperties.parentLayerId

### `Optional` popupInfo

popupInfo?: PopupInfoJson

A popupInfo object defining the pop-up window content for the layer.

Inherited from SublayerProperties.popupInfo

### `Optional` queryable

queryable?: boolean

Boolean specifying whether a layer is queryable or not.

Inherited from WMSSublayerJson.queryable

### `Optional` showLegend

showLegend?: boolean

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

Inherited from SublayerProperties.showLegend

### `Optional` showPopup

showPopup?: boolean

Boolean specifying whether to display popup or not.

Inherited from WMSSublayerJson.showPopup

### `Optional` subLayerIds

subLayerIds?: number[]

If the layer is a parent layer, it will have one or more sub layers included in an array.

Inherited from SublayerProperties.subLayerIds

### `Optional` title

title?: string

A user-friendly title for the layer that can be used in a table of contents.

Inherited from WMSSublayerJson.title

### `Optional` visible

visible?: boolean

Visibility of the sublayer.

Inherited from SublayerProperties.visible