Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Sublayer

Hierarchy

Index

Properties

declaredClass

declaredClass: string

definitionExpression

definitionExpression: string

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

Read more...

destroyed

destroyed: boolean

Readonly fields

fields: Field[]

An array of fields in the Sublayer.

Read more...

Readonly fieldsIndex

fieldsIndex: FieldsIndex

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

Read more...

Readonly fullExtent

fullExtent: Extent

The full extent of the Sublayer.

Read more...

id

id: number

The sublayer's layer ID.

Read more...

initialized

initialized: boolean

labelingInfo

labelingInfo: LabelClass[]

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

Read more...

labelsVisible

labelsVisible: boolean

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

Read more...

layer

The MapImageLayer or TileLayer to which the sublayer belongs.

Read more...

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

listMode

listMode: "show" | "hide" | "hide-children"

Indicates how the layer should display in the LayerList widget.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

loadStatus: "not-loaded" | "loading" | "failed" | "loaded"

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

maxScale

maxScale: number

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

Read more...

minScale

minScale: number

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

Read more...

Readonly objectIdField

objectIdField: string

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

Read more...

opacity

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

popupEnabled: boolean

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

Read more...

popupTemplate

popupTemplate: PopupTemplate

The popup template for the sublayer.

Read more...

renderer

renderer: Renderer

The renderer to apply to the sublayer.

Read more...

source

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

sourceJSON: any

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

Read more...

sublayers

sublayers: Collection<Sublayer>

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

Read more...

title

title: string

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

Read more...

Readonly typeIdField

typeIdField: string

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

Read more...

Readonly types

types: FeatureType[]

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

Read more...

url

url: string

The URL to the REST endpoint of the sublayer.

Read more...

visible

visible: boolean

Indicates if the layer is visible in the view.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Sublayer
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Sublayer

cancelLoad

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

    Read more...

    Returns void

clone

  • Creates a deep clone of the sublayer.

    Read more...

    Returns Sublayer

createFeatureLayer

  • A convenient method for creating a FeatureLayer instance based on the Sublayer's configuration, including dynamic sources.

    Read more...

    Returns Promise<FeatureLayer>

createPopupTemplate

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

    Read more...

    Parameters

    Returns PopupTemplate

createQuery

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

    Read more...

    Returns supportQuery

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getFeatureType

  • Returns a FeatureType describing the feature's type.

    Read more...

    Parameters

    Returns FeatureType

getFieldDomain

isFulfilled

  • isFulfilled(): 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

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

    Read more...

    Returns boolean

isResolved

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

    Read more...

    Returns boolean

load

  • load(signal?: AbortSignal): Promise<any>
  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

queryFeatures

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Sublayer

  • Parameters

    Returns Sublayer

watch

  • Parameters

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

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • 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