Класс AbstractAttributeST<FIELD_MODEL, FORM_FIELD, FORM_GROUP>

Стор поискового терма абстрактного атрибута

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

FIELD_MODEL extends AbstractFormField
FORM_FIELD extends IFormField = IFormField
FORM_GROUP extends IFormGroup = IFormGroup

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

AbstractSearchTerm
- AbstractAttributeST

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

`Protected`constructor

new AbstractAttributeST<
    FIELD_MODEL extends AbstractFormField<AbstractFormFieldValue>,
    FORM_FIELD extends
        IFormField<string | number | boolean> = IFormField<
        string
        | number
        | boolean,
    >,
    FORM_GROUP extends IFormGroup = IFormGroup,
>(
    data: IAbstractAttribute<FORM_FIELD, FORM_GROUP>,
): AbstractAttributeST<FIELD_MODEL, FORM_FIELD, FORM_GROUP>
Параметры типа
- FIELD_MODEL extends AbstractFormField<AbstractFormFieldValue>
- FORM_FIELD extends IFormField<string | number | boolean> = IFormField<string | number | boolean>
- FORM_GROUP extends IFormGroup = IFormGroup
Параметры
- data: IAbstractAttribute<FORM_FIELD, FORM_GROUP>
Возвращает AbstractAttributeST<FIELD_MODEL, FORM_FIELD, FORM_GROUP>
Переопределяет AbstractSearchTerm.constructor

Свойства

`Protected`attributeGroupQueryType

attributeGroupQueryType: ATTRIBUTE_GROUP_QUERY_TYPE | undefined

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

`Readonly`displayName

displayName: string

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

`Protected`errorIndexes

errorIndexes: ObservableSet<number>

`Protected`hasErrorInner

hasErrorInner: boolean

`Readonly`id

id: string

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

`Protected`isSupplementary

isSupplementary: boolean

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

Устаревший

`Protected`items

items: FIELD_MODEL[]

`Readonly`key

key: string

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

operator

operator: LogicOperator

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

`Optional`parentId

parentId?: string

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

`Readonly`supportedGroupQueryTypes

supportedGroupQueryTypes: Set<ATTRIBUTE_GROUP_QUERY_TYPE>

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

`Readonly`termGroup

termGroup: keyof ITermsGroup

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

toggleOperator

toggleOperator: () => void

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

`Protected`type

type: VALUE_TYPE

`Protected` `Static`DEFAULT_LOGIC_OPERATOR

DEFAULT_LOGIC_OPERATOR: LogicOperator

Акцессоры

canBeGroupQuery

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

Возвращает boolean

`Protected`constructorName

get constructorName(): string
Возвращает string
Наследуется от AbstractSearchTerm.constructorName

currentGroupQueryType

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

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

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

hasError

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

Возвращает boolean
Переопределяет AbstractSearchTerm.hasError

isSupplementaryGroup

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

Возвращает boolean
Устаревший

itemsData

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

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

`Protected`itemsJsonData

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

`Protected`supplementaryJsonData

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

Методы

addItem

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

Возвращает void

changeItem

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

clear

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

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

`Protected`createQueryFormGroup

createQueryFormGroup(): AbstractFormGroup
Возвращает AbstractFormGroup

deleteItem

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

enableGroupQuery

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

`Protected`getInitItem

getInitItem(): FIELD_MODEL
Возвращает FIELD_MODEL

getJsonData

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

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

getQuery

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

Возвращает QueryPart
Переопределяет AbstractSearchTerm.getQuery

setAbstractFormFields

setAbstractFormFields(_formFields: FORM_FIELD[]): void
Метод установки абстрактных formField-ов.
Параметры
- _formFields: FORM_FIELD[]
Возвращает void

`Protected`setAttributeGroupQueryType

setAttributeGroupQueryType(queryType: ATTRIBUTE_GROUP_QUERY_TYPE): void
Параметры
- queryType: ATTRIBUTE_GROUP_QUERY_TYPE
Возвращает void

setFormFields

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

`Protected`setHasError

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

`Protected`setOperator

setOperator(operator: LogicOperator): void
Параметры
- operator: LogicOperator
Возвращает void

setParentId

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

setSupplementary

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

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

Класс AbstractAttributeST<FIELD_MODEL, FORM_FIELD, FORM_GROUP>

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

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

Индекс

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

Свойства

Акцессоры

Методы

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

Protectedconstructor

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

Параметры

Возвращает AbstractAttributeST<FIELD_MODEL, FORM_FIELD, FORM_GROUP>

Свойства

ProtectedattributeGroupQueryType

ReadonlydisplayName

ProtectederrorIndexes

ProtectedhasErrorInner

Readonlyid

ProtectedisSupplementary

Устаревший

Protecteditems

Readonlykey

operator

OptionalparentId

ReadonlysupportedGroupQueryTypes

ReadonlytermGroup

toggleOperator

Protectedtype

Protected StaticDEFAULT_LOGIC_OPERATOR

Акцессоры

canBeGroupQuery

Возвращает boolean

ProtectedconstructorName

Возвращает 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

ProtectedgetInitItem

Возвращает FIELD_MODEL

getJsonData

Возвращает JsonData

getQuery

Возвращает QueryPart

setAbstractFormFields

Параметры

Возвращает void

ProtectedsetAttributeGroupQueryType

Параметры

Возвращает void

setFormFields

Параметры

`Protected`constructor

`Protected`attributeGroupQueryType

`Readonly`displayName

`Protected`errorIndexes

`Protected`hasErrorInner

`Readonly`id

`Protected`isSupplementary

`Protected`items

`Readonly`key

`Optional`parentId

`Readonly`supportedGroupQueryTypes

`Readonly`termGroup

`Protected`type

`Protected` `Static`DEFAULT_LOGIC_OPERATOR

`Protected`constructorName

`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