Preparing search index...

    Interface IAbstractSearchColumnStore

    Интерфейс для SearchColumnStores

    interface IAbstractSearchColumnStore {
        changeAttributeOrder: (index: number, newIndex?: number) => void;
        columns: ISearchColumn[];
        columnsSort: (a: ISearchColumn, b: ISearchColumn) => number;
        isAttributesDirty: boolean;
        resetAllSettings: (asDefaults: boolean) => Promise<void>;
        saveAllSettings: (sort: ISortField[], asDefaults: boolean) => Promise<void>;
        savedSortSettings: ISortField[];
        savedVisibleSettings: Partial<
            Pick<GetTypes<SearchColumn>, GetNames<SearchColumn>>,
        >[];
        setAllAttributesVisible: (value: boolean) => void;
        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; }) & { data: ISearchColumn; }
            )
        )[];
        loadSettings(): Promise<void>;
    }

    Implemented by

    Index

    Properties

    changeAttributeOrder columns columnsSort isAttributesDirty resetAllSettings saveAllSettings savedSortSettings savedVisibleSettings setAllAttributesVisible

    Methods

    getTableColumns loadSettings

    Properties

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

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

    Type declaration

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

      • Parameters

        • index: number

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

        • OptionalnewIndex: number

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

        Returns void

    columns: ISearchColumn[]

    Поисковые колонки

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

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

    Type declaration

    isAttributesDirty: boolean

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

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

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

    Type declaration

      • (asDefaults: boolean): Promise<void>

      • Parameters

        • asDefaults: boolean

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

        Returns Promise<void>

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

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

    Type declaration

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

      • Parameters

        • sort: ISortField[]

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

        • asDefaults: boolean

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

        Returns Promise<void>

    savedSortSettings: ISortField[]

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

    savedVisibleSettings: Partial<
        Pick<GetTypes<SearchColumn>, GetNames<SearchColumn>>,
    >[]

    Сохраненные настройки отображения

    setAllAttributesVisible: (value: boolean) => void

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

    Type declaration

      • (value: boolean): void

      • Parameters

        • value: boolean

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

        Returns void

    Methods

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

      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; })
      • initColumns: (
            | TableColumnWithoutData<T, undefined>
            | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
        )[]

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

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

      Returns Promise<void>

    On This Page

    Properties
    Methods