Interface IRowWindowWithMerge

interface IRowWindowWithMerge {
    after(n: number, optional?: boolean): Promise<Record<string, any>>;
    before(n: number, optional?: boolean): Promise<Record<string, any>>;
    isFiltered(item: Record<string, any>): Promise<boolean>;
    mergeDownIf(
        col: string | string[],
        cond?: SubRowFilter,
        opts?: IMergeOptions,
    ): string | any[];
    mergeIf(
        col: string | string[],
        step: number,
        cond: SubRowFilter,
        opts?: IMergeOptions,
    ): string | any[];
    mergeUpIf(
        col: string | string[],
        cond?: SubRowFilter,
        opts?: IMergeOptions,
    ): string | any[];
    [key: string]: any;
}

Hierarchy

  • IRowWindow
    • IRowWindowWithMerge

Indexable

  • [key: string]: any

Methods

after before isFiltered mergeDownIf mergeIf mergeUpIf

Methods

after

  • after(n: number, optional?: boolean): Promise<Record<string, any>>

    Parameters

    • n: number
    • Optionaloptional: boolean

    Returns Promise<Record<string, any>>

before

  • before(n: number, optional?: boolean): Promise<Record<string, any>>

    Parameters

    • n: number
    • Optionaloptional: boolean

    Returns Promise<Record<string, any>>

isFiltered

  • isFiltered(item: Record<string, any>): Promise<boolean>

    Parameters

    • item: Record<string, any>

    Returns Promise<boolean>

mergeDownIf

  • mergeDownIf(
        col: string | string[],
        cond?: SubRowFilter,
        opts?: IMergeOptions,
    ): string | any[]

    Merge this row and rows below that satisfy cond. mergeIf

    Parameters

    • col: string | string[]
    • Optionalcond: SubRowFilter
    • Optionalopts: IMergeOptions

    Returns string | any[]

mergeIf

  • mergeIf(
        col: string | string[],
        step: number,
        cond: SubRowFilter,
        opts?: IMergeOptions,
    ): string | any[]

    Merge Rows starting at the current row and iterating by step. Merge will continue until a row doesnt pass cond

    Parameters

    • col: string | string[]

      column or columns to merge

    • step: number

      offset to next row

    • cond: SubRowFilter

      Conditional test for each row.

    • Optionalopts: IMergeOptions

    Returns string | any[]

    string or array containing the matching values

mergeUpIf

  • mergeUpIf(
        col: string | string[],
        cond?: SubRowFilter,
        opts?: IMergeOptions,
    ): string | any[]

    Merge this row and rows above that satisfy cond. If cond is not specified the inverse of the active row filter will be used

    mergeIf

    Parameters

    • col: string | string[]
    • Optionalcond: SubRowFilter
    • Optionalopts: IMergeOptions

    Returns string | any[]

Settings

Member Visibility

On This Page

Methods