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

Type definitions for DocsVision WebClient scripts and extensions.

import { $GridController } from '@docsvision/webclient/Generated/DocsVision.WebClient.Controllers';
import { FolderCardsDashboardWidgetImpl, IFolderCardsDashboardWidgetState } from "@docsvision/webclient/Platform/FolderCardsDashboardWidgetImpl";
import { Panel, PanelParams } from "@docsvision/webclient/Platform/Panel";
import { $Layout } from '@docsvision/webclient/System/$Layout';
import { $LayoutInfo } from '@docsvision/webclient/System/LayoutServices';
import { $LocationContainerControlServices } from '@docsvision/webclient/System/LocationContainerControl';
import { $ExperimentalFeature } from '@docsvision/webclient/System/$ExperimentalFeature';
import { $LayoutManager } from '@docsvision/webclient/System/$LayoutManager';
import React from 'react';
/**
 * Содержит публичные свойства элемента управления [FolderCardsDashboardWidget]{@link FolderCardsDashboardWidget}.
 */
export declare class FolderCardsDashboardWidgetParams extends PanelParams {
    /** Текст заголовка. */
    header: string;
    /** Идентификатор папки, карточки которой будут показаны. */
    folderId: string;
    /** Идентификатор представления. Если не задан, то используется представление по умолчанию. */
    viewId?: string;
    /** Поисковый запрос. По умолчанию используется поисковый запрос, ассоциированный с папкой (если это поисковая папка). */
    searchId?: string;
    /** Столбец, по которому необходимо произвести сортировку. По умолчанию используется сортировка папки. */
    sortColumnName?: string;
    /** Направление сортировки - если true, то по убыванию, иначе по возрастанию. */
    sortDescending?: string;
    /** Колличество карточек которые будут отображены. По умолчанию 5. */
    cardsCount?: number;
    /** Стандартный CSS класс со стилями элемента управления */
    standardCssClass?: string;
    services?: $GridController & $LayoutInfo & $GridController & $LayoutManager & $Layout & $LocationContainerControlServices & $ExperimentalFeature;
}
/**
 * @review
 */
export declare class FolderCardsDashboardWidget extends Panel<FolderCardsDashboardWidgetParams, IFolderCardsDashboardWidgetState> {
    createParams(): FolderCardsDashboardWidgetParams;
    protected createImpl(): FolderCardsDashboardWidgetImpl<Readonly<FolderCardsDashboardWidgetParams> & Readonly<{
        children?: React.ReactNode;
    }>, IFolderCardsDashboardWidgetState>;
}