@docsvision/webclient/Platform/FolderDataLoadingService.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { IFolderDataLoader } from "@docsvision/webclient/Platform/IFolderDataLoader";
import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
import { IFolderDataLoadingService } from "@docsvision/webclient/Platform/$FolderDataLoading";
import { $ApplicationSettings, $DeviceType } from "@docsvision/webclient/StandardServices";
import { $CurrentLocation } from "@docsvision/webclient/System/LayoutServices";
import { IFolderDataLoadingPlugin } from "@docsvision/webclient/Platform/IFolderDataLoadingPlugin";
import { ITableData } from "@docsvision/web/components/table/interfaces";
import { IFolderLoadRequest } from "./IFolderLoadRequest";
import { $GridController } from "@docsvision/webclient/Generated/DocsVision.WebClient.Controllers";
import { IColumnsWidth } from "@docsvision/web/components/table/plugins/resize-column/$ResizeColumn";
import { SortDirection } from "@docsvision/web/components/table/plugins/sort";
import { IFilterActiveColumn } from "@docsvision/web/components/table/plugins/filter";
import { $Domain } from "@docsvision/web/core/state-management";
import { $Router } from "@docsvision/webclient/System/$Router";
import { Store, Event } from "effector";
import { $CurrentFolder } from "@docsvision/webclient/Platform/$CurrentFolder";
import { $LastSearchResponse } from "@docsvision/webclient/System/$LastSearchResponse";
import { $WebFrameSearchPanel } from "@docsvision/webclient/Platform/$WebFrameSearchPanel";
import { IGrouping, IGroupingPathItem, ILoadGroupingItemsOptions } from "@docsvision/web/components/table/plugins/grouping";
import { IAggregateItem } from "@docsvision/webclient/Platform/IAggregates";
export declare type $FolderDataLoadingDependencies = $DeviceType & $CurrentLocation & $GridController & $ApplicationSettings & $Domain & $Router & $CurrentFolder & $LastSearchResponse & $WebFrameSearchPanel;
export declare class FolderDataLoadingService implements IFolderDataLoadingService {
    private defaultDataLoader;
    private services;
    lastResponse: GenModels.GridViewModel;
    private lastRequest;
    private folderInfo;
    private plugins;
    constructor(defaultDataLoader: IFolderDataLoader, services: $FolderDataLoadingDependencies);
    init(): void;
    addPlugin(plugin: IFolderDataLoadingPlugin): void;
    removePlugin(id: string): void;
    getPlugins(): IFolderDataLoadingPlugin[];
    currentData: Store<ITableData>;
    setCurrentData: Event<ITableData>;
    pageSize: number;
    loadData(options: IFolderLoadRequest, customLoader?: IFolderDataLoader): Promise<void>;
    private createRequest;
    private resolveRequest;
    private resolveResponse;
    sortBy(columnId: string, sortDirection: SortDirection): Promise<void>;
    filterBy(filterColumns: IFilterActiveColumn[]): Promise<void>;
    setDefaultDataLoader(loader: IFolderDataLoader): void;
    updateUserSettings(customLoader?: IFolderDataLoader): Promise<void>;
    private checkSystemFolderSearchResultsText;
    downloadExcelReport(): void;
    saveColumnSettings(columns: IColumnsWidth[]): Promise<void>;
    savePresentation(tablePresentation: GenModels.TablePresentation): Promise<void>;
    resetUserSettings(): Promise<void>;
    loadGrouping(options: ILoadGroupingItemsOptions): Promise<IGrouping>;
    saveGroupingPath(path: IGroupingPathItem[]): Promise<void>;
    saveAggregatesToGridUserSettings(items: IAggregateItem[]): Promise<void>;
}