Class SceneLayerExtension

Extends the capabilities of an Esri SceneLayer object.

Hierarchy (view full)

Constructors

constructor

Properties

_handles _id _itemType @eventTypes allSublayerExtensions iconUrl? layerListSettings onAddFeature? onEditFeature? queryService? tpkSource factory

Accessors

basemapExtension canChangeDefinitionExpression canChangeLabels canChangeOpacity canChangeRenderer canChangeScale capabilities dynamicallyAddedLayer effectiveFullExtent effectiveMaxScale effectiveMinScale enableClientSideData failureMode featureActions featureSettings featureSourceActions groundExtension hasFeatures hyperlinks id initialDefinitionExpression initialRenderer initialVisibility isDestroyed isEffectivelyVisible isInitialized itemType layer mapExtension parentLayerExtension relationships renderer requestHelper schema sublayerExtensions sublayersAreReadOnly supportsSublayers taskSettings title visibilityMode

Methods

_addAttachment _addFeatures _applyLayerProperties _applyPortalItemProperties _capabilities _createFeatureSettings _createHyperlinks _createLayer _createLayerListSettings _createRelationships _createSchema _createSublayerExtension _createSublayerExtensionCollection _createTaskSettings _deleteAttachments _deleteFeatures _getAttachments _getFeatures _getSerializableLayerType _getSerializableProperties _getSerializableRefLayerProperties _initializableChildCollections _initializeChildren _initializeLayer _isRelationship _isSupportedLayer _onDestroy _onInitialize _onSublayerAddedPostInitialize _postInitialize _toPropertyDef _updateFeatures addAttachment addFeature addFeatures assignProperties assignPropertiesAsync deleteAttachments deleteFeature deleteFeatures destroy finishAssignProperties getAttachments getDefault getDefaults getFeature getFeatures getFullExtent getSerializableProperties initialize toItemUri toJSON updateFeature updateFeatures create fromPortalItem

Constructors

constructor

Properties

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

ReadonlyallSublayerExtensions

allSublayerExtensions: SublayerExtensionCollection

All descendant sublayer extensions associated with this layer.

OptionaliconUrl

iconUrl?: string

URL to an icon that represents this feature source.

ReadonlylayerListSettings

layerListSettings: LayerListSettings

Settings that affect the behavior and presentation of the layer 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.

tpkSource

tpkSource: string

An optional remote source for a .tpk, .tpkx or .vtpk file. May be a portal item URL or a portal item ID. Mobile Only.

Staticfactory

factory: LayerExtensionFactory

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

Accessors

basemapExtension

canChangeDefinitionExpression

  • get canChangeDefinitionExpression(): boolean

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

    Returns boolean

canChangeLabels

  • get canChangeLabels(): boolean

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

    Returns boolean

canChangeOpacity

  • get canChangeOpacity(): boolean

  • Determines whether the type of layer being extended supports changing opacity.

    Returns boolean

canChangeRenderer

  • get canChangeRenderer(): boolean

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

    Returns boolean

canChangeScale

  • get canChangeScale(): boolean

  • Determines whether the type of layer being extended supports changing Scale.

    Returns boolean

capabilities

dynamicallyAddedLayer

  • get dynamicallyAddedLayer(): boolean

  • Indicates that the layer was added dynamically.

    Returns boolean

  • set dynamicallyAddedLayer(value): void

  • Parameters

    • value: boolean

    Returns void

effectiveFullExtent

  • get effectiveFullExtent(): Extent

  • The effective full extent of this layer extension.

    Returns Extent

effectiveMaxScale

  • get effectiveMaxScale(): number

  • The effective max scale for this layer extension.

    Returns number

effectiveMinScale

  • get effectiveMinScale(): number

  • The effective min scale for this layer extension.

    Returns number

enableClientSideData

  • get enableClientSideData(): boolean

  • Indicates that the layer's data should be available client-side, within the graphics that render on the map. Client-side data allows for fast identify operations to be performed, as no external queries are necessary; however, this can cause the map's load time to increase. When enabled, all fields that are configured in the layer's PopupTemplate will load client-side. The default is false.

    Returns boolean

  • set enableClientSideData(isEnabled): void

  • Parameters

    • isEnabled: boolean

    Returns void

failureMode

featureActions

featureSettings

  • get featureSettings(): FeatureSettings

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

    Returns FeatureSettings

featureSourceActions

