@docsvision/webclient/BackOffice/Tasks.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { ITaskCreatingEventArgs } from "@docsvision/webclient/BackOffice/ITaskCreatingEventArgs";
import { ITaskDataModel } from "@docsvision/webclient/BackOffice/ITaskDataModel";
import { ITaskRowClickEventArgs } from "@docsvision/webclient/BackOffice/ITaskRowClickEventArgs";
import { TasksImpl, ITasksState } from "@docsvision/webclient/BackOffice/TasksImpl";
import { $LayoutController, $LayoutTasksController } from "@docsvision/webclient/Generated/DocsVision.WebClient.Controllers";
import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
import { $DeviceType } from "@docsvision/webclient/StandardServices";
import { BaseControl, BaseControlParams } from "@docsvision/webclient/System/BaseControl";
import { $Layout } from "@docsvision/webclient/System/$Layout";
import { $CardInfo, $EditOperationStore } from "@docsvision/webclient/System/LayoutServices";
import { BasicApiEvent, CancelableApiEvent } from "@docsvision/webclient/System/ApiEvent";
import { IEventArgs } from "@docsvision/webclient/System/IEventArgs";
import { $LayoutManager } from "@docsvision/webclient/System/$LayoutManager";
import { $RouterNavigation } from '@docsvision/webclient/System/$Router';
/**
 * Содержит публичные свойства элемента управления [Задания]{@link Tasks}.
 */
export declare class TasksParams extends BaseControlParams {
    /** Стандартный CSS класс со стилями элемента управления. */
    standardCssClass?: string;
    /** Список заданий. */
    tasks: ITaskDataModel[];
    /** Виды заданий для отображения. */
    viewKinds?: unknown;
    /** Виды заданий для создания. */
    tasksCreateInfo?: GenModels.CreateKindDataModel[];
    /** Можно ли создавать задания. */
    canCreateTask?: boolean;
    /** Можно ли создавать группы заданий. */
    canCreateTaskGroup?: boolean;
    /** Заголовок. */
    header?: string;
    /** Показывать ли дайджест представления заданий, когда контрол свёрнут. */
    digestView?: boolean;
    /** Развёрнут ли контрол с заданиями. */
    isExpanded?: boolean;
    /** Разрешено ли добавление заданий. */
    addTaskAllowed?: boolean;
    /** Загружены ли задания. */
    tasksLoaded: boolean;
    /** Идентификатор карточки. */
    cardId?: string;
    /** Режим. */
    mode?: GenModels.TasksDisplayMode;
    /** Режим открытия заданий. */
    openMode?: GenModels.TasksOpenMode;
    approvingChildTaskCreateLayoutPositionName?: string;
    /** Событие, возникающее перед сворачиванием. */
    collapsing?: CancelableApiEvent<IEventArgs>;
    /** Событие, возникающее при сворачивании. */
    collapsed?: BasicApiEvent<IEventArgs>;
    /** Событие, возникающее перед разворачиванием. */
    expanding?: CancelableApiEvent<IEventArgs>;
    /** Событие, возникающее при разворачивании. */
    expanded?: BasicApiEvent<IEventArgs>;
    /** Событие, возникающее перед созданием задачи. */
    taskCreating?: CancelableApiEvent<ITaskCreatingEventArgs>;
    /** Событие, возникающее после того, как задания загружены (при асинхронной загрузке событие возникает после открытия разметки). */
    onTasksLoaded?: BasicApiEvent<GenModels.TaskDataModel[]>;
    /** Событие возникает при клике на строку таблицы. */
    rowClick?: BasicApiEvent<ITaskRowClickEventArgs>;
    /** Событие возникает перед кликом по имени задания. */
    nameTaskClicking?: CancelableApiEvent<ITaskRowClickEventArgs>;
    services?: $LayoutTasksController & $EditOperationStore & $Layout & $CardInfo & $LayoutController & $LayoutManager & $RouterNavigation & $DeviceType;
}
/**
 * Класс элемента управления Задания
 *
 * Добавляет в web-разметку элемент управления для работы с заданиями.
 */
export declare class Tasks extends BaseControl<TasksParams, ITasksState> {
    /** @internal */
    protected createParams(): TasksParams;
    private get tasksImpl();
    private set binding(value);
    private set createKindsBinding(value);
    /**
     * Добавление задания.
     * @param taskCreateInfoId Идентификатор добавляемого задания
     */
    addTask(taskCreateInfoId: string): void;
    /**
     * Добавляет/удаляет css класс строки таблицы.
     * @param task ITaskDataModel.
     * @param style Класс, который будет добавлен к строке.
     */
    toggleRowClass(task: ITaskDataModel, style: string): void;
    /** @internal */
    protected createImpl(): TasksImpl;
}