Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubtypeGroupLayer

Hierarchy

Index

Properties

blendMode

blendMode: "average" | "color-burn" | "color-dodge" | "color" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "invert" | "lighten" | "lighter" | "luminosity" | "minus" | "multiply" | "normal" | "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.

Read more...

Readonly capabilities

Describes the layer's supported capabilities.

Read more...

copyright

copyright: string

Copyright information for the layer.

Read more...

customParameters

customParameters: any

A list of custom parameters appended to the URL of all resources fetched by the layer.

Read more...

declaredClass

declaredClass: string

definitionExpression

definitionExpression: string

The SQL where clause used to filter features on the client.

Read more...

destroyed

destroyed: boolean

displayField

displayField: string

The name of the layer's primary display field.

Read more...

Readonly editFieldsInfo

The editor tracking fields, which record who adds or edits the data through the feature service and when edits are made.

Read more...

editingEnabled

editingEnabled: boolean

Determines if the layer is editable.

Read more...

Readonly editingInfo

If present, this value specifies information about editing.

Read more...

effect

effect: Effect

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work.

Read more...

elevationInfo

Specifies how features are placed on the vertical axis (z).

Read more...

fields

fields: Field[]

An array of fields in the layer.

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

floorInfo

floorInfo: LayerFloorInfo

When a feature layer is configured as floor-aware, it has a floorInfo property defined.

Read more...

formTemplate

formTemplate: FormTemplate

The associated template used in an associated layer's FeatureForm.

Read more...

fullExtent

fullExtent: Extent

The full extent of the layer.

Read more...

gdbVersion

gdbVersion: string

The version of the geodatabase of the feature service data.

Read more...

Readonly geometryFieldsInfo

geometryFieldsInfo: GeometryFieldsInfo

Provides information on the system maintained area and length fields along with their respective units.

Read more...

geometryType

geometryType: "polygon" | "point" | "multipoint" | "polyline" | "mesh" | "multipatch"

The geometry type of features in the layer.

Read more...

hasM

hasM: boolean

Indicates whether the client-side features in the layer have M (measurement) values.

Read more...

hasZ

hasZ: boolean

Indicates whether the client-side features in the layer have Z (elevation) values.

Read more...

historicMoment

historicMoment: Date

The historic moment to query.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

initialized

initialized: boolean

Readonly isTable

isTable: boolean

Returns true if the layer is loaded from a non-spatial table in a service.

Read more...

layerId

layerId: number

The layer ID, or layer index, of a Feature Service layer.

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

Readonly loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

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

objectIdField

objectIdField: string

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

Read more...

opacity

opacity: number

The opacity of the layer.

Read more...

outFields

outFields: string[]

An array of field names from the service to include with each feature.

Read more...

portalItem

portalItem: PortalItem

The portal item from which the layer is loaded.

Read more...

refreshInterval

refreshInterval: number

Refresh interval of the layer in minutes.

Read more...

returnM

returnM: boolean

When true, indicates that M values will be returned.

Read more...

returnZ

returnZ: boolean

When true, indicates that z-values will always be returned.

Read more...

screenSizePerspectiveEnabled

screenSizePerspectiveEnabled: boolean

Apply perspective scaling to screen-size point symbols in a SceneView.

Read more...

Readonly serviceDefinitionExpression

serviceDefinitionExpression: string

The service definition expression limits the features available for display and query.

Read more...

sourceJSON

sourceJSON: any

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

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the layer.

Read more...

sublayers

A Collection of SubtypeSublayer objects that allow you to alter the properties of one or more sublayers of the SubtypeGroupLayer.

Read more...

subtypeField

subtypeField: string

The name of the SubtypeGroupLayer's subtype field.

Read more...

timeExtent

timeExtent: TimeExtent

The layer's time extent.

Read more...

timeInfo

timeInfo: TimeInfo

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

Read more...

timeOffset

timeOffset: TimeInterval

A temporary offset of the time data based on a certain TimeInterval.

Read more...

title

title: string

The title of the layer used to identify it in places such as the LayerList widget.

Read more...

Readonly type

type: "subtype-group"

typeIdField

typeIdField: string

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

Read more...

url

url: string

The URL of the REST endpoint of the layer, non-spatial table or service.

Read more...

useViewTime

useViewTime: boolean

Determines if the layer will update its temporal data based on the view's timeExtent.

Read more...

Readonly version

version: number

The version of ArcGIS Server in which the layer is published.

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

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SubtypeGroupLayer

addAttachment

applyEdits

cancelLoad

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

    Read more...

    Returns void

createLayerView

  • Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

    Read more...

    Parameters

    Returns Promise<LayerView>

createQuery

deleteAttachments

destroy

  • destroy(): void
  • Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchAttributionData

  • fetchAttributionData(): Promise<any>
  • Fetches custom attribution data for the layer when it becomes available.

    Read more...

    Returns Promise<any>

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getField

  • getField(fieldName: string): Field
  • Returns the Field instance for a field name (case-insensitive).

    Read more...

    Parameters

    • fieldName: string

    Returns Field

getFieldDomain

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

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

on

queryAttachments

queryExtent

queryFeatureCount

queryFeatures

queryObjectIds

refresh

  • refresh(): void
  • Fetches all the data for the layer.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SubtypeGroupLayer

  • Parameters

    Returns SubtypeGroupLayer

updateAttachment

  • Updates an existing attachment for a feature.

    Read more...

    Parameters

    • feature: Graphic
    • attachmentId: number
    • attachment: HTMLFormElement | FormData

    Returns Promise<SubtypeGroupLayerFeatureEditResult>

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