geoview-core
    Preparing search index...

    Class CSV

    Class used to add a CSV layer to the map

    CSV

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    hitTolerance listOfLayerEntryConfig olRootLayer? DEFAULT_HIT_TOLERANCE DEFAULT_WAIT_PERIOD_METADATA_WARNING DEFAULT_WAIT_SLOW_FETCH_WARNING EXCLUDED_HEADERS EXCLUDED_HEADERS_GEN EXCLUDED_HEADERS_LAT EXCLUDED_HEADERS_LNG EXCLUDED_HEADERS_STYLE MAX_ESRI_FEATURES NAME_FIELD_KEYWORDS

    Methods

    addLayerLoadError allLayerStatusAreGreaterThanOrEqualTo createGeoViewLayers createGVLayer createVectorSource emitLayerEntryRegisterInit emitMessage fetchServiceMetadata getAllLayerEntryConfigs getClassName getGeoviewLayerConfig getGeoviewLayerId getGeoviewLayerName getLayerEntryNameOrGeoviewLayerName getMetadata getMetadataAccessPath getMetadataAccessPathIfExists getServerDateFragmentsOrder hasMetadataAccessPath initGeoViewLayerEntries initServerDateFragmentsOrderFromServiceDateFormat offLayerConfigCreated offLayerEntryProcessed offLayerEntryRegisterInit offLayerGroupCreated offLayerGVCreated offLayerMessage onCreateGVLayer onCreateVectorSource onCreateVectorSourceLoadFeatures onFetchServiceMetadata onInitLayerEntries onLayerConfigCreated onLayerEntryProcessed onLayerEntryRegisterInit onLayerGroupCreated onLayerGVCreated onLayerMessage onProcessLayerMetadata onProcessOneLayerEntry onValidateLayerEntryConfig onValidateListOfLayerEntryConfig setMetadataAccessPath setServerDateFragmentsOrder validateLayerEntryConfig validateListOfLayerEntryConfig createGeoviewLayerConfig fetchJson fetchText initGeoviewLayerConfig processConfig processGeoviewLayerConfig

    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_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_SLOW_FETCH_WARNING: number = ...

    The maximum delay to wait before we warn about the features fetch taking a long time

    EXCLUDED_HEADERS: string[] = ...
    EXCLUDED_HEADERS_GEN: string[] = ...
    EXCLUDED_HEADERS_LAT: string[] = ...
    EXCLUDED_HEADERS_LNG: string[] = ...
    EXCLUDED_HEADERS_STYLE: string[] = ...
    MAX_ESRI_FEATURES: 200000
    NAME_FIELD_KEYWORDS: string[] = ...

    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

      • OptionalmapProjection: Projection

        The map projection.

      • OptionalabortSignal: AbortSignal

        Abort signal to handle cancelling of the process.

      Returns Promise<ConfigBaseClass[]>

      A promise of the config base classes created.

    • Protected

      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 = []

        Array of parameters to be interpolated into the localized message

      • messageType: SnackbarType = ...

        The message type

      • Optionalnotification: boolean = false

        Whether to show this as a notification. Defaults to false

      Returns void

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

      LayerMessageEvent

    • Protected

      Overrides the loading of the vector features for the layer by fetching CSV data and converting it into OpenLayers Feature feature instances.

      Parameters

      • layerConfig: VectorLayerEntryConfig

        The configuration object for the vector layer, containing source and data access information.

      • sourceOptions: Options<Feature<Geometry>>

        The OpenLayers vector source options associated with the layer. This may be used by implementations to customize loading behavior or source configuration.

      • readOptions: ReadOptions

        Options controlling how features are read, including the target featureProjection.

      Returns Promise<Feature<Geometry>[]>

      A promise that resolves to an array of OpenLayers features.

    • Overrides the way the layer metadata is processed.

      Parameters

      • layerConfig: VectorLayerEntryConfig

        The layer entry configuration to process.

      • OptionalmapProjection: Projection

        The map projection.

      • OptionalabortSignal: AbortSignal

        Abort signal to handle cancelling of the process.

      Returns Promise<VectorLayerEntryConfig>

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

    • Creates a configuration object for a CSV Feature layer. This function constructs a TypeCSVLayerConfig object that describes a CSV Feature 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

        The URL or path to access metadata or feature data.

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

      The constructed configuration object for the CSV Feature layer.

    • Fetches json data from the given URL using settings defined in the vector source configuration. Supports both GET and POST requests depending on the presence of postSettings.

      Parameters

      • url: string

        The URL to fetch data from.

      • OptionalpostSettings: TypePostSettings

        The possible POST settings from the layer config.

      Returns Promise<unknown>

      A promise that resolves to the fetched text response.

    • Fetches text data from the given URL using settings defined in the vector source configuration. Supports both GET and POST requests depending on the presence of postSettings.

      Parameters

      • url: string

        The URL to fetch data from.

      • OptionalpostSettings: TypePostSettings

        The possible POST settings from the layer config.

      Returns Promise<string>

      A promise that resolves to the fetched text response.

    • Initializes a GeoView layer configuration for a CSV 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 a CSV 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.

      Returns Promise<ConfigBaseClass[]>

      A promise that resolves to an array of layer configurations.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    addLayerLoadErrorallLayerStatusAreGreaterThanOrEqualTocreateGeoViewLayerscreateGVLayercreateVectorSourceemitLayerEntryRegisterInitemitMessagefetchServiceMetadatagetAllLayerEntryConfigsgetClassNamegetGeoviewLayerConfiggetGeoviewLayerIdgetGeoviewLayerNamegetLayerEntryNameOrGeoviewLayerNamegetMetadatagetMetadataAccessPathgetMetadataAccessPathIfExistsgetServerDateFragmentsOrderhasMetadataAccessPathinitGeoViewLayerEntriesinitServerDateFragmentsOrderFromServiceDateFormatoffLayerConfigCreatedoffLayerEntryProcessedoffLayerEntryRegisterInitoffLayerGroupCreatedoffLayerGVCreatedoffLayerMessageonCreateGVLayeronCreateVectorSourceonCreateVectorSourceLoadFeaturesonFetchServiceMetadataonInitLayerEntriesonLayerConfigCreatedonLayerEntryProcessedonLayerEntryRegisterInitonLayerGroupCreatedonLayerGVCreatedonLayerMessageonProcessLayerMetadataonProcessOneLayerEntryonValidateLayerEntryConfigonValidateListOfLayerEntryConfigsetMetadataAccessPathsetServerDateFragmentsOrdervalidateLayerEntryConfigvalidateListOfLayerEntryConfigcreateGeoviewLayerConfigfetchJsonfetchTextinitGeoviewLayerConfigprocessConfigprocessGeoviewLayerConfig