Class WMSSublayerExtension

Extends the capabilities of an Esri WMSSublayer object.

Hierarchy (view full)

Constructors

constructor

Properties

_effectiveFullExtent _handles _id _itemType @eventTypes iconUrl? layerListSettings onAddFeature? onEditFeature? queryService? wfsLayerInfo? factory

Accessors

canChangeDefinitionExpression canChangeLabels canChangeOpacity canChangeRenderer canChangeScale canToggleVisibility capabilities effectiveFullExtent effectiveMaxScale effectiveMinScale failureMode featureActions featureSettings featureSourceActions hasFeatures hyperlinks id initialDefinitionExpression initialRenderer initialVisibility isDestroyed isEffectivelyVisible isInitialized itemType layerExtension parentSublayerExtension relationships renderer schema sublayer sublayerExtensions supportsSublayers taskSettings title visibilityMode wfsFeatureType

Methods

_addAttachment _addFeatures _applySublayerProperties _capabilities _createFeatureSettings _createHyperlinks _createLayerListSettings _createRelationships _createSchema _createSublayer _createSublayerExtension _createSublayerExtensionCollection _createSublayerRef _createTaskSettings _deleteAttachments _deleteFeatures _getAttachments _getFeatures _getSerializableProperties _initializableChildCollections _initializeChildren _isRelationship _isSupportedSublayer _onDestroy _onInitialize _onSublayerAddedPostInitialize _postInitialize _serializeSublayer _toPropertyDef _updateFeatures _watchSublayerProperties addAttachment addFeature addFeatures assignProperties assignPropertiesAsync deleteAttachments deleteFeature deleteFeatures destroy finishAssignProperties getAttachments getDefault getDefaults getFeature getFeatures getFullExtent getSerializableProperties initialize initializeWfs toItemUri toJSON updateFeature updateFeatures create

Constructors

constructor

Properties

Protected_effectiveFullExtent

_effectiveFullExtent: Extent

See mapping/_SublayerExtension!SublayerExtension.effectiveFullExtent.

Protected Readonly_handles

_handles: Handles<unknown, ResourceHandle>

Protected_id

_id: string

The unique ID for this entity. Once set, this should never change.

Protected Readonly_itemType

_itemType: string = ItemType.SUBLAYER_EXTENSION

The item type for this entity when it participates in an App.

@eventTypes

@eventTypes: InitializableBaseEvents

Deprecated

Do not directly reference this property. Use EventNames and EventTypes helpers from @arcgis/core/Evented.

OptionaliconUrl

iconUrl?: string

URL to an icon that represents this feature source.

ReadonlylayerListSettings

layerListSettings: LayerListSettings

Settings that affect the behavior and presentation of the sublayer in the layer list.

OptionalonAddFeature

onAddFeature?: Action

The action to be executed when a feature is added.

OptionalonEditFeature

onEditFeature?: Action

The action to be executed when a feature is edited.

OptionalqueryService

queryService?: QueryService

An optional query service that the feature source can use to get features.

OptionalwfsLayerInfo

wfsLayerInfo?: WFSLayerInfo

Information about a corresponding WFS layer that can be used for querying/identifying this sublayer.

If not set explicitly, it can be initialized from the parent layer extension's wfsUrl by calling initializeWfs().

Staticfactory

factory: SublayerExtensionFactory

The factory that will be used whenever a new sublayer extension needs to be created. Applications can supply their own factory to customize sublayer extension creation.

Accessors

canChangeDefinitionExpression

  • get canChangeDefinitionExpression(): boolean

  • Determines whether the type of sublayer being extended supports changing its definition expression.

    Returns boolean

canChangeLabels

  • get canChangeLabels(): boolean

  • Determines whether the type of sublayer being extended supports changing labels. Default is false.

    Returns boolean

canChangeOpacity

  • get canChangeOpacity(): boolean

  • Determines whether the type of sublayer being extended supports changing opacity. Sublayers belonging to tiled layers cannot have their opacity changed, for example. The default is true.

    Returns boolean

canChangeRenderer

  • get canChangeRenderer(): boolean

  • Determines whether the type of sublayer being extended supports changing its renderer.

    Returns boolean

canChangeScale

  • get canChangeScale(): boolean

  • Determines whether the type of sublayer being extended supports changing Scale. Sublayers belonging to tiled layers cannot have their scale changed, for example. The default is true.

    Returns boolean

canToggleVisibility

  • get canToggleVisibility(): boolean

  • Determines whether the type of sublayer being extended supports toggling visibility. Sublayers belonging to tiled layers cannot have their visibilities toggled, for example. The default is true.

    Returns boolean

capabilities

effectiveFullExtent

  • get effectiveFullExtent(): Extent

  • The effective full extent of this sublayer extension.

    Returns Extent

