Implementation of feature settings that is read-only for geometry related settings.

Hierarchy (view full)

Constructors

Properties

_handles: Handles<unknown, ResourceHandle>

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

popupContentExtensions: PopupContentExtensionCollection

The PopupContentExtensions associated with each popupContent of the schema.

Accessors

  • get _defaultOutFields(): string[]
  • Returns the default outFields for the corresponding FeatureSource.

    Returns string[]

  • get formatSettings(): FormatSettings
  • Settings affecting how feature attributes are formatted.

    Returns FormatSettings

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

  • get maxAllowableOffset(): number
  • The default maximum allowable offset used for generalizing geometries returned by the query operation.

    Returns number

  • set maxAllowableOffset(value): void
  • The default maximum allowable offset used for generalizing geometries returned by the query operation.

    Parameters

    • value: number

    Returns void

  • get outFields(): string[]
  • Fields that should be returned for each feature by default.

    Returns string[]

  • set outFields(value): void
  • Parameters

    • value: string[]

    Returns void

  • get outSpatialReference(): SpatialReference
  • The default spatial reference for the returned geometry.

    Returns SpatialReference

  • set outSpatialReference(value): void
  • The default spatial reference for the returned geometry.

    Parameters

    • value: SpatialReference

    Returns void

  • get parent(): this
  • The parent settings that these settings will inherit from.

    Returns this

  • set parent(value): void
  • Parameters

    • value: this

    Returns void

  • 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

  • get returnGeometry(): boolean
  • Whether geometry for features should be returned by default.

    Returns boolean

  • set returnGeometry(value): void
  • Whether geometry for features should be returned by default.

    Parameters

    • value: boolean

    Returns void

  • 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

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

    Parameters

    • value: number

    Returns void

  • 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
  • The scale to zoom the map to when zooming to a feature. This will override zoomFactor if also set.

    Parameters

    • value: number

    Returns void

Methods

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

    Type Parameters

    Parameters

    • setting: keyof TableFeatureSettings

      The setting name.

    • factory: (() => T)

      A factory for creating the nested settings.

        • (): T
        • Returns T

    Returns T

  • Determines whether the specified setting has been modified locally or by any parent of the current settings instance.

    Type Parameters

    Parameters

    • setting: K

      The setting to check.

    Returns boolean

  • Type Parameters

    • K extends never

    Parameters

    • key: K

    Returns unknown

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

    Returns boolean

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

    Parameters

    Returns boolean

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

    Returns void

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

    Parameters

    Returns void