search string side menu

Object for filtering and loading report app items.

Type parameters

Hierarchy

  • ReportSearch

Methods

all

  • all(): Promise<Partial<TData>[]>

  • The method loads report app items.

    By default, the number of search results is 10. If you need more items, use the ReportSearch.size method. 

    const reportItems = await  Context.fields.report.search().all();

    Returns Promise<Partial<TData>[]>

from

  • from(value: number): this

  • The method allows you to skip a specified number of search results.

    Parameters

    • value: number

    Returns this

having

  • having(fc: FilterClosure<THaving>): this

  • The method can be used to filter a report’s columns with aggregation.

    Parameters

    • fc: FilterClosure<THaving>

    Returns this

size

  • size(value: number): this

  • The method is used to limit the number of returned search results.

    Parameters

    • value: number

    Returns this

sort

  • sort(column: string, ascending?: undefined | false | true): this

  • The method is used to sort search results.

    Parameters

    • column: string
    • Optional ascending: undefined | false | true

    Returns this

where

  • where(fc: FilterClosure<TWhere>): this

  • The method can be used to filter a report’s columns without aggregation.

    Parameters

    • fc: FilterClosure<TWhere>

    Returns this