POLAR reference
    Preparing search index...

    Interface SearchMethodConfiguration

    Object containing information for a specific search method.

    interface SearchMethodConfiguration {
        type: string;
        url: string;
        categoryId?: string;
        groupId?: string;
        hint?: string;
        label?: string;
        queryParameters?: QueryParameters;
        resultModifier?: (
            object: PolarGeoJsonFeatureCollection,
        ) => PolarGeoJsonFeatureCollection;
    }
    Index
    type url categoryId? groupId? hint? label? queryParameters? resultModifier?
    type: string

    Service type. Enum can be extended by configuration, see addressSearch.customSearchMethods.

    url: string

    Search service URL. Should you require a service provider, please contact us for further information.

    categoryId?: string

    Grouped services can optionally be distinguished in the UI with categories. See addressSearch.categoryProperties for configuration options.

    'default'
    groupId?: string

    All services with the same id are grouped and used together. See addressSearch.groupProperties for configuration options. If multiple groups exist, the UI offers a group switcher.

    Default groupId is "defaultGroup".

    hint?: string

    Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key. If grouped with other services, the group's hint will be used instead.

    label?: string

    Display label. Can be a locale key. If grouped with other services, the group's label will be used instead.

    queryParameters?: QueryParameters

    The object further describes details for the search request. Its contents vary by service type, see BKGParameters, MpapiParameters or WfsParameters.

    resultModifier?: (
        object: PolarGeoJsonFeatureCollection,
    ) => PolarGeoJsonFeatureCollection

    The function will receive the full FeatureCollection object that may be reduced before returning it. The resultModifier function will be called before adding anything to the store. Programming knowledge required.

    Settings
    Member Visibility

    On This Page
    Properties