@vertigis/viewer-spec/app-config/common/SearchModelProperties.d.ts

VertiGIS Viewer Specification

import type { Action } from "@vertigis/arcgis-extensions/support/Action";
import type { ComponentModelProperties } from "./ComponentModelProperties.js";
/**
 * Properties for a search component.
 */
export interface SearchModelProperties extends ComponentModelProperties {
    /**
     * The maximum number of results to return per feature source (layer,
     * sublayer, table, geocoder, etc.).
     */
    maxResults?: number;
    /**
     * The maximum number of results to query per feature source, will be sorted
     * by score and limited by maxResults NOTE: Not supported for layers on
     * ArcGIS Server version 10.2 or older.
     */
    maxQueryResults?: number;
    /**
     * The command to execute when the user clears the search input.
     */
    onClear?: Action;
    /**
     * The command to execute when the user initiates a search.
     */
    onSearch?: Action;
}