effectiveMaxScale

  • get effectiveMaxScale(): number

  • The effective max scale for this sublayer extension.

    Returns number

effectiveMinScale

  • get effectiveMinScale(): number

  • The effective min scale for this sublayer extension.

    Returns number

failureMode

featureActions

featureSettings

  • get featureSettings(): FeatureSettings

  • Default settings that apply to features originating from this source.

    Returns FeatureSettings

featureSourceActions

hasFeatures

  • get hasFeatures(): boolean

  • Determines whether this type of layer is capable of producing features.

    Returns boolean

hyperlinks

  • Hyperlinks associated with the feature source.

    Returns Collection<Hyperlink>

id

  • get id(): string

  • The unique ID for this entity.

    Returns string

initialDefinitionExpression

  • get initialDefinitionExpression(): string

  • String value containing the initial definition expression configured on the layer.

    Returns string

initialRenderer

  • get initialRenderer(): Renderer

  • A clone of the initial renderer, if any, that the ESRI layer uses to display data on the map.

    Returns Renderer

initialVisibility

  • get initialVisibility(): boolean

  • Indicates the initial layer visibility.

    Returns boolean

isDestroyed

isEffectivelyVisible

  • get isEffectivelyVisible(): boolean

  • The effective visibility for this sublayer extension.

    Returns boolean

isInitialized

itemType

  • get itemType(): string

  • The item type for this entity when it participates in an App.

    Returns string

layerExtension

parentSublayerExtension

relationships

  • get relationships(): Collection<Relationship>

  • Relationships to other feature sources.

    Returns Collection<Relationship>

renderer

  • get renderer(): RendererUnion

  • The renderer, if any, that the ESRI sublayer uses to display data on the map.

    Returns RendererUnion

schema

  • get schema(): Schema

  • Metadata about features originating from this source, such as fields, domains, and geometry type.

    Returns Schema

sublayer

  • get sublayer(): WMSSublayer

  • The sublayer that is being extended.

    Returns WMSSublayer

sublayerExtensions

supportsSublayers

  • get supportsSublayers(): boolean

  • Determines whether this type of sublayer is capable of having sublayers.

    Returns boolean

taskSettings

  • get taskSettings(): TaskSettings

  • Settings that affect whether a feature source participates in various tasks that are performed on a map.

    Returns TaskSettings

title

visibilityMode

  • get visibilityMode(): GroupLayerVisibilityMode

  • Indicates how to manage the visibility of the children layers.

    Returns GroupLayerVisibilityMode

  • set visibilityMode(value): void

  • Parameters

    • value: GroupLayerVisibilityMode

    Returns void

wfsFeatureType

  • get wfsFeatureType(): WFSFeatureType

  • The WFS feature associated with this sublayer if there is an associated wfsLayerInfo.

    Returns WFSFeatureType

Methods

Protected_addAttachment

Protected_addFeatures

  • _addFeatures(features, options?): Promise<void>

  • Called to add new features. Subclasses must override this if they support adding features.

    Parameters

    • features: Iterable<Feature, any, any>

      The features to add.

    • Optionaloptions: FeatureWriteOptions

      Additional options that control how the feature is saved.

    Returns Promise<void>

Protected_applySublayerProperties

Protected_capabilities

Protected_createFeatureSettings

Protected_createHyperlinks

Protected_createLayerListSettings

Protected_createRelationships

Protected_createSchema

Protected_createSublayer

_createSublayerExtension

Protected_createSublayerExtensionCollection

Protected_createSublayerRef

Protected_createTaskSettings

Protected_deleteAttachments

  • _deleteAttachments(feature, attachments): Promise<void>

  • Called to remove attachments from a feature. Subclasses must override this if they support feature attachments.

    Parameters

    • feature: Feature

      The feature to delete attachments from.

    • attachments: (string | Attachment)[]

      The attachments or the IDs of the attachments to delete.

    Returns Promise<void>

Protected_deleteFeatures

  • _deleteFeatures(ids, options?): Promise<void>

  • Called to delete features. Subclasses must override this if they support deleting features.

    Parameters

    • ids: string[]

      The IDs of the features to delete.

    • Optionaloptions: FeatureWriteOptions

      Additional options that control how the features are deleted.

    Returns Promise<void>

Protected_getAttachments

  • _getAttachments(feature): Promise<Attachment[]>

  • Called to retrieve attachments for a feature. Subclasses must override this if they support feature attachments.

    Parameters

    • feature: Feature

      The feature to get attachments for.

    Returns Promise<Attachment[]>

Protected_getFeatures

  • _getFeatures(ids, options?): AsyncIterable<Feature, any, any>

  • Called to retrieve features. Subclasses must override this if they support querying for features.

    Parameters

    • ids: string[]

      The unique IDs of features to retrieve.

    • Optionaloptions: FeatureReadOptions

      Options that control what gets returned.

    Returns AsyncIterable<Feature, any, any>

