Юниверс DG SDK UI
v2.15.0

Интерфейс 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(): boolean | undefined;
    get savedSettings(): ISavedSettings | undefined;
    get savedSortSettings(): ISortField[];
    get savedVisibleSettings(): Partial<
        Pick<GetTypes<SearchColumn>, GetNames<SearchColumn>>,
    >[];
    get tableRowHeights(): { [p: string]: number };
    get tableRowWidths(): { [p: string]: number };
    findColumnById(columnId: string): ISearchColumn | undefined;
    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;
}

Иерархия (Просмотр сводки)

Реализован в

Индекс

Свойства

changeAttributeOrder columnsSort isMultiLine isSortingApplied loadSettings resetAllSettings saveAllSettings setAllAttributesVisible setMultiLineFlag

Акцессоры

canReset canResetDefault columns isAttributesDirty isMultiLineDirty isRowSizeDirty savedSettings savedSortSettings savedVisibleSettings tableRowHeights tableRowWidths

Методы

findColumnById getTableColumns resetColumnHeights resetColumnWidths resetRowHeights resetRowWidths updateRowHeights updateRowWidths

Свойства

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

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

Объявление типа

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

    • Параметры

      • index: number

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

      • OptionalnewIndex: number

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

      Возвращает void

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

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

Объявление типа

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

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

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

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

Объявление типа

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

    • Параметры

      • OptionalasDefaults: boolean

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

      Возвращает Promise<void>

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

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

Объявление типа

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

    • Параметры

      • sort: ISortField[]

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

      • OptionalasDefaults: boolean

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

      Возвращает Promise<void>

setAllAttributesVisible: (value: boolean) => void

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

Объявление типа

    • (value: boolean): void

    • Параметры

      • value: boolean

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

      Возвращает void

setMultiLineFlag: (isMultiLine: boolean) => void

Акцессоры

  • get canReset(): boolean

    Возвращает boolean

  • get canResetDefault(): boolean

    Возвращает boolean

  • get isAttributesDirty(): boolean

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

    Возвращает boolean

  • get isMultiLineDirty(): boolean

    Возвращает boolean

  • get isRowSizeDirty(): boolean | undefined

    Возвращает boolean | undefined

  • get savedSortSettings(): ISortField[]

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

    Возвращает ISortField[]

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

    Возвращает { [p: string]: number }

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

    Возвращает { [p: string]: number }

Методы

  • Метод для поиска колонки по id

    Параметры

    • columnId: string

    Возвращает ISearchColumn | undefined

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

    Параметры типа

    Параметры

    • 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; })
      )[]

    Возвращает (
        | TableColumnWithoutData<T, undefined>
        | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
    )[]

  • Возвращает void

  • Возвращает void

  • Возвращает void

  • Возвращает void

  • Параметры

    • values: [string, number][]

    Возвращает void

  • Параметры

    • values: [string, number][]

    Возвращает void

© Авторские права 2025, Юниверс Дата.

Настройки

Видимость элементов?

На этой странице

Свойства
Акцессоры
Методы