Документация для разработчиков
Темная тема

Класс Item

Класс представляет элемент диалога.

Конструктор

constructor(itemOptions: ItemOptions): Item

Создает объект класса Item. Для добавления элементов в диалог используйте метод dialog.addItem() или опцию items в конструкторе класса Dialog.

itemOptions — опции элемента, которые определяются структурой ItemOptions.

export type ItemOptions = {
	id: number | string,
	entityId: string,
	entityType?: string,
	title?: string | TextNodeOptions,
	subtitle?: string | TextNodeOptions,
	supertitle?: string | TextNodeOptions,
	caption?: string | TextNodeOptions,
	captionOptions?: CaptionOptions,
	avatar?: string,
	avatarOptions?: AvatarOptions,
	textColor?: string,
	link?: string,
	linkTitle?: string | TextNodeOptions,
	badges?: ItemBadgeOptions[],
	badgesOptions?: BadgesOptions,
	tagOptions?: { [key: string]: any },
	tabs?: string[],
	searchable?: boolean,
	saveable?: boolean,
	deselectable?: boolean,
	selected?: boolean,
	hidden?: boolean,
	children?: ItemOptions[],
	nodeOptions?: ItemNodeOptions,
	customData?: { [key: string]: any },
	sort?: number,
};

  • id: number | string

    Идентификатор элемента. Обязательный параметр.


  • entityId: string

    Идентификатор сущности. Обязательный параметр.


  • entityType?: string

    Тип сущности. По умолчанию default.


  • title?: string | TextNodeOptions

    Заголовок элемента.
    Определяется либо строкой, либо структурой TextNodeOptions.
    Если значение не задано, элемент будет выведен с пустым заголовком.


  • subtitle?: string | TextNodeOptions

    Подзаголовок элемента.
    Определяется либо строкой, либо структурой TextNodeOptions. Если значение не задано, подзаголовок будет искаться в настройках сущности.


  • supertitle?: string | TextNodeOptions

    Надзаголовок элемента.
    Определяется либо строкой, либо структурой TextNodeOptions.
    Если значение не задано, надзаголовок будет искаться в настройках сущности.


  • caption?: string | TextNodeOptions

    Подпись элемента. Выводится справа от заголовка.
    Определяется либо строкой, либо структурой TextNodeOptions.
    Если значение не задано, подпись будет искаться в настройках сущности.


  • captionOptions?: CaptionOptions

    Дополнительные настройки подписи элемента. Определяются структурой CaptionOptions.

    export type CaptionOptions = {
    	fitContent: boolean,
    	maxWidth: number | string
    };
    

    • fitContent — если задано значение true, ширина блока с подписью будет определяться шириной текста.
    • maxWidth — максимальная ширина подписи. Определяется в пикселях (задается числом) или с единицей измерения (задается строкой).

    Если значение не задано, настройки будут искаться в настройках сущности.


  • avatar?: string

    Аватар элемента. Указывается либо путь к изображению, либо файл в формате Data URL.
    Если значение не задано, аватар будет искаться в настройках сущности.


  • avatarOptions?: AvatarOptions

    Дополнительные настройки аватара элемента. Определяются структурой AvatarOptions.

    export type AvatarOptions = {
    	bgColor?: string,
    	bgSize?: string,
    	bgImage?: string,
    };
    

    • bgColor — цвет фона аватара. Задается значениями CSS-свойства background-color.
    • bgSize — размер фона аватара. Задается значениями CSS-свойства background-size.
    • bgImage — изображение фона. Задается значениями CSS-свойства background-image.

    Если значение не задано, настройки будут искаться в настройках сущности.


  • textColor?: string

    Цвет текста заголовка. Если значение не задано, цвет текста заголовка будет искаться в настройках сущности.


  • link?: string

    Адрес ссылки "подробнее". Если значение не задано, адрес ссылки будет искаться в настройках сущности.


  • linkTitle?: string | TextNodeOptions

    Заголовок ссылки "подробнее".
    Определяется либо строкой, либо структурой TextNodeOptions.
    Если значение не задано, заголовок ссылки будет искаться в настройках сущности.


  • badges?: ItemBadgeOptions[]

    Массив бейджей элемента.
    Каждый бейдж определяется структурой ItemBadgeOptions.
    Если значение не задано, бейджи будут искаться в настройках сущности.


  • badgesOptions?: BadgesOptions

    Дополнительные настройки для блока с бейджами. Определяются структурой BadgesOptions.

    export type BadgesOptions = {
    	fitContent: boolean,
    	maxWidth: number | string
    };
    

    • fitContent — если задано значение true, ширина блока с бейджами будет определяться шириной всех бейджей.
    • maxWidth — максимальная ширина блока с бейджами. Определяется в пикселях (задается числом) или с единицей измерения (задается строкой).

    Если значение не задано, настройки будут искаться в настройках сущности.


  • tagOptions?: { [key: string]: any }

    Настройки отображения элемента в виджете TagSelector.

    • bgColor — цвет фона.
    • textColor — цвет заголовка.
    • maxWidth — максимальная ширина элемента.
    • fontWeight — начертание шрифта заголовка элемента.
    • avatar — аватар элемента.
    • link — ссылка элемента.
    • title — заголовок элемента.

    Если значение не задано, настройки будут искаться в настройках сущности.


  • tabs?: string | string[]

    Идентификатор или массив идентификаторов вкладок, в которых отобразится элемент. Необязательный параметр. Если привязка к вкладке не указана, элемент все равно можно будет найти через поиск.


  • searchable?: boolean

    Если задано значение false, такой элемент не будет найден в поиске. По умолчанию true.


  • saveable?: boolean

    Если задано значение false, такой элемент не будет сохраняться для вкладки "Последние". По умолчанию true.


  • deselectable?: boolean

    Если задано значение false, то у такого элемента нельзя будет снять выбор. По умолчанию true.


  • selected?: boolean

    Если задано значение true, то элемент будет автоматически выбран. Событие Item:onSelect не происходит в этом случае. По умолчанию false.


  • hidden?: boolean

    Флаг, обозначающий скрытый элемент.


  • children?: ItemOptions[]

    Массив дочерних элементов. Используется для создания древовидной структуры.


  • nodeOptions?: ItemNodeOptions

    Дополнительные настройки для DOM-узла элемента.
    Определяются структурой ItemNodeOptions.


  • customData?: { [key: string]: any }

    Произвольные дополнительные данные элемента.


  • sort?: number

    Индекс сортировки элемента, по которому сортируются элементы на вкладке "Последние", а также в результатах поиска. По умолчанию не задан.