Protected_getSerializableProperties

Protected_initializableChildCollections

Protected_initializeChildren

Protected_isRelationship

Protected_isSupportedSublayer

  • _isSupportedSublayer(sublayer): boolean

  • Determines whether the sublayer is of the right type for the type of sublayer extension.

    Parameters

    Returns boolean

Protected_onDestroy

  • _onDestroy(): Promise<void>

  • Called to perform cleanup. Subclasses should override this method rather than destroy() to perform custom cleanup.

    Returns Promise<void>

Protected_onInitialize

Protected Readonly_onSublayerAddedPostInitialize

Protected_postInitialize

  • _postInitialize(): Promise<void>

  • Called after normal initialization. Note: Child items are initialized before this is called.

    Returns Promise<void>

Protected_serializeSublayer

Protected_toPropertyDef

Protected_updateFeatures

  • _updateFeatures(features, options?): Promise<void>

  • Called to update features. Subclasses must override this if they support updating features.

    Parameters

    • features: Iterable<Feature, any, any>

      The feature to update.

    • Optionaloptions: FeatureWriteOptions

      Additional options that control how the feature is saved.

    Returns Promise<void>

Protected_watchSublayerProperties

addAttachment

addFeature

addFeatures

assignProperties

assignPropertiesAsync

deleteAttachments

  • deleteAttachments(feature, attachments): Promise<void>

  • Deletes attachments from a feature.

    Parameters

    • feature: Feature

      The feature to delete attachments from.

    • attachments: (string | Attachment)[]

      The attachments or the IDs of the attachments to delete from the feature.

    Returns Promise<void>

deleteFeature

deleteFeatures

  • deleteFeatures(ids, options?): Promise<void>

  • Deletes features from their source. If the source does not support deleting features, then an InvalidOperationError will be thrown (see capabilities).

    Parameters

    • ids: Iterable<string, any, any>

      The IDs of the features to delete.

    • Optionaloptions: FeatureWriteOptions

      Additional options that control how the features are deleted.

    Returns Promise<void>

  • deleteFeatures(features, options?): Promise<void>

  • Deletes features from their source. If the source does not support deleting features, then an InvalidOperationError will be thrown (see capabilities).

    Parameters

    • features: Iterable<Feature, any, any>

      The features to delete.

    • Optionaloptions: FeatureWriteOptions

      Additional options that control how the features are deleted.

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

  • A clean-up function that should get called whenever the item is disposed of.

    Returns Promise<void>

finishAssignProperties

getAttachments

getDefault

getDefaults

getFeature

  • getFeature(id, options?): Promise<Feature>

  • Gets a feature by ID. If no such feature exists, the promise is rejected with an instance of NotFoundError.

    Parameters

    • id: string

      The ID of the feature to retrieve.

    • Optionaloptions: FeatureReadOptions

      Additional options that control how the feature is retrieved.

    Returns Promise<Feature>

getFeatures

  • getFeatures(ids, options?): AsyncIterable<Feature, any, any>

  • Gets a set of features by their IDs.

    Parameters

    • ids: string[]

      The IDs of the features to retrieve.

    • Optionaloptions: FeatureReadOptions

      Additional Options that control how the features are retrieved.

    Returns AsyncIterable<Feature, any, any>

getFullExtent

  • getFullExtent(): Extent

  • Returns the full extent of the source that contains all included features.

    Returns Extent

getSerializableProperties

initialize

initializeWfs

  • initializeWfs(): Promise<void>

  • Initializes the WFS info associated with this sublayer if the parent layer extension has an associated WFS URL.

    Returns Promise<void>

toItemUri

toJSON

updateFeature

updateFeatures

Staticcreate

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
_addAttachment_addFeatures_applySublayerProperties_capabilities_createFeatureSettings_createHyperlinks_createLayerListSettings_createRelationships_createSchema_createSublayer_createSublayerExtension_createSublayerExtensionCollection_createSublayerRef_createTaskSettings_deleteAttachments_deleteFeatures_getAttachments_getFeatures_getSerializableProperties_initializableChildCollections_initializeChildren_isRelationship_isSupportedSublayer_onDestroy_onInitialize_onSublayerAddedPostInitialize_postInitialize_serializeSublayer_toPropertyDef_updateFeatures_watchSublayerPropertiesaddAttachmentaddFeatureaddFeaturesassignPropertiesassignPropertiesAsyncdeleteAttachmentsdeleteFeaturedeleteFeaturesdestroyfinishAssignPropertiesgetAttachmentsgetDefaultgetDefaultsgetFeaturegetFeaturesgetFullExtentgetSerializablePropertiesinitializeinitializeWfstoItemUritoJSONupdateFeatureupdateFeaturescreate