NextGIS Frontend
    Preparing search index...

    Interface SearchResource

    Options for searching within a NGW resource.

    interface SearchResource {
        cache?: boolean;
        clientFilterValidate?: boolean;
        extensions?: false | string[] | (keyof FeatureItemExtensions)[] | null;
        fields?: false | (string | number)[] | null;
        filters?: PropertiesFilter<PropertiesForNgwFilter<FeatureProperties>>;
        geom?: boolean;
        geomFormat?: GeomFormat;
        ilike?: string;
        intersects?: string | LngLatBoundsArray | LngLatArray[];
        like?: string;
        limit?: number;
        offset?: number;
        orderBy?: (string | number)[];
        paramList?: [string, any][];
        query?: any;
        renderSearch?: (item: RenderSearchItem) => string | HTMLElement;
        resourceId: string | number;
        searchMethod?: "like" | "ilike";
        signal?: AbortSignal | null;
        srs?: number;
        strategy?: "BBOX" | "BBOX+";
    }

    Hierarchy

    Index
    cache? clientFilterValidate? extensions? fields? filters? geom? geomFormat? ilike? intersects? like? limit? offset? orderBy? paramList? query? renderSearch? resourceId searchMethod? signal? srs? strategy?
    cache?: boolean
    clientFilterValidate?: boolean
    extensions?: false | string[] | (keyof FeatureItemExtensions)[] | null
    fields?: false | (string | number)[] | null
    filters?: PropertiesFilter<PropertiesForNgwFilter<FeatureProperties>>
    geom?: boolean
    geomFormat?: GeomFormat
    ilike?: string
    intersects?: string | LngLatBoundsArray | LngLatArray[]

    WKT polygon geometry

    like?: string
    limit?: number

    Limit (paginated) - max number of entities should be taken.

    offset?: number

    Offset (paginated) where from entities should be taken.

    orderBy?: (string | number)[]

    set fields for order

    TODO: use typescript 4.1 template string type for map -${field}

    { "orderBy": ["field1", "-field2"] }
    paramList?: [string, any][]

    use NgwRequestOptions.query instead

    query?: any
    renderSearch?: (item: RenderSearchItem) => string | HTMLElement

    Custom rendering function for search results

    resourceId: string | number
    searchMethod?: "like" | "ilike"

    The search method used ('ilike' is case-insensitive)

    signal?: AbortSignal | null

    An AbortSignal to set request's signal.

    srs?: number
    strategy?: "BBOX" | "BBOX+"

    Settings
    Member Visibility

    On This Page
    Properties