Методы

Метод Описание С версии
getId(): string | number Возвращает идентификатор элемента.
getEntityId(): string Возвращает идентификатор сущности.
getEntity(): Entity Возвращает объект сущности.
getEntityType(): string Возвращает тип сущности. Если тип не был указан, вернет default.
getTitle(): string Возвращает заголовок элемента. Если заголовок не задан, вернет пустую строку.
setTitle(title: ?string | TextNodeOptions): void Устанавливает заголовок элемента.
Заголовок определяется либо строкой, либо структурой TextNodeOptions.
getSubtitle(): ?string Возвращает подзаголовок элемента.
Если для элемента значение не задано, подзаголовок будет искаться в настройках сущности.
setSubtitle(subtitle: ?string | TextNodeOptions): void Устанавливает подзаголовок элемента.
Подзаголовок определяется либо строкой, либо структурой TextNodeOptions.
getSupertitle(): ?string Возвращает надзаголовок элемента.
Если для элемента значение не задано, надзаголовок будет искаться в настройках сущности.
setSupertitle(supertitle: ?string | TextNodeOptions): void Устанавливает надзаголовок элемента.
Надзаголовок определяется либо строкой, либо структурой TextNodeOptions.
getCaption(): ?string Возвращает подпись элемента.
Если для элемента значение не задано, подпись будет искаться в настройках сущности.
setCaption(caption: ?string | TextNodeOptions): void Устанавливает подпись элемента.
Подпись определяется либо строкой, либо структурой TextNodeOptions.
getAvatar(): ?string Возвращает аватар элемента. Если для элемента значение не задано, аватар будет искаться в настройках сущности.
setAvatar(avatar: ?string): void Устанавливает аватар элемента.
Указывается либо путь к изображению, либо файл в формате Data URL.
getAvatarOption(option: $Keys): string | boolean | number | null Возвращает значение опции для настройки аватара элемента.
Название опции option определяется ключами структуры AvatarOptions.
Если для элемента значение не задано, аватар будет искаться в настройках сущности.
21.600.0
setAvatarOption(option: $Keys, value: string | boolean | number | null): void Устанавливает значение опции для аватара элемента.
Название опции option определяется ключами структуры AvatarOptions.
21.600.0
setAvatarOptions(options: AvatarOptions): void Устанавливает дополнительные настройки для аватара элемента.
Настройки опции option определяются структурой AvatarOptions.
21.600.0
getTextColor(): ?string Возвращает цвет текста заголовка.
Если для элемента значение не задано, цвет текста будет искаться в настройках сущности.
setTextColor(textColor: ?string): void Устанавливает цвет текста заголовка.
getLink(): ?string Возвращает адрес ссылки "подробнее".
Если для элемента значение не задано, адрес ссылки будет искаться в настройках сущности.
setLink(link: ?string): void Устанавливает адрес ссылки "подробнее".
getLinkTitle(): ?string Возвращает заголовок ссылки "подробнее".
Если для элемента значение не задано, заголовок ссылки будет искаться в настройках сущности.
setLinkTitle(linkTitle: ?string | TextNodeOptions): void Устанавливает заголовок ссылки "подробнее".
Заголовок определяется либо строкой, либо структурой TextNodeOptions.
getBadges(): ItemBadge[] Возвращает массив бейджей (объекты класса ItemBadge) элемента. Если для элемента значение не задано, бейджи будут искаться в настройках сущности.
setBadges(badges: ?ItemBadgeOptions[]): void Устанавливает бейджи элемента.
Каждый бейдж определяется структурой ItemBadgeOptions.
getDialog(): Dialog Возвращает объект диалога (объект класса Dialog), в который добавлен элемент.
createNode(nodeOptions: ItemNodeOptions): ItemNode Создает новый DOM-узел элемент.
  • nodeOptions — настройки для DOM-узла элемента. Определяются структурой ItemNodeOptions.
