geoview-core - v2.3.0
    Preparing search index...

    Class GVWFS

    Manages a WFS layer.

    Hierarchy (View Summary)

    Index
    constructor
    loadedOnce styleApplied DEFAULT_HIT_TOLERANCE DEFAULT_LOADING_PERIOD NAME_FIELD_KEYWORDS STYLE_CACHE_SIZE_LIMIT TILE_LOADING_QUIESCENCE_PERIOD
    emitMessage formatFeatureInfoResult getAllFeatureInfo getAttributions getBounds getBoundsLonLat getBoundsProjection getClassName getExtent getExtentFromFeatures getFeatureInfo getFeatureInfoAtCoordinate getFeatureInfoAtLonLat getFeatureInfoAtPixel getFeatureInfoUsingBBox getFeatureInfoUsingPolygon getFilterFromStyle getGeoviewLayerId getGeoviewLayerName getHitTolerance getHoverable getIsTimeAware getLayerConfig getLayerFilters getLayerName getLayerPath getLayerStatus getLegend getMaxZoom getMinZoom getOLLayer getOLSource getOpacity getParent getParentRoot getParents getQueryable getStyle getStyleItemVisibility getTextLayerVisible getTextOLLayer getTextVisible getTimeDimension getVisible getVisibleIncludingParents init initBounds isInVisibleRange offBoundsInitialized offLayerError offLayerFilterApplied offLayerFirstLoaded offLayerHoverableChanged offLayerItemVisibilityChanged offLayerLoaded offLayerLoading offLayerMessage offLayerNameChanged offLayerOpacityChanged offLayerQueryableChanged offLayerStyleChanged offLayerVisibleChanged offLayerZIndexChanged offLegendQueried offLegendQuerying offStyleApplied offTextVisibleChanged onBoundsInitialized onceBoundsInitialized onceLayerError onceLayerFirstLoaded onceLayerStyleChanged onErrorDecipherError onFeaturesLoadError onFetchLegend onGetAttributions onGetExtentFromFeatures onImageLoadError onImageLoadErrorDecipherError onImageTileLoadError onInitBounds onIsInVisibleRange onLayerError onLayerFilterApplied onLayerFirstLoaded onLayerHoverableChanged onLayerItemVisibilityChanged onLayerLoaded onLayerLoading onLayerMessage onLayerNameChanged onLayerOpacityChanged onLayerQueryableChanged onLayerStyleChanged onLayerVisibleChanged onLayerZIndexChanged onLegendQueried onLegendQuerying onLoaded onLoading onRefresh onSetLayerFilters onSetOpacity onSetStyleAccordingToLegend onSetVisible onSetZIndex onSourceError onStyleApplied onTextVisibleChanged queryLegend refresh setExtent setHoverable setLayerFiltersData setLayerFiltersDate setLayerFiltersTime setLayerName setLegend setMaxResolution setMaxZoom setMinResolution setMinZoom setOLLayer setOpacity setParent setQueryable setStyle setStyleApplied setStyleItemVisibility setTextVisible setVisible setZIndex waitForBounds waitForLegendQueried waitForLoadedOnce waitForLoadedStatus waitForRender waitForSourceReady waitForStyleAppliedVector calculateStyleForFeature calculateTextStyleForFeature createLegendFromStyle findBestNameField getFeatureIconSource getFieldType getParent helperFormatFeatureInfoResult helperGetFieldValue initOptionsWithInitialSettings
    loadedOnce: boolean = false

    Indicates if the layer has become in loaded status at least once already

    styleApplied: boolean = false

    Indicates if the style has been applied on the layer yet

    DEFAULT_HIT_TOLERANCE: number = 4

    The default hit tolerance the query should be using.

    DEFAULT_LOADING_PERIOD: number = ...

    The default loading period before we show a message to the user about a layer taking a long time to render on map.

    NAME_FIELD_KEYWORDS: string[] = ...

    Keywords used to identify name fields in the layer's outfields when none specified.

    STYLE_CACHE_SIZE_LIMIT: 1000

    Maximum number of styles to cache

    TILE_LOADING_QUIESCENCE_PERIOD: number = ...

    Quiescence period after a tile source change with no tile-load activity before remaining in-flight tiles are treated as orphans and force-closed.

    • Emits a layer-specific message event with localization support.

      Parameters

      • messageKey: string

        The key used to lookup the localized message OR message

      • messageParams: Record<string, unknown> | undefined

        Array of parameters to be interpolated into the localized message

      • messageType: SnackbarType = 'info'

        The message type

      Returns void

      this.emitMessage(
        'layers.fetchProgress',
        ['50', '100'],
        'error',
      );

    • Formats a list of features into an array of TypeFeatureInfoEntry, including icons, field values, domains, and metadata.

      Parameters

      • features: Feature<Geometry, { [x: string]: any }>[]

        Array of features to format

      • layerConfig:
            | VectorLayerEntryConfig
            | OgcWmsLayerEntryConfig
            | EsriDynamicLayerEntryConfig
            | EsriImageLayerEntryConfig

        Configuration of the associated layer

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field if nameField is not provided

      • serviceDateFormat: string | undefined

        Optional date format used by the service

      • serviceDateIANA: string | undefined

        Optional IANA time zone identifier used by the service

      • serviceDateTemporalMode: TemporalMode | undefined

        Optional temporal mode for date handling

      Returns TypeFeatureInfoEntry[]

      An array of TypeFeatureInfoEntry objects

    • Overrides the get all feature information for all the features stored in the layer.

      Parameters

      • map: Map

        The Map so that we can grab the resolution/projection we want to get features on.

      • layerFilters: LayerFilters

        The layer filters to apply when querying the features.

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field if nameField is not provided

      • OptionalabortController: AbortController

        Optional AbortController to cancel the request.

      Returns Promise<TypeFeatureInfoResult>

      A promise that resolves with the feature info result.

    • Gets the extent of an array of features.

      Parameters

      • objectIds: string[] | number[]

        The IDs of the features to calculate the extent from

      • outProjection: Projection

        The output projection for the extent

      • Optionaloutfield: string

        Optional ID field to return for services that require a value in outfields

      Returns Promise<Extent>

      A promise that resolves to the extent of the features, if available

      When the subclass does not override onGetExtentFromFeatures (propagated from onGetExtentFromFeatures())

    • Returns feature information for the layer specified.

      Parameters

      • map: Map

        The Map to get feature info from

      • queryType: QueryType

        The type of query to perform

      • location: TypeLocation

        A pixel, coordinate or polygon that will be used by the query

      • queryGeometry: boolean = true

        Whether to include geometry in the query, default is true

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field if nameField is not provided

      • abortController: AbortController | undefined = undefined

        Optional AbortController to cancel the operation

      Returns Promise<TypeFeatureInfoResult>

      A promise that resolves with the feature info result

      When queryType is not one of the supported query types

      When the subclass does not override the underlying get*FeatureInfo* method for the requested queryType (propagated from the dispatched method)

    • Overrides the return of feature information at a given coordinate.

      Parameters

      • map: Map

        The Map where to get Feature Info At Coordinate from

      • location: Coordinate

        The coordinate that will be used by the query

      • queryGeometry: boolean = true

        Whether to include geometry in the query, default is true

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field for the 'nameField'

      • abortController: AbortController | undefined = undefined

        Optional AbortController to cancel the request

      Returns Promise<TypeFeatureInfoResult>

      A promise that resolves with the feature info result

    • Overrides the return of feature information at the provided long lat coordinate.

      Parameters

      • map: Map

        The Map where to get Feature Info At LonLat from

      • lonlat: Coordinate

        The coordinate that will be used by the query

      • queryGeometry: boolean = true

        Whether to include geometry in the query, default is true

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field if nameField is not provided

      • abortController: AbortController | undefined = undefined

        Optional AbortController to cancel the operation

      Returns Promise<TypeFeatureInfoResult>

      A promise that resolves with the feature info result

    • Overrides the return of feature information at a given pixel location.

      Parameters

      • map: Map

        The Map where to get Feature Info At Pixel from

      • location: Pixel

        The pixel coordinate that will be used by the query

      • queryGeometry: boolean = true

        Whether to include geometry in the query, default is true

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field if nameField is not provided

      • abortController: AbortController | undefined = undefined

        Optional AbortController to cancel the operation

      Returns Promise<TypeFeatureInfoResult>

      A promise that resolves with the feature info result

    • Overridable function to return of feature information at the provided bounding box.

      Parameters

      • map: Map

        The Map where to get Feature using BBox from

      • location: Coordinate[]

        The bounding box that will be used by the query

      • queryGeometry: boolean = true

        Whether to include geometry in the query, default is true

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field if nameField is not provided

      • abortController: AbortController | undefined = undefined

        Optional AbortController to cancel the operation

      Returns Promise<TypeFeatureInfoResult>

      A promise that resolves with the feature info result

      When the function isn't overridden by the children class

    • Overridable function to return of feature information at the provided polygon.

      Parameters

      • map: Map

        The Map where to get Feature Info using Polygon from

      • location: Coordinate[]

        The polygon that will be used by the query

      • queryGeometry: boolean = true

        Whether to include geometry in the query, default is true

      • language: TypeDisplayLanguage

        The display language, used to guess the best name field if nameField is not provided

      • abortController: AbortController | undefined = undefined

        Optional AbortController to cancel the operation

      Returns Promise<TypeFeatureInfoResult>

      A promise that resolves with the feature info result

      When the function isn't overridden by the children class

    • Retrieves all parent group layers of this layer in hierarchical order.

      The returned array starts with the immediate parent and continues up the hierarchy until the root group layer is reached or a group has already been visited (not supposed to happen).

      This method traverses upward through the parent chain starting from the immediate parent of this layer. A protection mechanism prevents infinite loops in case of circular parent references.

      Returns GVGroupLayer[]

      An array of parent GVGroupLayer instances, ordered from the immediate parent to the top-most ancestor. Returns an empty array if the layer has no parent.

    • Gets the layer style.

      Returns
          | Partial<
              Record<
                  | "Point"
                  | "MultiPoint"
                  | "LineString"
                  | "MultiLineString"
                  | "Polygon"
                  | "MultiPolygon"
                  | "GeometryCollection",
                  TypeLayerStyleSettings,
              >,
          >
          | undefined

      The layer style

    • Gets the OpenLayers text layer if one exists.

      Returns
          | VectorLayer<
              VectorSource<Feature<Geometry, { [x: string]: any }>>,
              Feature<Geometry, { [x: string]: any }>,
          >
          | undefined

      The text layer or undefined if no text layer exists.

    • Determines whether this layer is visible, taking into account the visibility of all its parent groups. A layer is considered visible only if:

      • the layer itself is visible, and
      • every parent GVGroupLayer up the hierarchy is also visible. This function walks upward through the group layer tree until it reaches the root, returning false immediately if any parent is not visible.

      Returns boolean

      true if this layer and all its parent groups are visible; otherwise false.

    • Initializes the GVLayer.

      Applies the initial layer filters, wires the OpenLayers source event listeners that drive the loading lifecycle (start/end shared across features/image/tile families plus one handler per error family), registers the source change listener to surface fatal source errors, and patches the renderer to guard against null-context errors.

      Returns void

    • Initializes the bounds for the layer in the given projection. When the layer is a GVLayer, its layer bounds are returned. When the layer is a GVGroup, an Extent union of all layers bounds in the group is returned.

      Parameters

      • projection: Projection

        The projection to initialize the bounds into

      • stops: number

        The number of stops to use to generate the extent

      Returns Promise<Extent | undefined>

      A promise that resolves with the layer bounding box or undefined when not found

    • Gets the in visible range value.

      Compares against the OL layer's minResolution/maxResolution thresholds. Uses inclusive boundaries on both ends (<=) to match ESRI/ArcGIS semantics where minScale and maxScale are both inclusive. This ensures a layer with maxScale=41999 is visible at exactly scale 41999.

      Parameters

      • currentResolution: number | undefined

        Optional. The current map resolution in map units per pixel

      • OptionalcurrentScale: number

        Optional. The current map scale denominator (1:X)

      • OptionaleffectiveScales: EffectiveLayerScales

        Optional. Effective layer scales with buffer thresholds

      Returns boolean

      True if the layer is in visible range

    • Returns a promise that resolves the next time the bounds initialized event fires.

      Parameters

      • Optionalfilter: (event: BoundsInitializedEvent) => boolean

        Optional filter predicate. When provided, only events passing the filter resolve the promise

      Returns Promise<BoundsInitializedEvent>

      A promise that resolves with the bounds initialized event payload

    • Returns a promise that resolves the next time the layer error event fires.

      Parameters

      • Optionalfilter: (event: LayerErrorEvent) => boolean

        Optional filter predicate. When provided, only events passing the filter resolve the promise

      Returns Promise<LayerErrorEvent>

      A promise that resolves with the layer error event payload

    • Returns a promise that resolves the next time the layer first loaded event fires.

      Parameters

      • Optionalfilter: (event: LayerBaseEvent) => boolean

        Optional filter predicate. When provided, only events passing the filter resolve the promise

      Returns Promise<LayerBaseEvent>

      A promise that resolves with the layer base event payload

    • Returns a promise that resolves the next time the layer style changed event fires.

      Parameters

      • Optionalfilter: (event: StyleChangedEvent) => boolean

        Optional filter predicate. When provided, only events passing the filter resolve the promise

      Returns Promise<StyleChangedEvent>

      A promise that resolves with the style changed event payload

    • Overridable method called when the layer is in error and couldn't be loaded correctly.

      Fired only on the wave-terminating featuresloaderror (i.e. when the in-flight counter transitions back to 0). Errors arriving while other loads are still in flight are absorbed by the counter and do not reach this method, which naturally suppresses superseded errors.

      Parameters

      • error: GeoViewError

        The error which is being raised

      Returns void

    • Overridable function returning the legend of the layer.

      Returns null when the layerPath specified is not found. If the style property of the layerConfig object is undefined, the legend property of the object returned will be null.

      Returns Promise<TypeLegend | null>

      A promise that resolves with the legend of the layer or null

    • Gets the extent of an array of features.

      Parameters

      • objectIds: string[] | number[]

        The uids of the features to calculate the extent from.

      • outProjection: Projection

        The output projection for the extent.

      • Optionaloutfield: string

        Optional ID field to return for services that require a value in outfields.

      Returns Promise<Extent>

      A promise that resolves with the extent of the features.

    • Overridable method called when the layer image is in error and couldn't be loaded correctly.

      Fired only on the wave-terminating imageloaderror (i.e. when the in-flight counter transitions back to 0). Errors arriving while other loads are still in flight are absorbed by the counter and do not reach this method, which naturally suppresses superseded errors.

      Parameters

      • error: GeoViewError

        The error which is being raised

      Returns void

    • Overridable method called when the layer tile image is in error and couldn't be loaded correctly.

      Fired only on the wave-terminating tileloaderror (i.e. when the in-flight counter transitions back to 0). Tile errors arriving mid-burst, while other tiles are still loading, are absorbed by the counter and do not reach this method - only the error that closes out the wave is reported.

      Parameters

      • error: GeoViewError

        The error which is being raised

      Returns void

    • Overrides the way to initialize the bounds for this layer type.

      Parameters

      • projection: Projection

        The projection to initialize the bounds into.

      • stops: number

        The number of stops to use to generate the extent.

      Returns Promise<Extent | undefined>

      A promise that resolves with the layer bounding box, or undefined if not available.

      When the layer enters the error state before reaching loaded (propagated from waitForLoadedStatus())

    • Overridable method to get if the layer is in visible range.

      Compares against the OL layer's minResolution/maxResolution threshold. Uses inclusive boundaries on both ends (<=) to match ESRI/ArcGIS semantics where minScale and maxScale are both inclusive. This ensures a layer with maxScale=41999 is visible at exactly scale 41999.

      Parameters

      • currentResolution: number | undefined

        Optional. The current map resolution in map units per pixel

      • OptionalcurrentScale: number

        Optional. The current map scale denominator (1:X)

      • OptionaleffectiveScales: EffectiveLayerScales

        Optional. Effective layer scales with buffer thresholds

      Returns boolean

      True if the layer is in visible range

    • Sets the data filter on the layer.

      This function only updates the data filter query string inside the layer filters object. The active filter applied on the layer will update accordingly, however, the UI component elements themselves won't update.

      Parameters

      • dataFilterQueryString: string | undefined

        Optional data filter expression to apply

      Returns void

    • Applies a time filter on a date range.

      This function only updates the time filter query string inside the layer filters object. The active filter applied on the layer will update accordingly, however, the UI component elements themselves won't update.

      Parameters

      • date1: string

        The start date

      • date2: string

        The end date

      Returns void

      This method should be removed in favor of setLayerFiltersTime so that future enhancements regarding time filtering and UI synchronization can be made.

    • Sets the time filter on the layer.

      This function only updates the time filter query string inside the layer filters object. The active filter applied on the layer will update accordingly, however, the UI component elements themselves won't update.

      Parameters

      • timeFilterQueryString: string | undefined

        Optional time filter expression to apply

      Returns void

    • Sets the opacity of the layer while ensuring it does not exceed the opacity of its parent layer.

      If the layer has a parent, the provided opacity is clamped so that it cannot be greater than the parent's opacity. The resulting opacity is applied to the underlying OpenLayers layer.

      If the layer is a GVGroupLayer, the computed opacity is recursively applied to all child layers to maintain consistency within the layer hierarchy.

      Optionally emits a layer opacity change event.

      Parameters

      • opacity: number

        The desired opacity for the layer, typically between 0 (fully transparent) and 1 (fully opaque).

      • emitOpacityChanged: boolean = true

        Optional, whether to emit a layer opacity change event after updating the opacity. Defaults to true.

      Returns void

    • Updates the visibility of a style item on the layer and triggers a re-render.

      This method mutates the layer's style configuration for the specified legend item, calls changed() on the underlying OpenLayers layer to schedule a new render, and optionally waits for the next render cycle to complete.

      Parameters

      • item: TypeLegendItem

        The legend/style item whose visibility will be updated

      • visible: boolean

        Whether the style item should be visible

      • waitForRender: boolean

        When true, waits for the next layer render to complete before resolving

      Returns Promise<void>

      A promise that resolves after the visibility has been updated and, if requested, the layer has finished rendering

      When the geometry type of the item doesn't match any geometry type in the layer style configuration

    • Utility function allowing to wait for the layer legend to be queried.

      Sync-checks first, then subscribes to the legend-changed and layer-error events. Resolves when the legend becomes available; rejects when the layer enters the error state first.

      Returns Promise<void>

      A promise that resolves once the layer legend has been queried

      When the layer enters the error state before the legend is queried

    • Utility function allowing to wait for the layer to be loaded at least once.

      Sync-checks first, then subscribes to the layer-first-loaded and layer-error events. Resolves when the layer reaches its first loaded state; rejects when the layer enters the error state before that.

      Returns Promise<void>

      A promise that resolves once the layer has been loaded at least once

      When the layer enters the error state before being loaded

    • Utility function allowing to wait for the layer status to become loaded.

      Sync-checks first, then subscribes to the layer-loaded and layer-error events. Resolves when the layer reaches the loaded state; rejects when the layer enters the error state first.

      Returns Promise<void>

      A promise that resolves once the layer status is loaded

      When the layer enters the error state before reaching loaded

    • Waits until the vector layer's style has been applied or the layer enters an error state.

      Resolves immediately if a style is already set, or rejects immediately if the layer is already in error state. Otherwise subscribes to the styleApplied and layerError events; the first event to fire settles the promise and both subscriptions are cleaned up.

      Returns Promise<void>

      A promise that resolves when the style has been applied

      When the layer is already in (or enters) the error state before the style is applied

    • Creates a legend object based on a given GeoView layer type and style configuration.

      This method builds a legend representation by combining the provided style settings with the computed legend symbols retrieved from the renderer. It is asynchronous because it waits for GeoviewRenderer.getLegendStyles to generate the legend items.

      Parameters

      • schemaTag: TypeGeoviewLayerType

        The GeoView layer type identifier (e.g., vector, raster, etc.)

      • style:
            | Partial<
                Record<
                    | "Point"
                    | "MultiPoint"
                    | "LineString"
                    | "MultiLineString"
                    | "Polygon"
                    | "MultiPolygon"
                    | "GeometryCollection",
                    TypeLayerStyleSettings,
                >,
            >
            | undefined

        Optional style configuration mapping geometry types to their style settings

      Returns Promise<TypeLegend>

      A promise that resolves with a legend object containing type, styleConfig, and legend entries

    • Finds the best field to use as a name field by searching for common name-like field patterns.

      Searches field names for predefined keywords (name, title, label) in priority order. Supports both outfields arrays and field info dictionaries keyed by field name. If no keyword match is found, returns the first available field name as a fallback.

      Parameters

      • nameField: string | undefined

        Optional provided name field to validate and use first

      • outfields: TypeOutfields[] | Partial<Record<string, TypeFieldEntry>> | undefined = []

        Outfields array or field info dictionary to search

      • lang: TypeDisplayLanguage = 'en'

        The display language used to resolve _lang placeholders in keyword patterns

      Returns string | undefined

      The name of the best matching field, or undefined if no fields available

    • Retrieves or generates an image source (data URI or path) representing the visual style of a feature.

      Caches results in the imageSourceDict to avoid redundant processing.

      Parameters

      • feature: Feature

        The feature whose visual representation is to be retrieved

      • layerStyle: TypeLayerStyleConfig

        Style configuration grouped by geometry type (e.g., Point, LineString, Polygon)

      • domainsLookup: TypeLayerMetadataFields[] | undefined

        Optional domain information for interpreting coded values

      • aliasLookup: Record<string, string>

        A mapping of original field names to their aliases

      • imageSourceDict: Record<string, string | undefined>

        A dictionary used to cache and reuse image sources by style key

      Returns string | undefined

      The image source string representing the feature's style, or undefined when generation fails

    • Returns field type of the given field name using the provided WFS metadata.

      Parameters

      • layerMetadata: TypeOutfields[] | undefined

        The WFS metadata.

      • fieldName: string

        The field name to get the field type information.

      Returns TypeOutfieldsType

      The field type information for the given field name.

    • Recursively searches the layer tree to find the parent GVGroupLayer of a given layer.

      The search begins from the provided list of layers, which should represent the root-level layer collection. This method walks top-down through all nested GVGroupLayers until it finds the group whose children contain the specified layer. It proceeds this way, because OpenLayers doesn't have a way to start from a leaf - have to start from the root.

      Parameters

      • layer: AbstractBaseGVLayer

        The layer for which the parent group is being searched.

      • groupLayers: AbstractBaseGVLayer[]

        The list of layers to search within. Typically this is the root layer group of the map.

      Returns GVGroupLayer | undefined

      The parent group layer if found, otherwise undefined if the layer has no parent.

    • Formats a set of OpenLayers features into a structured array of feature info entries.

      Each feature is enriched with geometry, extent, field information, and optional styling. Will not throw; errors are caught and logged. Returns an empty array if processing fails.

      Parameters

      • features: Feature<Geometry, { [x: string]: any }>[]

        Array of OpenLayers features to process

      • layerPath: string

        Path of the layer these features belong to

      • schemaTag: TypeGeoviewLayerType

        The Geoview layer type for the features

      • nameField: string | undefined

        Optional field name to use as the display name for features

      • outFields: TypeOutfields[] | undefined

        Optional array of output fields to include in the feature info

      • supportZoomTo: boolean

        Whether zoom-to functionality is supported for these features

      • domainsLookup: TypeLayerMetadataFields[] | undefined

        Optional array of field metadata for domain lookups

      • layerStyle:
            | Partial<
                Record<
                    | "Point"
                    | "MultiPoint"
                    | "LineString"
                    | "MultiLineString"
                    | "Polygon"
                    | "MultiPolygon"
                    | "GeometryCollection",
                    TypeLayerStyleSettings,
                >,
            >
            | undefined

        Optional mapping of geometry type to style settings for icons

      • inputFormat: string | string[] | undefined

        Optional format(s) to prioritize for string inputs

      • inputTimezone: string | undefined

        Optional IANA timezone the dates are in

      • inputTemporalMode: TemporalMode | undefined

        Optional temporal mode for date handling

      • callbackGetFieldValue: GetFieldValueDelegate

        Callback that returns the value of a field for a feature, in the correct type

      Returns TypeFeatureInfoEntry[]

      Array of feature info entries representing each feature with enriched metadata

    • Retrieves and formats the value of a field from an OpenLayers feature.

      • For date fields, the raw value (epoch ms or date string) is normalized via the date management utilities.
      • For fields with a codedValue domain, the raw code is resolved to its human-readable name. If no matching code is found, the raw value is returned.
      • For all other fields, the raw value is returned as-is.

      Parameters

      • feature: Feature

        The OpenLayers feature containing the field values.

      • fieldName: string

        The name of the field to retrieve.

      • fieldType: TypeOutfieldsType

        The data type of the field (e.g. 'string', 'number', 'date', 'oid').

      • fieldDomain: codedValueType | rangeDomainType | undefined

        Optional domain metadata. When present and of type codedValue, the raw field value is mapped to the corresponding coded-value name.

      • inputFormat: string | string[] | undefined

        Optional format(s) to prioritize when parsing date string inputs.

      • inputTimezone: string | undefined

        Optional IANA timezone to assume when interpreting date values.

      • inputTemporalMode: TemporalMode | undefined

        Optional temporal mode. 'calendar' treats dates as timezone-agnostic calendar dates; 'instant' treats them as timezone-aware moments.

      Returns unknown

      The processed field value: a formatted date for date fields, the decoded name for coded-value domains, or the raw value otherwise.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods
    emitMessageformatFeatureInfoResultgetAllFeatureInfogetAttributionsgetBoundsgetBoundsLonLatgetBoundsProjectiongetClassNamegetExtentgetExtentFromFeaturesgetFeatureInfogetFeatureInfoAtCoordinategetFeatureInfoAtLonLatgetFeatureInfoAtPixelgetFeatureInfoUsingBBoxgetFeatureInfoUsingPolygongetFilterFromStylegetGeoviewLayerIdgetGeoviewLayerNamegetHitTolerancegetHoverablegetIsTimeAwaregetLayerConfiggetLayerFiltersgetLayerNamegetLayerPathgetLayerStatusgetLegendgetMaxZoomgetMinZoomgetOLLayergetOLSourcegetOpacitygetParentgetParentRootgetParentsgetQueryablegetStylegetStyleItemVisibilitygetTextLayerVisiblegetTextOLLayergetTextVisiblegetTimeDimensiongetVisiblegetVisibleIncludingParentsinitinitBoundsisInVisibleRangeoffBoundsInitializedoffLayerErroroffLayerFilterAppliedoffLayerFirstLoadedoffLayerHoverableChangedoffLayerItemVisibilityChangedoffLayerLoadedoffLayerLoadingoffLayerMessageoffLayerNameChangedoffLayerOpacityChangedoffLayerQueryableChangedoffLayerStyleChangedoffLayerVisibleChangedoffLayerZIndexChangedoffLegendQueriedoffLegendQueryingoffStyleAppliedoffTextVisibleChangedonBoundsInitializedonceBoundsInitializedonceLayerErroronceLayerFirstLoadedonceLayerStyleChangedonErrorDecipherErroronFeaturesLoadErroronFetchLegendonGetAttributionsonGetExtentFromFeaturesonImageLoadErroronImageLoadErrorDecipherErroronImageTileLoadErroronInitBoundsonIsInVisibleRangeonLayerErroronLayerFilterAppliedonLayerFirstLoadedonLayerHoverableChangedonLayerItemVisibilityChangedonLayerLoadedonLayerLoadingonLayerMessageonLayerNameChangedonLayerOpacityChangedonLayerQueryableChangedonLayerStyleChangedonLayerVisibleChangedonLayerZIndexChangedonLegendQueriedonLegendQueryingonLoadedonLoadingonRefreshonSetLayerFiltersonSetOpacityonSetStyleAccordingToLegendonSetVisibleonSetZIndexonSourceErroronStyleAppliedonTextVisibleChangedqueryLegendrefreshsetExtentsetHoverablesetLayerFiltersDatasetLayerFiltersDatesetLayerFiltersTimesetLayerNamesetLegendsetMaxResolutionsetMaxZoomsetMinResolutionsetMinZoomsetOLLayersetOpacitysetParentsetQueryablesetStylesetStyleAppliedsetStyleItemVisibilitysetTextVisiblesetVisiblesetZIndexwaitForBoundswaitForLegendQueriedwaitForLoadedOncewaitForLoadedStatuswaitForRenderwaitForSourceReadywaitForStyleAppliedVectorcalculateStyleForFeaturecalculateTextStyleForFeaturecreateLegendFromStylefindBestNameFieldgetFeatureIconSourcegetFieldTypegetParenthelperFormatFeatureInfoResulthelperGetFieldValueinitOptionsWithInitialSettings