Класс 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

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

Методы