Class EsriSublayer

Hierarchy

  • Accessor
  • Loadable
  • Identifiable
    • EsriSublayer

Constructors

Properties

declaredClass: string
definitionExpression: string

A SQL where clause used to filter features in the image.

Read more...

destroyed: boolean
fields: EsriField[]

An array of fields in the Sublayer.

Read more...

fieldsIndex: FieldsIndex

A convenient property that can be used to make case-insensitive lookups for a field by name.

Read more...

floorInfo: LayerFloorInfo

If a map image layer contains a sublayer which is meant to be floor-aware, then that sublayer must have a floorInfo property, containing a LayerFloorInfo object which has a string property to represent the floorField.

Read more...

fullExtent: EsriExtent

The full extent of the Sublayer.

Read more...

id: number

The sublayer's layer ID.

Read more...

initialized: boolean
labelingInfo: LabelClass[]

The label definition for this layer, specified as an array of LabelClass objects.

Read more...

labelsVisible: boolean

Indicates if labels for the sublayer will be visible in the view.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#labelsVisible)

The MapImageLayer or TileLayer to which the sublayer belongs.

Read more...

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#legendEnabled)
listMode: "show" | "hide" | "hide-children"

Indicates how the layer should display in the LayerList widget.

Default

show

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#listMode)
loadError: Error

The Error object returned if an error occurred while loading.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError)
loadStatus: "loaded" | "loading" | "not-loaded" | "failed"

Represents the status of a load operation.

Default

not-loaded

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadStatus)
loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

maxScale: number

The maximum scale (most zoomed in) at which the layer is visible in the view.

Read more...

minScale: number

The minimum scale (most zoomed out) at which the layer is visible in the view.

Read more...

objectIdField: string

The name of an oid field containing a unique value or identifier for each feature in the Sublayer.

Read more...

opacity: number

The level of opacity to set on the sublayer on a scale from 0.0 - 1.0 where 0 is fully transparent and 1.0 is fully opaque.

Read more...

popupEnabled: boolean

Indicates whether to display popups when features in the layer are clicked.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html#popupEnabled)
popupTemplate: PopupTemplate

The popup template for the sublayer.

Read more...

renderer: EsriRenderer

The renderer to apply to the sublayer.

Read more...

source: DynamicMapLayer | DynamicDataLayer

An object that allows you to create a dynamic layer with data either from the map service sublayers or data from a registered workspace.

Read more...

sourceJSON: any

The map service's metadata JSON exposed by the ArcGIS REST API.

Read more...

sublayers: Collection<EsriSublayer>

If a sublayer contains sublayers, this property is a Collection of Sublayer objects belonging to the given sublayer with sublayers.

Read more...

title: string

The title of the sublayer used to identify it in places such as the LayerList and Legend widgets.

Read more...

typeIdField: string

The name of the field holding the type ID or subtypes for the features.

Read more...

types: FeatureType[]

An array of subtypes defined in the feature service exposed by ArcGIS REST API.

Read more...

url: string

The URL to the REST endpoint of the sublayer.

Read more...

visible: boolean

Indicates if the layer is visible in the view.

Read more...

Methods

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriSublayer

  • Type Parameters

    • T

    Parameters

    • handles: IHandle | IHandle[]
    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Cancels a load() operation if it is already in progress.

    Read more...

    Returns void

  • Creates a popup template for the sublayer, populated with all the fields of the sublayer.

    Read more...

    Parameters

    • Optional options: CreatePopupTemplateOptions

    Returns PopupTemplate

  • Creates a Query object with default values representing the layer's state, including filters (definition expression) on the layer's features.

    Read more...

    Returns EsriQuery

  • Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

  • Returns a FeatureType describing the feature's type.

    Read more...

    Parameters

    Returns FeatureType

  • Returns the Domain associated with the given field name.

    Read more...

    Parameters

    • fieldName: string
    • Optional options: SublayerGetFieldDomainOptions

    Returns Domain

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns boolean

  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

  • Parameters

    • propertyName: string

    Returns void

  • Deprecated

    Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.

    Parameters

    • handles: IHandle | IHandle[]

    Returns void

  • TODO Documentation

    Read more...

    Parameters

    • attachmentQuery: AttachmentQuery | AttachmentQueryProperties
    • Optional options: SublayerQueryAttachmentsOptions

    Returns void

  • Executes a query against features in the sublayer.

    Read more...

    Parameters

    • Optional query: EsriQuery | QueryProperties
    • Optional options: SublayerQueryFeaturesOptions

    Returns Promise<FeatureSet>

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriSublayer

  • Parameters

    • props: HashMap<any>

    Returns EsriSublayer

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc