Класс RegisterAttributeST<ValueType>

Поисковый критерий по атрибуту типа "Ссылка на реестр"

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

ValueType extends STRING | INTEGER = STRING

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

RefAttributeST
- RegisterAttributeST

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

constructor

new RegisterAttributeST<ValueType extends STRING | INTEGER = STRING>(
cfg: IRegisterAttributeST<ValueType>,
): RegisterAttributeST<ValueType>
Параметры типа
- ValueType extends STRING | INTEGER = STRING
Параметры
- cfg: IRegisterAttributeST<ValueType>
Возвращает RegisterAttributeST<ValueType>
Переопределяет RefAttributeST.constructor

Свойства

`Protected`attributeGroupQueryType

attributeGroupQueryType: ATTRIBUTE_GROUP_QUERY_TYPE | undefined

Логический оператор критериев атрибута

`Readonly`attributeName

attributeName: string

`Readonly`displayName

displayName: string

Отображаемое имя абстрактного поискового критерия

`Readonly`entityName

entityName: string

`Protected`errorIndexes

errorIndexes: ObservableSet<number>

handleSearch

handleSearch: () => void

`Protected`hasErrorInner

hasErrorInner: boolean

`Readonly`id

id: string

Идентификатор для поискового критерия

isClientFilteringAllowed

isClientFilteringAllowed: boolean

`Protected`isSupplementary

isSupplementary: boolean

Необходимо использовать attributeGroupQueryType

Устаревший

`Protected`items

items: RefFormField[]

`Readonly`key

key: string

Ключ (путь) абстрактного поискового критерия

`Readonly`namespace

namespace: keyof INamespace

operator

operator: LogicOperator

Логический оператор критериев атрибута

`Readonly`pagination

pagination: PaginationStore

`Optional`parentId

parentId?: string

Идентификатор родителя абстрактного поискового критерия

searchText

searchText: string | undefined

`Readonly`supportedGroupQueryTypes

supportedGroupQueryTypes: Set<ATTRIBUTE_GROUP_QUERY_TYPE>

Список поддерживаемых типов группировок запросов

`Readonly`termGroup

termGroup: keyof ITermsGroup

Поисковая группа абстрактного поискового критерия

toggleOperator

toggleOperator: () => void

Метод переключения оператора

`Protected` `Readonly`type

type: STRING | INTEGER

`Protected` `Static`DEFAULT_LOGIC_OPERATOR

DEFAULT_LOGIC_OPERATOR: LogicOperator

Акцессоры

canBeGroupQuery

get canBeGroupQuery(): boolean
Геттер определяющий может ли терм быть сгруппирован

Возвращает boolean
Наследуется от RefAttributeST.canBeGroupQuery

constructorName

get constructorName(): string
Возвращает string
Переопределяет RefAttributeST.constructorName

currentGroupQueryType

get currentGroupQueryType(): ATTRIBUTE_GROUP_QUERY_TYPE | undefined
Геттер активированного типа группировки критериев

Возвращает ATTRIBUTE_GROUP_QUERY_TYPE | undefined
Наследуется от RefAttributeST.currentGroupQueryType

`Protected`formGroupJsonData

get formGroupJsonData(): {
    formGroups: {
        childGroups: never[];
        formFields: IFormField<string | number | boolean>[];
        groupType: Universe.Platform.Search.GROUP_TYPE;
    }[];
}
Возвращает {
    formGroups: {
        childGroups: never[];
        formFields: IFormField<string | number | boolean>[];
        groupType: Universe.Platform.Search.GROUP_TYPE;
    }[];
}
Наследуется от RefAttributeST.formGroupJsonData

hasError

get hasError(): boolean
Геттер наличия ошибок в поисковом терме

Возвращает boolean
Наследуется от RefAttributeST.hasError

isSupplementaryGroup

get isSupplementaryGroup(): boolean
Необходимо проверять supplementaryGroup посредством currentGroupQueryType

Возвращает boolean
Устаревший
Наследуется от RefAttributeST.isSupplementaryGroup

itemsData

get itemsData(): FIELD_MODEL[]
Геттер критериев терма атрибута

Возвращает FIELD_MODEL[]
Наследуется от RefAttributeST.itemsData

`Protected`itemsJsonData

get itemsJsonData(): { items: IFormField<string | number | boolean>[] }
Возвращает { items: IFormField<string | number | boolean>[] }
Наследуется от RefAttributeST.itemsJsonData

`Protected`supplementaryJsonData

get supplementaryJsonData(): {
    supplementaryGroup: {
        orConnection: boolean;
        queries: { formFields: IFormField<string | number | boolean>[] }[];
    };
}
Возвращает {
    supplementaryGroup: {
        orConnection: boolean;
        queries: { formFields: IFormField<string | number | boolean>[] }[];
    };
}
Наследуется от RefAttributeST.supplementaryJsonData

Методы

addItem

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

Возвращает void
Наследуется от RefAttributeST.addItem

changeItem

changeItem(index: number, data: any, hasError?: boolean): void
Метод замены критерия
Параметры
- index: number
  Индекс критерия для замены
- data: any
  Данные нового критерия
- OptionalhasError: boolean
  Флаг наличия ошибки в новых данных
Возвращает void
Наследуется от RefAttributeST.changeItem

clear

clear(): void
Метод очистки поискового терма

Возвращает void
Переопределяет RefAttributeST.clear

`Protected`createQueryFormGroup

createQueryFormGroup(): AbstractFormGroup
Возвращает AbstractFormGroup
Наследуется от RefAttributeST.createQueryFormGroup

deleteItem

deleteItem(index: number): void
Метод удаления критерия по индексу
Параметры
- index: number
  Индекс удаляемого критерия
Возвращает void
Наследуется от RefAttributeST.deleteItem

enableGroupQuery

enableGroupQuery(groupQueryType?: ATTRIBUTE_GROUP_QUERY_TYPE): void
Метод включения группировки запроса. По умолчанию активируется первый тип группировки из supportedGroupQueryTypes
Параметры
- OptionalgroupQueryType: ATTRIBUTE_GROUP_QUERY_TYPE
  Тип группировки поиска. Если параметр не задан, будет взят первый поддерживаемый тип из supportedGroupQueryTypes
Возвращает void
Наследуется от RefAttributeST.enableGroupQuery

enablePagination

enablePagination(getOptionsFn: RefAttributeSTGetOptionsFn): void
Параметры
- getOptionsFn: RefAttributeSTGetOptionsFn
Возвращает void
Наследуется от RefAttributeST.enablePagination

`Protected`getInitItem

getInitItem(): RefFormField
Возвращает RefFormField
Наследуется от RefAttributeST.getInitItem

getJsonData

getJsonData(): JsonData
Метод получения JSON данных запроса. Результат зависит от currentGroupQueryType

Возвращает JsonData
Переопределяет RefAttributeST.getJsonData

getOptions

getOptions(): SelectOption<SelectSingleValueType>[]
Возвращает SelectOption<SelectSingleValueType>[]
Наследуется от RefAttributeST.getOptions

getQuery

getQuery(): QueryPart
Метод получения данных запроса. Результат зависит от currentGroupQueryType

Возвращает QueryPart
Наследуется от RefAttributeST.getQuery

getValue

getValue(): (SelectOption<SelectSingleValueType> | undefined)[]
Возвращает (SelectOption<SelectSingleValueType> | undefined)[]
Наследуется от RefAttributeST.getValue

setAbstractFormFields

setAbstractFormFields(formFields: IFormField<string | number | boolean>[]): void
Метод установки абстрактных formField-ов.
Параметры
- formFields: IFormField<string | number | boolean>[]
Возвращает void
Наследуется от RefAttributeST.setAbstractFormFields

`Protected`setAttributeGroupQueryType

setAttributeGroupQueryType(queryType: ATTRIBUTE_GROUP_QUERY_TYPE): void
Параметры
- queryType: ATTRIBUTE_GROUP_QUERY_TYPE
Возвращает void
Наследуется от RefAttributeST.setAttributeGroupQueryType

setFormFields

setFormFields(formFields: Partial<IRefFormField>[]): void
Метод установки formField-ов.
Параметры
- formFields: Partial<IRefFormField>[]
Возвращает void
Наследуется от RefAttributeST.setFormFields

`Protected`setHasError

setHasError(hasError: boolean): void
Параметры
- hasError: boolean
Возвращает void
Наследуется от RefAttributeST.setHasError

