Класс TagItem
Класс представляет элемент виджета TagSelector.
Конструктор
constructor(tagItemOptions: TagItemOptions)
Создает объект класса TagItem
.
tagItemOptions
— опции элемента виджета TagSelector
, которые определяются структурой TagItemOptions
:
export type TagItemOptions = { id: string, entityId: number | string, entityType?: string, title?: string | TextNodeOptions, avatar?: string, avatarOptions?: AvatarOptions, textColor?: string, bgColor?: string, fontWeight?: string, link?: string, onclick?: Function, maxWidth?: number, deselectable?: boolean, animate?: boolean, customData?: { [key: string]: any } }
id: string
Идентификатор элемента. Обязательный параметр.
entityId: number | string
Идентификатор сущности. Обязательный параметр.
entityType?: string
Тип сущности. По умолчанию
default
.title?: string | TextNodeOptions
Заголовок элемента. Определяется либо строкой, либо структурой TextNodeOptions.
avatar?: string
Аватар элемента. Указывается либо путь к изображению, либо файл в формате Data URL.
Если значение не задано, аватар определяется параметром tagAvatar виджета TagSelector.avatarOptions?: AvatarOptions
Дополнительные настройки аватара элемента.
Определяется структурой AvatarOptions.
Если значение не задано, аватар определяется параметром tagAvatarOptions виджета TagSelector.maxWidth?: number
Определяет максимальную ширину элемента в пикселях.
Если значение не задано, ширина определяется параметром tagMaxWidth виджета TagSelector.textColor?: string
Определяет цвет заголовка элемента.
Если значение не задано, цвет текста определяется параметром tagTextColor виджета TagSelector.bgColor?: string
Определяет цвет фона элемента.
Если значение не задано, цвет фона определяется параметром tagBgColor виджета TagSelector.fontWeight?: string
Определяет начертание шрифта (нормальное или полужирное) для заголовка элемента.
Если значение не задано, начертание шрифта определяется параметром tagFontWeight виджета TagSelector.link?: string
Определяет адрес ссылки для элемента. Если опция задана, элемент будет выведен с помощью тега
<a href="link"></a>
.onclick?:(tag: TagItem) => {}
Задает функцию-обработчик, которая будет вызвана по нажатию на элемент.
deselectable?: boolean
Если задано значение
false
, элемент нельзя удалить из виджета. По умолчаниюtrue
.animate?: boolean
Анимировать добавление элемента в виджет. По умолчанию
true
. Отключать анимацию имеет смысл, когда добавление элемента не связанно с пользовательским действием. Например, когда элементы виджета заранее определены и должны отобразиться мгновенно.customData?: { [key: string]: any }
Произвольные дополнительные данные элемента.
Методы
Метод | Описание | С версии |
---|---|---|
getId(): string | number | Возвращает идентификатор элемента. | |
getEntityId(): string | Возвращает идентификатор сущности. | |
getEntityType(): string | Возвращает тип сущности. Если тип не был указан, вернет default . | |
getSelector(): TagSelector | Возвращает объект виджета TagSelector , в который добавлен элемент. | |
getTitle(): string | Возвращает заголовок элемента. Если заголовок не задан, вернет пустую строку. | |
setTitle(title: string | TextNodeOptions): void | Устанавливает заголовок элемента. Заголовок определяется либо строкой, либо структурой TextNodeOptions. | |
getAvatar(): ?string | Возвращает аватар элемента. | |
setAvatar(avatar: ?string): void | Устанавливает аватар элемента. | |
getAvatarOption(option: $Keys | Возвращает значение опции из настроек аватара.
Название опции option определяется ключами структуры AvatarOptions. | 21.600.0 |
setAvatarOption(option: $Keys | Задает значение опции для настроек аватара.
Название опции option определяется ключами структуры AvatarOptions.
| 21.600.0 |
setAvatarOptions(avatarOptions: AvatarOptions): void | Задает дополнительные настройки аватара.
| 21.600.0 |
getTextColor(): ?string | Возвращает цвет заголовка элемента. | |
setTextColor(textColor: ?string): void | Устанавливает цвет заголовка. | |
getBgColor(): ?string | Возвращает цвет фона элемента. | |
setBgColor(bgColor: ?string): void | Устанавливает цвет фона элемента. | |
getFontWeight(): ?string | Возвращает начертание шрифта (нормальное или полужирное) для заголовка элемента. | |
setFontWeight(fontWeight: ?string): void | Устанавливает начертание шрифта для заголовка элемента. | |
getMaxWidth(): ?number | Возвращает максимальную ширину элемента. | |
setMaxWidth(width: ?number): void | Устанавливает максимальную ширину элемента в пикселях. | |
setDeselectable(flag: boolean): void | Устанавливает или отменяет возможность удалять элемент из виджета. | |
isDeselectable(): boolean | Возвращает false , если элемент нельзя удалить из виджета. | |
getCustomData(): Map | Возвращает дополнительные данные элемента. | |
getLink(): ?string | Возвращает адрес ссылки элемента. | |
isRendered(): boolean | Возвращает true , если элемент добавлен в виджет и отрисован на странице. |
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.