POLAR reference
    Preparing search index...

    Interface GfiLayerConfiguration

    Gfi configuration for a layer.

    {
    	geometry: true,
    	window: true,
    	maxFeatures: 10,
    	geometryName: 'app:geometry',
    	exportProperty: 'Export',
    	properties: {
    		status: 'status',
    		type: 'type',
    	},
    	showTooltip: (feature: Feature): [string, string][] => [
    		['div', `Feature ID: ${feature.properties.id}`],
    		['span', `Coordinates: ${feature.geometry.coordinates.join(', ')}`],
    	],
    	isSelectable: (feature: Feature): boolean => Boolean(Math.random() < 0.5)
    }
    interface GfiLayerConfiguration {
        exportProperty?: string;
        filterBy?: "clickPosition";
        format?: "text" | "GML" | "GML2" | "GML3" | "GML32";
        geometry?: boolean;
        geometryName?: string;
        isSelectable?: (feature: Feature) => boolean;
        properties?: string[];
        showTooltip?: (feature: Feature) => [string, string][];
        window?: boolean;
    }
    Index

    Properties

    exportProperty? filterBy? format? geometry? geometryName? isSelectable? properties? showTooltip? window?

    Properties

    exportProperty?: string

    Property of the features of a service having an url usable to trigger a download of features as a document.

    filterBy?: "clickPosition"

    (WMS-only) Some WMS services may return features close to the clicked position. By setting the value clickPosition, only features that intersect the clicked position are shown to the user.

    Show all features
    format?: "text" | "GML" | "GML2" | "GML3" | "GML32"

    (WMS-only) If the infoFormat is not set to 'application/geojson'´, this can be configured to be the known file format of the response. If not given, the format is parsed from the response data.

    geometry?: boolean

    If true, feature geometry will be highlighted within the map.

    true
    geometryName?: string

    Name of the geometry property if not the default field.

    isSelectable?: (feature: Feature) => boolean

    A function can be defined to allow filtering features to be either selectable (return true) or not. Unselectable features will be filtered out by the GFI plugin and have neither GFI display nor store presence, but may be visible in the map nonetheless, depending on your other configuration. Please also mind that usage in combination with extendedMasterportalapiMarkers requires further configuration of that feature for smooth UX.

    Type Declaration

      • (feature: Feature): boolean

      • Parameters

        • feature: Feature

          Feature to check

        Returns boolean

        true if the feature should be selectable, false otherwise

    properties?: string[]

    In case window is true, this will be used to determine which contents to show. The property names can be localized, regardless if this is set or all properties are shown.

    Display all properties
    showTooltip?: (feature: Feature) => [string, string][]

    (WFS- and GeoJSON-only) If given, a tooltip will be shown with the values calculated for the feature. The first string is the HTML tag to render, the second its contents; contants may be locale keys.

    Please mind that tooltips will only be shown if a mouse is used or the hovering device could not be detected. Touch and pen interactions do not open tooltips since they will open the GFI window, rendering the gatherable information redundant.

    Type Declaration

      • (feature: Feature): [string, string][]

      • Parameters

        • feature: Feature

          Feature to calculate the tooltip for

        Returns [string, string][]

        [HTML tag to render, content or locale key]

    undefined
    window?: boolean

    If true, properties will be shown in the map client.

    false

    Settings

    Member Visibility

    On This Page

    Properties