Класс AbstractSearchColumnsStore

Класс абстрактной колонки поиска

Реализует

IAbstractSearchColumnStore

Конструкторы

`Protected`constructor

new AbstractSearchColumnsStore(
searchVisibleSettingsKey: string,
): AbstractSearchColumnsStore
Параметры
- searchVisibleSettingsKey: string
Возвращает AbstractSearchColumnsStore

Свойства

changeAttributeOrder

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

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

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

- (index: number, newIndex?: number): void
- Параметры
  - index: number
    порядковый номер элемента, который нужно изменить
  - OptionalnewIndex: number
    порядковый номер на который нужно заменить
  Возвращает void

`Protected` `Readonly`columnsModelCollection

columnsModelCollection: ModelCollection<ISearchColumn>

columnsSort

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

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

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

- (a: ISearchColumn, b: ISearchColumn): number
- Параметры
  - a: ISearchColumn
    первый элемент для сравнения
  - b: ISearchColumn
    второй элемент для сравнения
  Возвращает number

isMultiLine

isMultiLine: boolean

Параметр регулирующий многострочность ячейки

isSortingApplied

isSortingApplied: (sort: ISortField[]) => boolean

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

loadSettings

loadSettings: (initColumns?: boolean) => Promise<void>

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

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

- (initColumns?: boolean): Promise<void>
- Параметры
  - OptionalinitColumns: boolean
    флаг отвечающий за задание начальных данных
  Возвращает Promise<void>

resetAllSettings

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

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

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

- (asDefaults?: boolean): Promise<void>
- Параметры
  - OptionalasDefaults: boolean
    флаг отвечающий за сброс настроек к настройкам по умолчанию
  Возвращает Promise<void>

`Protected` `Readonly`rowHeights

rowHeights: Map<string, number>

`Protected` `Readonly`rowWidths

rowWidths: Map<string, number>

saveAllSettings

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

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

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

- (sort: ISortField[], asDefaults?: boolean): Promise<void>
- Параметры
  - sort: ISortField[]
    сортировки, которые необходимо сохранить
  - OptionalasDefaults: boolean
    флаг отвечающий за сохранение по умолчанию
  Возвращает Promise<void>

`Protected`saveSettings

saveSettings: (
settingsToSave?: ISavedSettings,
asDefaults?: boolean,
) => Promise<void>

setAllAttributesVisible

setAllAttributesVisible: (value: boolean) => void

Метод, который делает все атрибуты видимыми

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

- (value: boolean): void
- Параметры
  - value: boolean
    флаг, отвечающий за задание всех атрибутов по умолчанию
  Возвращает void

setMultiLineFlag

setMultiLineFlag: (isMultiLine: boolean) => void

Метод для изменения параметра isMultiline

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

- (isMultiLine: boolean): void
- Параметры
  - isMultiLine: boolean
    флаг показывающий включен ли многострочный режим
  Возвращает void

Акцессоры

canReset

get canReset(): boolean
Геттер флага, который показывает можно ли сбросить параметры отображения

Возвращает boolean
Реализация IAbstractSearchColumnStore.canReset

canResetDefault

get canResetDefault(): boolean
Геттер проверки можно ли сбросить настройки отображения в настройки по умолчанию

Возвращает boolean
Реализация IAbstractSearchColumnStore.canResetDefault

columns

get columns(): ISearchColumn[]
Геттер получения всех колонок

Возвращает ISearchColumn[]
Реализация IAbstractSearchColumnStore.columns

isAttributesDirty

get isAttributesDirty(): boolean
Геттер проверки были ли изменены атрибуты

Возвращает boolean
Реализация IAbstractSearchColumnStore.isAttributesDirty

isMultiLineDirty

get isMultiLineDirty(): boolean
Геттер проверки был ли изменен параметр isMultiLine

Возвращает boolean
Реализация IAbstractSearchColumnStore.isMultiLineDirty

isRowSizeDirty

get isRowSizeDirty(): boolean | undefined
Геттер определяющий, изменился ли размер строки

Возвращает boolean | undefined
Реализация IAbstractSearchColumnStore.isRowSizeDirty

savedSettings

get savedSettings(): ISavedSettings | undefined
Геттер для получения сохраненных настроек

Возвращает ISavedSettings | undefined
Реализация IAbstractSearchColumnStore.savedSettings

savedSortSettings

get savedSortSettings(): ISortField[]
Геттер для получения сортировки колонок

Возвращает ISortField[]
Реализация IAbstractSearchColumnStore.savedSortSettings

savedVisibleSettings

get savedVisibleSettings(): Partial<
Pick<GetTypes<SearchColumn>, GetNames<SearchColumn>>,
>[]
Геттер получения сохраненных настроек видимости колонок

