Class BuildingSublayerFeatureSettings

An implementation of FeatureSettings that mirrors the equivalent properties on an Esri BuildingSublayer object.

Hierarchy

  • PopupTemplateFeatureSettings
    • BuildingSublayerFeatureSettings

Constructors

constructor

Properties

_handles _layerExtension @eventTypes popupContentExtensions

Accessors

_bindings _defaultOutFields feature featureSource formatSettings hyperlinkTemplates maxAllowableOffset outFields outSpatialReference parent popupTemplate returnGeometry showRelatedRecordsWhenUnconfigured zoomFactor zoomScale

Methods

_bindSettingToLayerProperty _createPopupContentCollection _getCollectionSetting _getNestedSettings _getSerializableProperties _getSetting _hasSettingIncludingAncestor _onLayerResolved _setParent _setSetting _toPropertyDef assignProperties assignPropertiesAsync destroy finishAssignProperties getDefault getDefaults getSerializableProperties isModified reset toJSON

Constructors

constructor

Properties

Protected Readonly_handles

_handles: Handles<unknown, ResourceHandle>

Protected Readonly_layerExtension

_layerExtension: BuildingSublayerExtension<BuildingSublayerExtensionProperties>

The parent sublayer extension.

@eventTypes

@eventTypes: SettingsEvents<FeatureSettings>

Deprecated

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

ReadonlypopupContentExtensions

popupContentExtensions: PopupContentExtensionCollection

The PopupContentExtensions associated with each popupContent of the schema.

Accessors

Protected_bindings

  • get _bindings(): Map<keyof this, string>

  • Returns Map<keyof this, string>

Protected_defaultOutFields

  • get _defaultOutFields(): string[]

  • Returns the default outFields for the corresponding FeatureSource.

    Returns string[]

feature

featureSource

formatSettings

  • get formatSettings(): FormatSettings

  • Settings affecting how feature attributes are formatted.

    Returns FormatSettings

hyperlinkTemplates

  • get hyperlinkTemplates(): Collection<Hyperlink>

  • Templates that define hyperlinks associated with the feature. Each template's properties can contain field tokens enclosed in {}, which will be replaced by actual field values.

    Returns Collection<Hyperlink>

maxAllowableOffset

  • get maxAllowableOffset(): number

  • The default maximum allowable offset used for generalizing geometries returned by the query operation.

    Returns number

  • set maxAllowableOffset(value): void

  • Parameters

    • value: number

    Returns void

outFields

  • get outFields(): string[]

  • Fields that should be returned for each feature by default.

    Returns string[]

  • set outFields(value): void

  • Parameters

    • value: string[]

    Returns void

outSpatialReference

  • get outSpatialReference(): SpatialReference

  • The default spatial reference for the returned geometry.

    Returns SpatialReference

  • set outSpatialReference(value): void

  • Parameters

    • value: SpatialReference

    Returns void

parent

  • get parent(): this

  • The parent settings that these settings will inherit from.

    Returns this

  • set parent(value): void

  • Parameters

    • value: this

    Returns void

popupTemplate

  • get popupTemplate(): PopupTemplate

  • The template for displaying content in a pop-up when the feature is selected.

    Returns PopupTemplate

  • set popupTemplate(value): void

  • Parameters

    • value: PopupTemplate

    Returns void

returnGeometry

  • get returnGeometry(): boolean

  • Whether geometry for features should be returned by default.

    Returns boolean

  • set returnGeometry(value): void

  • Parameters

    • value: boolean

    Returns void

showRelatedRecordsWhenUnconfigured

  • get showRelatedRecordsWhenUnconfigured(): boolean

  • Whether all related records should be shown, even if not found configured in the web map popup.

    Returns boolean

  • set showRelatedRecordsWhenUnconfigured(value): void

  • Parameters

    • value: boolean

    Returns void

zoomFactor

  • get zoomFactor(): number

  • Specifies the desired extent to zoom to when zooming to a feature as a multiple of the feature's extent. The default is 1.5. Not applicable for features whose geometry is a point.

    Returns number

  • set zoomFactor(value): void

  • Parameters

    • value: number

    Returns void

zoomScale

  • get zoomScale(): number

  • The scale to zoom the map to when zooming to a feature. This will override zoomFactor if also set.

    Returns number

  • set zoomScale(value): void

  • Parameters

    • value: number

    Returns void

Methods

Protected_bindSettingToLayerProperty

  • _bindSettingToLayerProperty<K>(setting, layerProperty?): void

  • Binds a setting to an equivalent property on the layer.

    Type Parameters

    Parameters

    • setting: K

      The name of the setting to bind.

    • OptionallayerProperty: string

      The name of the property to bind to, if it differs from the setting.

    Returns void

Protected_createPopupContentCollection

  • _createPopupContentCollection(): Collection<Content>

  • Creates the backing collection for popup content.

    Returns Collection<Content>

Protected_getCollectionSetting

  • _getCollectionSetting<T>(setting): Collection<T>

  • Gets the value for a setting that represents a collection.

    Type Parameters

    • T

    Parameters

    Returns Collection<T>

Protected_getNestedSettings

  • _getNestedSettings<T>(setting, factory): T

  • Gets a property which is itself an instance of Settings.

    Type Parameters

    Parameters

    Returns T

Protected_getSerializableProperties

Protected_getSetting

Protected_hasSettingIncludingAncestor

  • _hasSettingIncludingAncestor<K>(setting): boolean

  • Type Parameters

    Parameters

    • setting: K

    Returns boolean

Protected_onLayerResolved

  • _onLayerResolved(layer): void

  • Invoked when the layer is available.

    Parameters

    Returns void

Protected_setParent

  • _setParent(parent): void

  • Sets the parent settings that these settings will inherit from.

    Parameters

    Returns void

Protected_setSetting

  • _setSetting<K>(setting, value): void

  • Sets the value for a setting. This will override any inherited value for the setting.

    Type Parameters

    Parameters

    Returns void

Protected_toPropertyDef

assignProperties

  • assignProperties(properties): void

  • Parameters

    • properties: Partial<unknown>

    Returns void

    Inherit Doc

assignPropertiesAsync

  • assignPropertiesAsync(properties): Promise<void>

  • Parameters

    • properties: Partial<unknown>

    Returns Promise<void>

    Inherit Doc

destroy

  • destroy(): void

  • Returns void

finishAssignProperties

  • finishAssignProperties(): Promise<void>

  • Returns Promise<void>

    Inherit Doc

getDefault

  • getDefault<K>(key): unknown

  • Type Parameters

    • K extends never

    Parameters

    • key: K

    Returns unknown

    Inherit Doc

getDefaults

getSerializableProperties

  • getSerializableProperties(serializeMode?): PropertyDefs<unknown>

  • Returns the serializable properties.

    Parameters

    • serializeMode: SerializeMode = "all"

      Optional. If specified, only properties that support the given serialization mode will be returned.

    Returns PropertyDefs<unknown>

isModified

  • isModified(): boolean

  • Determines whether the settings have been locally modified in any way.

    Returns boolean

  • isModified(setting): boolean

  • Determines whether the specified setting has been locally modified, and is thus overriding any inherited value.

    Parameters

    Returns boolean

reset

  • reset(): void

  • Removes all local overrides, resetting all settings to their inherited values, if any.

    Returns void

  • reset(setting): void

  • Removes a local override for a setting and resets it to its inherited value, if any.

    Parameters

    Returns void

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods