Open Pioneer Trails Packages
    Preparing search index...

    Interface ResultListProps

    Properties supported by the ResultList component.

    interface ResultListProps {
        enableHighlight?: boolean;
        enableZoom?: boolean;
        highlightOptions?: HighlightOptions;
        input: ResultListInput;
        map?: MapModel;
        mapId?: string;
        memoizeRows?: boolean;
        onSelectionChange?: (event: ResultListSelectionChangeEvent) => void;
        selectionMode?: SelectionMode;
        selectionStyle?: "radio" | "checkbox";
        zoomOptions?: ZoomOptions;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enableHighlight? enableZoom? highlightOptions? input map? mapId? memoizeRows? onSelectionChange? selectionMode? selectionStyle? zoomOptions?

    Properties

    enableHighlight?: boolean

    Should data be highlighted in the map. Default true.

    enableZoom?: boolean

    Specifies if the map should zoom to features when they are loaded into the result-list. Defaults to true.

    highlightOptions?: HighlightOptions

    Optional styling option

    input: ResultListInput

    Describes the data rendered by the component.

    map?: MapModel

    The map model to use.

    mapId?: string

    The id of the map. The map will be looked up in the MapRegistry service.

    Use the map property instead.

    DefaultMapProvider

    memoizeRows?: boolean

    Should each row be memoized to improve render performance. Default false.

    onSelectionChange?: (event: ResultListSelectionChangeEvent) => void

    This handler is called whenever the user has changed the selected features in the result-list.

    selectionMode?: SelectionMode

    The selection mode used by the result list. Defaults to "multi".

    selectionStyle?: "radio" | "checkbox"

    The style used for the selection controls in a row. Defaults to "checkbox" if selectionMode is "multi", or "radio" if selectionMode is "single".

    Note: "radio" can not be used together with multi selection.

    zoomOptions?: ZoomOptions

    Optional zooming options

    Settings

    Member Visibility

    On This Page

    Properties