Search
    Preparing search index...

    Interface IAbstractSearchColumnStore

    Интерфейс абстрактного стора колонок поисковой таблицы

    interface IAbstractSearchColumnStore {
        changeAttributeOrder: (index: number, newIndex?: number) => void;
        columnsSort: (a: ISearchColumn, b: ISearchColumn) => number;
        isMultiLine: boolean;
        isSortingApplied: (sort: ISortField[]) => boolean;
        loadSettings: (initColumns?: boolean) => Promise<void>;
        resetAllSettings: (asDefaults?: boolean) => Promise<void>;
        saveAllSettings: (
            sort: ISortField[],
            asDefaults?: boolean,
        ) => Promise<void>;
        setAllAttributesVisible: (value: boolean) => void;
        setMultiLineFlag: (isMultiLine: boolean) => void;
        get canReset(): boolean;
        get canResetDefault(): boolean;
        get columns(): ISearchColumn[];
        get isAttributesDirty(): boolean;
        get isMultiLineDirty(): boolean;
        get isRowSizeDirty(): undefined | boolean;
        get savedSettings(): undefined | ISavedSettings;
        get savedSortSettings(): ISortField[];
        get savedVisibleSettings(): Partial<
            Pick<GetTypes<SearchColumn>, GetNames<SearchColumn>>,
        >[];
        get tableRowHeights(): { [p: string]: number };
        get tableRowWidths(): { [p: string]: number };
        findColumnById(columnId: string): undefined | ISearchColumn;
        getTableColumns<T = SearchHit>(
            setColumn: (
                param: {
                    children?: (
                        | TableColumnWithoutData<T, undefined>
                        | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
                    )[];
                    item: ISearchColumn;
                    parent?:
                        | TableColumnWithoutData<T, undefined>
                        | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; });
                },
            ) => | TableColumnWithoutData<T, undefined>
            | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; }),
            initColumns?: (
                | TableColumnWithoutData<T, undefined>
                | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
            )[],
        ): (
            | TableColumnWithoutData<T, undefined>
            | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
        )[];
        resetColumnHeights(): void;
        resetColumnWidths(): void;
        resetRowHeights(): void;
        resetRowWidths(): void;
        updateRowHeights(values: [string, number][]): void;
        updateRowWidths(values: [string, number][]): void;
    }

    Implemented by

    Index

    Properties

    changeAttributeOrder columnsSort isMultiLine isSortingApplied loadSettings resetAllSettings saveAllSettings setAllAttributesVisible setMultiLineFlag

    Accessors

    canReset canResetDefault columns isAttributesDirty isMultiLineDirty isRowSizeDirty savedSettings savedSortSettings savedVisibleSettings tableRowHeights tableRowWidths

    Methods

    findColumnById getTableColumns resetColumnHeights resetColumnWidths resetRowHeights resetRowWidths updateRowHeights updateRowWidths

    Properties

    changeAttributeOrder: (index: number, newIndex?: number) => void

    Метод смены порядка атрибутов

    Type declaration

      • (index: number, newIndex?: number): void

      • Parameters

        • index: number

          порядковый номер элемента, который нужно изменить

        • OptionalnewIndex: number

          порядковый номер на который нужно заменить

        Returns void

    columnsSort: (a: ISearchColumn, b: ISearchColumn) => number

    Метод сортировки колонок

    Type declaration

    isMultiLine: boolean
    isSortingApplied: (sort: ISortField[]) => boolean
    loadSettings: (initColumns?: boolean) => Promise<void>

    Метод загрузки настроек

    resetAllSettings: (asDefaults?: boolean) => Promise<void>

    Метод сброса всех настроек

    Type declaration

      • (asDefaults?: boolean): Promise<void>

      • Parameters

        • OptionalasDefaults: boolean

          флаг, отвечающий за сброс настроек к значениям по умолчанию

        Returns Promise<void>

    saveAllSettings: (sort: ISortField[], asDefaults?: boolean) => Promise<void>

    Метод сохранения всех настроек

    Type declaration

      • (sort: ISortField[], asDefaults?: boolean): Promise<void>

      • Parameters

        • sort: ISortField[]

          сортировки для сохранения

        • OptionalasDefaults: boolean

          флаг, отвечающий за сохранение настроек по умолчанию

        Returns Promise<void>

    setAllAttributesVisible: (value: boolean) => void

    Метод, который управляет отображением колонок

    Type declaration

      • (value: boolean): void

      • Parameters

        • value: boolean

          флаг, отвечающий за задание всех атрибутов по умолчанию

        Returns void

    setMultiLineFlag: (isMultiLine: boolean) => void

    Accessors

    • get canReset(): boolean

      Returns boolean

    • get canResetDefault(): boolean

      Returns boolean

    • get columns(): ISearchColumn[]

      Геттер поисковых колонок

      Returns ISearchColumn[]

    • get isAttributesDirty(): boolean

      Параметр, показывающий изменен ли атрибут

      Returns boolean

    • get isMultiLineDirty(): boolean

      Returns boolean

    • get isRowSizeDirty(): undefined | boolean

      Returns undefined | boolean

    • get savedSortSettings(): ISortField[]

      Геттер сохраненных настроек сортировки

      Returns ISortField[]

    • get tableRowHeights(): { [p: string]: number }

      Returns { [p: string]: number }

    • get tableRowWidths(): { [p: string]: number }

      Returns { [p: string]: number }

    Methods

    • Parameters

      • columnId: string

      Returns undefined | ISearchColumn

    • Метод получения колонок таблицы

      Type Parameters

      Parameters

      • setColumn: (
            param: {
                children?: (
                    | TableColumnWithoutData<T, undefined>
                    | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
                )[];
                item: ISearchColumn;
                parent?:
                    | TableColumnWithoutData<T, undefined>
                    | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; });
            },
        ) => | TableColumnWithoutData<T, undefined>
        | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
      • OptionalinitColumns: (
            | TableColumnWithoutData<T, undefined>
            | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
        )[]

      Returns (
          | TableColumnWithoutData<T, undefined>
          | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
      )[]

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • values: [string, number][]

      Returns void

    • Parameters

      • values: [string, number][]

      Returns void

    On This Page

    Properties
    Accessors
    Methods