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

    Class ImageStatic

    A class to add image static layer.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    hitTolerance listOfLayerEntryConfig olRootLayer? DEFAULT_DISPLAY_DATE_MODE_TO_GENERATE_CONFIGS DEFAULT_HIT_TOLERANCE DEFAULT_WAIT_PERIOD_METADATA_WARNING DEFAULT_WAIT_PERIOD_METADATA_WARNING_RECALL

    Methods

    addLayerLoadError allLayerStatusAreGreaterThanOrEqualTo createGeoViewLayers createGVLayer emitLayerEntryRegisterInit emitMessage fetchServiceMetadata getAllLayerEntryConfigs getClassName getGeoviewLayerConfig getGeoviewLayerId getGeoviewLayerName getLayerEntryNameOrGeoviewLayerName getMetadata getMetadataAccessPath getMetadataAccessPathIfExists hasMetadataAccessPath initGeoViewLayerEntries initGVLayer offLayerConfigCreated offLayerEntryProcessed offLayerEntryRegisterInit offLayerGroupCreated offLayerGVCreated offLayerMessage onCreateGVLayer onFetchServiceMetadata onInitGVLayer onInitLayerEntries onLayerConfigCreated onLayerEntryProcessed onLayerEntryRegisterInit onLayerGroupCreated onLayerGVCreated onLayerMessage onProcessLayerMetadata onProcessOneLayerEntry onValidateLayerEntryConfig onValidateListOfLayerEntryConfig setMetadataAccessPath validateLayerEntryConfig validateListOfLayerEntryConfig createGeoviewLayerConfig createImageStaticSource fetchMetadata initGeoviewLayerConfig processConfig processGeoviewLayerConfig throwIfMetatadaHasError

    Constructors

    Properties

    hitTolerance: number = AbstractGeoViewLayer.DEFAULT_HIT_TOLERANCE

    The default hit tolerance

    listOfLayerEntryConfig: TypeLayerEntryConfig[] = []

    An array of layer settings. In the schema, this attribute is optional. However, we define it as mandatory and if the configuration does not provide a value, we use an empty array instead of an undefined attribute.

    olRootLayer?: BaseLayer

    The OpenLayer root layer representing this GeoView Layer.

    DEFAULT_DISPLAY_DATE_MODE_TO_GENERATE_CONFIGS: DisplayDateMode = 'long'

    The default display date mode used when generating default configurations

    DEFAULT_HIT_TOLERANCE: number = 4

    The default hit tolerance the query should be using

    DEFAULT_WAIT_PERIOD_METADATA_WARNING: number = ...

    The default waiting time before showing a warning about the metadata taking a long time to get processed

    DEFAULT_WAIT_PERIOD_METADATA_WARNING_RECALL: number = ...

    Methods

    • This method is used to create the layers specified in the listOfLayerEntryConfig attribute inherited from its parent.

      Normally, it is the second method called in the life cycle of a GeoView layer, the first one being the constructor. Its code is the same for all child classes. It must first validate that the olLayers attribute is null indicating that the method has never been called before for this layer. If this is not the case, an error message must be sent. Then, it calls the abstract method getAdditionalServiceDefinition. For example, when the child is a WFS service, this method executes the GetCapabilities request and saves the result in the metadata attribute of the class. It also process the layer's metadata for each layer in the listOfLayerEntryConfig tree in order to define the missing pieces of the layer's configuration. Layer's configuration can come from the configuration of the GeoView layer or from the information saved by the method #processListOfLayerMetadata, priority being given to the first of the two. When the GeoView layer does not have a service definition, the getAdditionalServiceDefinition method does nothing.

      Finally, the processListOfLayerEntryConfig is called to instantiate each layer identified by the listOfLayerEntryConfig attribute. This method will also register the layers to all layer sets that offer this possibility. For example, if a layer is queryable, it will subscribe to the details-panel and every time the user clicks on the map, the panel will ask the layer to return the descriptive information of all the features in a tolerance radius. This information will be used to populate the details-panel.

      Parameters

      • displayDateMode: DisplayDateMode

        The display date mode to use for processing time dimensions in the metadata

      • OptionalmapProjection: Projection

        Optional map projection

      • OptionalabortSignal: AbortSignal

        Optional AbortSignal used to cancel the layer creation process

      Returns Promise<ConfigBaseClass[]>

      A promise that resolves with the config base classes created

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

      Parameters

      • messageKey: string

        The key used to lookup the localized message OR message

      • messageParams: string[] | undefined = []

        Optional array of parameters to be interpolated into the localized message

      • messageType: SnackbarType = 'info'

        The message type

      • notification: boolean = false

        Optional whether to show this as a notification. Defaults to false

      Returns void

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

    • Overrides the way the layer metadata is processed.

      Parameters

      • layerConfig: ImageStaticLayerEntryConfig

        The layer entry configuration to process.

      • displayDateMode: DisplayDateMode

        The display date mode to use for processing time dimensions in the metadata.

      • OptionalmapProjection: Projection

        Optional map projection.

      • OptionalabortSignal: AbortSignal

        Optional AbortSignal used to cancel the layer creation process.

      Returns Promise<ImageStaticLayerEntryConfig>

      A promise that resolves once the layer entry configuration has gotten its metadata processed.

    • Creates a configuration object for a Static Image layer. This function constructs a TypeImageStaticLayerConfig object that describes an Static Image layer and its associated entry configurations based on the provided parameters.

      Parameters

      • geoviewLayerId: string

        A unique identifier for the GeoView layer.

      • geoviewLayerName: string

        The display name of the GeoView layer.

      • metadataAccessPath: string | undefined

        The URL or path to access metadata.

      • isTimeAware: boolean | undefined

        Indicates whether the layer supports time-based filtering.

      • layerEntries: TypeLayerEntryShell[]

        An array of layer entries objects to be included in the configuration.

      Returns TypeImageStaticLayerConfig

      The constructed configuration object for the Static Image layer.

    • Creates a StaticImage source from a layer config.

      Parameters

      • layerConfig: ImageStaticLayerEntryConfig

        Configuration for the image static layer.

      Returns Static

      A configured ol/source/ImageStatic instance.

      When the Data Access Path was undefined, likely because initDataAccessPath wasn't called.

      When the source extent isn't defined.

      When the source projection isn't defined.

    • Fetches and validates metadata from a given URL for a GeoView raster layer.

      If the URL does not end with .json, the query string ?f=json is appended to request JSON format. The response is parsed and checked for service-level errors. If an error is found, an exception is thrown.

      Type Parameters

      • T

      Parameters

      • url: string

        The base URL to fetch the metadata from (e.g., ArcGIS REST endpoint).

      • OptionalabortSignal: AbortSignal

        Optional AbortSignal used to cancel the layer creation process.

      Returns Promise<T>

      A promise resolving to the parsed JSON metadata response.

      When the request exceeds the timeout duration.

      When the request was aborted by the caller's signal.

      When the response is not OK (non-2xx).

      When the JSON response is empty.

    • Initializes a GeoView layer configuration for an Image Static layer. This method creates a basic TypeGeoviewLayerConfig using the provided ID, name, and metadata access path URL. It then initializes the layer entries by calling initGeoViewLayerEntries, which may involve fetching metadata or sublayer info.

      Parameters

      • geoviewLayerId: string

        A unique identifier for the layer.

      • geoviewLayerName: string

        The display name of the layer.

      • metadataAccessPath: string

        The full service URL to the layer endpoint.

      • OptionalisTimeAware: boolean

        Indicates whether the layer supports time-based filtering.

      Returns Promise<TypeGeoviewLayerConfig>

      A promise that resolves to an initialized GeoView layer configuration with layer entries.

    • Processes an ImageStatic GeoviewLayerConfig and returns a promise that resolves to an array of ConfigBaseClass layer entry configurations.

      This method:

      1. Creates a Geoview layer configuration using the provided parameters.
      2. Instantiates a layer with that configuration.
      3. Processes the layer configuration and returns the result.

      Parameters

      • geoviewLayerId: string

        The unique identifier for the GeoView layer.

      • geoviewLayerName: string

        The display name for the GeoView layer.

      • url: string

        The URL of the service endpoint.

      • layerIds: string[]

        An array of layer IDs to include in the configuration.

      • isTimeAware: boolean

        Indicates if the layer is time aware.

      • sourceExtent: Extent

        Indicates the extent where the static image should be.

      • sourceProjection: TypeValidSourceProjectionCodes

        Indicates the projection used for the sourceExtent.

      Returns Promise<ConfigBaseClass[]>

      A promise that resolves to an array of layer configurations.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    addLayerLoadErrorallLayerStatusAreGreaterThanOrEqualTocreateGeoViewLayerscreateGVLayeremitLayerEntryRegisterInitemitMessagefetchServiceMetadatagetAllLayerEntryConfigsgetClassNamegetGeoviewLayerConfiggetGeoviewLayerIdgetGeoviewLayerNamegetLayerEntryNameOrGeoviewLayerNamegetMetadatagetMetadataAccessPathgetMetadataAccessPathIfExistshasMetadataAccessPathinitGeoViewLayerEntriesinitGVLayeroffLayerConfigCreatedoffLayerEntryProcessedoffLayerEntryRegisterInitoffLayerGroupCreatedoffLayerGVCreatedoffLayerMessageonCreateGVLayeronFetchServiceMetadataonInitGVLayeronInitLayerEntriesonLayerConfigCreatedonLayerEntryProcessedonLayerEntryRegisterInitonLayerGroupCreatedonLayerGVCreatedonLayerMessageonProcessLayerMetadataonProcessOneLayerEntryonValidateLayerEntryConfigonValidateListOfLayerEntryConfigsetMetadataAccessPathvalidateLayerEntryConfigvalidateListOfLayerEntryConfigcreateGeoviewLayerConfigcreateImageStaticSourcefetchMetadatainitGeoviewLayerConfigprocessConfigprocessGeoviewLayerConfigthrowIfMetatadaHasError