groundExtension

  • get groundExtension(): GroundExtension

  • The parent ground extension if the extended layer is an elevation layer in a ground object.

    Returns GroundExtension

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(): RendererUnion

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

    Returns RendererUnion

initialVisibility

  • get initialVisibility(): boolean

  • Indicates the initial layer visibility.

    Returns boolean

isDestroyed

isEffectivelyVisible

  • get isEffectivelyVisible(): boolean

  • The effective visibility for this layer extension.

    Returns boolean

isInitialized

itemType

  • get itemType(): string

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

    Returns string

layer

  • get layer(): SceneLayer

  • The Esri Layer object being extended.

    Returns SceneLayer

mapExtension

  • get mapExtension(): MapExtension

  • The parent map extension.

    Returns MapExtension

parentLayerExtension

relationships

  • get relationships(): Collection<Relationship>

  • Relationships to other feature sources.

    Returns Collection<Relationship>

renderer

  • get renderer(): RendererUnion

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

    Returns RendererUnion

requestHelper

schema

  • get schema(): Schema

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

    Returns Schema

sublayerExtensions

sublayersAreReadOnly

  • get sublayersAreReadOnly(): boolean

  • Determines whether the type of layer being extended has a readonly sublayer collection.

    Returns boolean

supportsSublayers

  • get supportsSublayers(): boolean

  • Determines whether this type of layer 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 or sublayers.

    Returns GroupLayerVisibilityMode

  • set visibilityMode(value): void

  • Parameters

    • value: GroupLayerVisibilityMode

    Returns void

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_applyLayerProperties

  • _applyLayerProperties(properties, layer): Promise<void>

  • Called to apply layer properties to a layer.

    Parameters

    • properties: LayerProperties

      The layer properties to apply.

    • layer: Layer

      The layer to apply properties to.

    Returns Promise<void>

Protected_applyPortalItemProperties

  • _applyPortalItemProperties(portalItem): Promise<void>

  • Apply properties from a portal item to an ESRI API Layer object.

    Parameters

    • portalItem: PortalItem

      The portal item to apply.

    Returns Promise<void>

Protected_capabilities

Protected_createFeatureSettings

Protected_createHyperlinks

Protected_createLayer

  • _createLayer(properties): Promise<Layer>

  • Called to create an Esri layer from layer properties.

    Parameters

    Returns Promise<Layer>

Protected_createLayerListSettings

Protected_createRelationships

Protected_createSchema

Protected_createSublayerExtension

Protected_createSublayerExtensionCollection

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_getSerializableLayerType

Protected_getSerializableProperties

Protected_getSerializableRefLayerProperties

  • _getSerializableRefLayerProperties(): Record<string, unknown>

  • Overridden in child sublayer extensions that need to add additional properties when serializing layer references.

    Returns Record<string, unknown>

Protected_initializableChildCollections

Protected_initializeChildren

Protected_initializeLayer

  • _initializeLayer(): Promise<void>

  • Called prior to loading the layer in order to perform any extra initialization.

    Returns Promise<void>

Protected_isRelationship

Protected_isSupportedLayer

  • _isSupportedLayer(layer): boolean

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

    Parameters

    • layer: Layer

      The layer to validate.

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

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: string[]

      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

toItemUri

  • toItemUri(): string

  • Creates an item:// URI reference to this entity.

    Returns string

toJSON

updateFeature

updateFeatures

Staticcreate

StaticfromPortalItem

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
_addAttachment_addFeatures_applyLayerProperties_applyPortalItemProperties_capabilities_createFeatureSettings_createHyperlinks_createLayer_createLayerListSettings_createRelationships_createSchema_createSublayerExtension_createSublayerExtensionCollection_createTaskSettings_deleteAttachments_deleteFeatures_getAttachments_getFeatures_getSerializableLayerType_getSerializableProperties_getSerializableRefLayerProperties_initializableChildCollections_initializeChildren_initializeLayer_isRelationship_isSupportedLayer_onDestroy_onInitialize_onSublayerAddedPostInitialize_postInitialize_toPropertyDef_updateFeaturesaddAttachmentaddFeatureaddFeaturesassignPropertiesassignPropertiesAsyncdeleteAttachmentsdeleteFeaturedeleteFeaturesdestroyfinishAssignPropertiesgetAttachmentsgetDefaultgetDefaultsgetFeaturegetFeaturesgetFullExtentgetSerializablePropertiesinitializetoItemUritoJSONupdateFeatureupdateFeaturescreatefromPortalItem