Возвращает Partial<Pick<GetTypes<SearchColumn>, GetNames<SearchColumn>>>[]
Реализация IAbstractSearchColumnStore.savedVisibleSettings

tableRowHeights

get tableRowHeights(): { [k: string]: number }
Геттер получения высоты строк

Возвращает { [k: string]: number }
Реализация IAbstractSearchColumnStore.tableRowHeights

tableRowWidths

get tableRowWidths(): { [k: string]: number }
Геттер получения ширины строк

Возвращает { [k: string]: number }
Реализация IAbstractSearchColumnStore.tableRowWidths

Методы

findColumnById

findColumnById(columnId: string): ISearchColumn | undefined
Метод для поиска колонки по id
Параметры
- columnId: string
Возвращает ISearchColumn | undefined
Реализация IAbstractSearchColumnStore.findColumnById

`Protected`getAttribute

getAttribute(name: string): ISearchColumn | undefined
Параметры
- name: string
Возвращает ISearchColumn | undefined

getTableColumns

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; })
)[]
Метод получения колонок таблицы
Параметры типа
- 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; })
  функция, которая позволяет изменять колонку
- OptionalinitColumns: (
  | TableColumnWithoutData<T, undefined>
  | (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
  )[]
  колонки по умолчанию
Возвращает (
| TableColumnWithoutData<T, undefined>
| (TableColumnWithoutData<T, ISearchColumn> & { data: ISearchColumn; })
)[]
Реализация IAbstractSearchColumnStore.getTableColumns

`Protected` `Abstract`mapAttributesToColumns

mapAttributesToColumns(): ISearchColumn[]
Возвращает ISearchColumn[]

`Protected`parseBackendStorageResponse

parseBackendStorageResponse(
records?: IBackendStorageRecord[],
): ISavedSettings | undefined
Параметры
- Optionalrecords: IBackendStorageRecord[]
Возвращает ISavedSettings | undefined

resetColumnHeights

resetColumnHeights(): void
Метод для сбрасывания высоты колонок

Возвращает void
Реализация IAbstractSearchColumnStore.resetColumnHeights

resetColumnWidths

resetColumnWidths(): void
Метод для сбрасывания ширины колонок

Возвращает void
Реализация IAbstractSearchColumnStore.resetColumnWidths

resetRowHeights

resetRowHeights(): void
Метод для сбрасывания высоты строк

Возвращает void
Реализация IAbstractSearchColumnStore.resetRowHeights

resetRowWidths

resetRowWidths(): void
Метод для сбрасывания ширины строк

Возвращает void
Реализация IAbstractSearchColumnStore.resetRowWidths

`Protected`setInitData

setInitData(): void
Возвращает void

updateRowHeights

updateRowHeights(values: [string, number][]): void
Метод, который обновить высоту строк
Параметры
- values: [string, number][]
  новые значения высоты строк
Возвращает void
Реализация IAbstractSearchColumnStore.updateRowHeights

updateRowWidths

updateRowWidths(values: [string, number][]): void
Метод, который обновляет высоту строки
Параметры
- values: [string, number][]
  новые значения ширины строк
Возвращает void
Реализация IAbstractSearchColumnStore.updateRowWidths

Класс AbstractSearchColumnsStore

Реализует

Индекс

Конструкторы

Свойства

Акцессоры

Методы

Конструкторы

Protectedconstructor

Параметры

Возвращает AbstractSearchColumnsStore

Свойства

changeAttributeOrder

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

Параметры

Возвращает void

Protected ReadonlycolumnsModelCollection

columnsSort

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

Параметры

Возвращает number

isMultiLine

isSortingApplied

loadSettings

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

Параметры

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

resetAllSettings

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

Параметры

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

Protected ReadonlyrowHeights

Protected ReadonlyrowWidths

saveAllSettings

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

Параметры

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

ProtectedsaveSettings

setAllAttributesVisible

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

Параметры

Возвращает void

setMultiLineFlag

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

Параметры

Возвращает void

Акцессоры

canReset

Возвращает boolean

canResetDefault

Возвращает boolean

columns

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

isAttributesDirty

Возвращает boolean

isMultiLineDirty

Возвращает boolean

isRowSizeDirty

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

savedSettings

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

savedSortSettings

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

savedVisibleSettings

Возвращает Partial<Pick<GetTypes<SearchColumn>, GetNames<SearchColumn>>>[]

tableRowHeights

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

tableRowWidths

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

Методы

findColumnById

Параметры

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

ProtectedgetAttribute

Параметры

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

getTableColumns

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

Параметры

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

`Protected`constructor

`Protected` `Readonly`columnsModelCollection

`Protected` `Readonly`rowHeights

`Protected` `Readonly`rowWidths

`Protected`saveSettings

`Protected`getAttribute

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

`Protected` `Abstract`mapAttributesToColumns

`Protected`parseBackendStorageResponse

`Protected`setInitData