`Protected`setOperator

setOperator(operator: LogicOperator): void
Параметры
- operator: LogicOperator
Возвращает void
Наследуется от RefAttributeST.setOperator

setParentId

setParentId(parentId: string): void
Метод для задания идентификатора родителя абстрактного поискового критерия
Параметры
- parentId: string
  идентификатор родителя
Возвращает void
Наследуется от RefAttributeST.setParentId

setSearchText

setSearchText(text?: string): void
Параметры
- Optionaltext: string
Возвращает void
Наследуется от RefAttributeST.setSearchText

setSupplementary

setSupplementary(supplementaryGroup: ISearchGroupBase): void
Метод принудительно задаёт ATTRIBUTE_GROUP_QUERY_TYPE.SUPPLEMENTARY поддерживаемым. Необходимо задавать поддерживаемый тип группировки поиска в конструкторе.

Данные из supplementaryGroup необходимо задавать посредством setOperator, setFormFields
Параметры
- supplementaryGroup: ISearchGroupBase
Возвращает void
Устаревший
Наследуется от RefAttributeST.setSupplementary

Класс RegisterAttributeST<ValueType>

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

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

Индекс

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

Свойства

Акцессоры

Методы

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

constructor

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

Параметры

Возвращает RegisterAttributeST<ValueType>

Свойства

ProtectedattributeGroupQueryType

ReadonlyattributeName

ReadonlydisplayName

ReadonlyentityName

ProtectederrorIndexes

handleSearch

ProtectedhasErrorInner

Readonlyid

isClientFilteringAllowed

ProtectedisSupplementary

Устаревший

Protecteditems

Readonlykey

Readonlynamespace

operator

Readonlypagination

OptionalparentId

searchText

ReadonlysupportedGroupQueryTypes

ReadonlytermGroup

toggleOperator

Protected Readonlytype

Protected StaticDEFAULT_LOGIC_OPERATOR

Акцессоры

canBeGroupQuery

Возвращает boolean

constructorName

Возвращает string

currentGroupQueryType

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

ProtectedformGroupJsonData

Возвращает { formGroups: { childGroups: never[]; formFields: IFormField<string | number | boolean>[]; groupType: Universe.Platform.Search.GROUP_TYPE; }[];}

hasError

Возвращает boolean

isSupplementaryGroup

Возвращает boolean

Устаревший

itemsData

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

ProtecteditemsJsonData

Возвращает { items: IFormField<string | number | boolean>[] }

ProtectedsupplementaryJsonData

Возвращает { supplementaryGroup: { orConnection: boolean; queries: { formFields: IFormField<string | number | boolean>[] }[]; };}

Методы

addItem

Возвращает void

changeItem

Параметры

Возвращает void

clear

Возвращает void

ProtectedcreateQueryFormGroup

Возвращает AbstractFormGroup

deleteItem

Параметры

Возвращает void

enableGroupQuery

Параметры

Возвращает void

enablePagination

Параметры

Возвращает void

ProtectedgetInitItem

Возвращает RefFormField

getJsonData

Возвращает JsonData

`Protected`attributeGroupQueryType

`Readonly`attributeName

`Readonly`displayName

`Readonly`entityName

`Protected`errorIndexes

`Protected`hasErrorInner

`Readonly`id

`Protected`isSupplementary

`Protected`items

`Readonly`key

`Readonly`namespace

`Readonly`pagination

`Optional`parentId

`Readonly`supportedGroupQueryTypes

`Readonly`termGroup

`Protected` `Readonly`type

`Protected` `Static`DEFAULT_LOGIC_OPERATOR

`Protected`formGroupJsonData

Возвращает {
formGroups: {
childGroups: never[];
formFields: IFormField<string | number | boolean>[];
groupType: Universe.Platform.Search.GROUP_TYPE;
}[];
}

`Protected`itemsJsonData

`Protected`supplementaryJsonData

Возвращает {
supplementaryGroup: {
orConnection: boolean;
queries: { formFields: IFormField<string | number | boolean>[] }[];
};
}

`Protected`createQueryFormGroup

`Protected`getInitItem

`Protected`setAttributeGroupQueryType

`Protected`setHasError

`Protected`setOperator