removeNode(node: ItemNode): void Удаляет DOM-узел элемента.
getNodes(): Set Возвращает коллекцию DOM-узлов (объекты класса ItemNode).
select(preselectedMode: boolean = false): void Устанавливает выбор на элементе.
deselect(): void Снимает выбор с элемента.
isSelected(): boolean Возвращает true, если элемент выбран.
setSearchable(flag: boolean): void Устанавливает или отменяет участие элемента в поиске.
isSearchable(): boolean Возвращает true, если элемент участвует в поиске.
setSaveable(flag: boolean): void Устанавливает или отменяет запоминание выбора элемента для вкладки "Последние".
isSaveable(): boolean Возвращает true, если выбор элемента запоминается для вкладки "Последние".
setDeselectable(flag: boolean): void Устанавливает или отменяет возможность снять выбор с элемента.
isDeselectable(): boolean Возвращает true, если у элемента можно отменить выбор.
setHidden(flag: boolean): void Устанавливает или отменяет статус "скрытый" у элемента.
isHidden(): boolean Возвращает true, если элемент скрытый.
setSort(sort: ?number): void Устанавливает сортировку элемента.
getSort(): ?number Возвращает сортировку элемента.
resetSearchIndex(): void Сбрасывает поисковый индекс элемента.
getCustomData(): Map Возвращает коллекцию дополнительных данных элемента.
isRendered(): boolean Возвращает true, если элемент был добавлен и отрисован в диалоге.
getTagBgColor(): ?string Возвращает цвет фона для элемента в виджете TagSelector.
getTagTextColor(): ?string Возвращает цвет заголовка для элемента в виджете TagSelector.
getTagMaxWidth(): ?number Возвращает максимальную ширину для элемента в виджете TagSelector.
getTagFontWeight(): ?string Возвращает начертание шрифта для заголовка элемента в виджете TagSelector.
getTagAvatar(): ?string Возвращает аватар для элемента в виджете TagSelector.
getTagLink(): ?string Возвращает адрес ссылки для элемента в виджете TagSelector.

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх