Компонент средства выбора таксономии в наборе средств Microsoft Graph
Средство выбора таксономии — это компонент, который может запрашивать microsoft API Graph для таксономии и отображать раскрывающийся элемент управления с терминами, что позволяет выбрать один термин на основе указанного набора терминов id или сочетание указанного набора терминов id и указанного термина id.
Компонент извлекает термины первого уровня, которые присутствуют в указанном наборе терминов или термине. Если указан только идентификатор набора терминов, он возвращает термины первого уровня в этом наборе терминов. Если указаны идентификатор набора терминов и идентификатор термина, он возвращает термины первого уровня для указанного термина.
Примечание В настоящее время эта возможность поддерживает один выбор терминов, поступающих из хранилища терминов.
Пример
В следующем примере показано использование компонента для mgt-taxonomy-picker выбора термина из набора терминов.
Свойства и атрибуты
Чтобы изменить поведение компонента, можно использовать несколько атрибутов. Обязательный атрибут — term-set-id.
| Атрибут | Свойство | Описание | Тип |
|---|---|---|---|
| term-set-id | termsetId | Обязательным. Идентификатор набора терминов, из которого извлекаются термины первого уровня. | String |
| term-id | termId | Необязательный параметр. Идентификатор термина, из которого извлекаются термины первого уровня. Если этот параметр не указан, функция извлекает термины первого уровня в наборе терминов, заданных параметром term-set-id. Обратите внимание , что этот термин должен быть одним из терминов, заданных с идентификатором term-set-id. |
String |
| идентификатор сайта | siteId | Необязательный параметр. Идентификатор сайта, на котором присутствует набор терминов. Если этот параметр не указан, предполагается, что набор терминов находится на уровне клиента. | String |
| version | version | Необязательный параметр. Версия API, используемая при выполнении запроса GET. Значение по умолчанию: beta. |
String |
| placeholder | placeholder | Необязательный параметр. Заполнитель, используемый в поле со списком. Значение по умолчанию — Select a term. |
string |
| языковые стандарты | языковые стандарты | Необязательный параметр. Языковой стандарт терминов, которые необходимо отобразить. Это полезно, только если термины имеют несколько меток на разных языках. | String |
| default-selected-term-id | defaultSelectedTermId | Необязательный параметр. Идентификатор термина, который должен быть выбран по умолчанию. | String |
| position | position | Необязательный параметр. Позиция раскрывающегося списка. Может быть "выше" или "ниже". Значение по умолчанию: below |
String |
| отключено | отключено | Необязательный параметр. Задает, отключается ли средство выбора таксономии. Если этот параметр отключен, пользователь не сможет искать или выбирать термины. | Н/Д |
| cache-enabled | cacheEnabled | Необязательный параметр. При активации указывает на то, что ответ ресурса будет кэшироваться. Значение по умолчанию: false. |
Boolean |
| cache-invalidation-period | cacheInvalidationPeriod | Необязательный параметр. (Количество миллисекундах) Если задано в сочетании с cacheEnabled, задержка до того, как кэш достигнет своего периода недействительности, будет изменена этим значением. Значение по умолчанию 0. Используется период аннулирования по умолчанию. |
Номер |
В следующем примере изменяется поведение компонента для получения дочерних терминов первого уровня указанного набора терминов.
<mgt-taxonomy-picker
term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
></mgt-taxonomy-picker>
В следующем примере изменяется поведение компонента, чтобы получить дочерние термины первого уровня указанного термина.
<mgt-taxonomy-picker
term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
term-id="a56caeb7-3b7d-4d22-93a9-0232e12905f6"
></mgt-taxonomy-picker>
В следующем примере изменяется поведение компонента, чтобы получить французские метки дочерних терминов первого уровня указанного термина.
<mgt-taxonomy-picker
term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
term-id="a56caeb7-3b7d-4d22-93a9-0232e12905f6"
locale="fr-FR"
></mgt-taxonomy-picker>
В следующем примере изменяется поведение компонента, чтобы получить дочерние термины первого уровня указанного набора терминов, который присутствует на указанном сайте.
<mgt-taxonomy-picker
term-set-id="7889007a-fb0e-449f-b629-dedf63ae53de"
site-id="contoso.sharepoint.com,0962bcef-48f1-4460-baa8-b7286dcb249b,ba412b3c-951a-4322-ac37-0fe6307b5987"
></mgt-taxonomy-picker>
В следующем примере изменяется поведение компонента, чтобы получить дочерние термины первого уровня указанного набора терминов и задает указанный термин, который будет выбран по умолчанию.
<mgt-taxonomy-picker
term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
default-selected-term-id="7ab1d163-f691-4676-88b3-c2d8921b73eb"
></mgt-taxonomy-picker>
Настраиваемые свойства CSS
Компонент mgt-taxonomy-picker определяет следующие настраиваемые свойства CSS для предоставления переопределений.
<mgt-taxonomy-picker
class="taxonomy-picker"
term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
></mgt-taxonomy-picker>
.taxonomy-picker {
--taxonomy-picker-background-color: grey;
--taxonomy-picker-list-max-height: 200px;
--taxonomy-picker-background-color: black;
--taxonomy-picker-placeholder-color: white;
}
Дополнительные сведения см. в статье Компоненты стиля.
Методы
| Метод | Описание |
|---|---|
| refresh(force?:boolean) | Вызов метода для обновления данных. По умолчанию в пользовательском интерфейсе будет обновляться только в том случае, если данные изменяются. Передайте true для принудительного обновления компонента. |
События
| Событие | Когда он генерируется | Пользовательские данные | Отменяемым | Пузыри | Работает с пользовательским шаблоном |
|---|---|---|---|---|---|
selectionChanged |
Срабатывает, когда пользователь вносит изменения в выбор в раскрывающемся списке. | Выбранный термин типа TermStore.Term |
Нет | Да | Да |
Дополнительные сведения об обработке событий см. в разделе События.
Шаблоны
Компонент mgt-taxonomy-picker поддерживает несколько шаблонов, с помощью которых можно определить внешний вид и удобство использования. Чтобы указать шаблон, включите <template> элемент внутри компонента и задайте для data-type параметра одно из следующих значений.
| Тип данных | Контекст данных | Описание |
|---|---|---|
| error | Ошибка из Microsoft Graph. | Этот шаблон используется при возникновении ошибки при выполнении запроса. |
| loading | Н/Д | Этот шаблон используется во время выполнения запроса. |
| no-data | Н/Д | Этот шаблон используется, когда запрос не возвращает данных. |
Пример использования шаблона
<mgt-taxonomy-picker term-set-id="138a652e-7f23-46f6-b480-13da2308c235">
<div>Loading template</div>
<template data-type="loading">
Loading
</template>
<template data-type="no-data">
<div>No data</div>
</template>
<template data-type="error">
<div>Error</div>
</template>
</div>
</mgt-taxonomy-picker>
Разрешения Microsoft Graph
Этот компонент использует следующие API и разрешения Microsoft Graph. Для каждого вызываемого API пользователь должен иметь по крайней мере одно из указанных разрешений.
| Конфигурация | Разрешение | API |
|---|---|---|
| default | TermStore.Read.All, TermStore.ReadWrite.All | /termStore/sets/{setId}/children |
| default | TermStore.Read.All, TermStore.ReadWrite.All | /termStore/sets/{setId}/terms/{termId}/children |
site-id задано |
TermStore.Read.All, TermStore.ReadWrite.All | /sites/{site-id}/termStore/sets/{set-id}/children |
site-id задано |
TermStore.Read.All, TermStore.ReadWrite.All | /sites/{site-id}/termStore/sets/{set-id}/terms/{term-id}/children |
Дополнительные сведения о разрешениях см. в справочнике по разрешениям Microsoft Graph.
Проверка подлинности
Для получения требуемых данных в средстве управления используется глобальный поставщик проверки подлинности, указанный в документации по проверке подлинности.
Кэш
Чтобы включить и настроить кэш, используйте cacheEnabled свойства и cacheInvalidationPeriod . По умолчанию mgt-taxonomy-picker компонент не кэширует ответы.
| Хранилище объектов | Кэшированные данные | Замечания |
|---|---|---|
response |
Полный ответ, полученный из Microsoft Graph для терминов. |
Дополнительные сведения см. в разделе Кэширование.
Локализация
Элемент управления предоставляет следующие переменные, которые можно локализовать. Дополнительные сведения о настройке локализации см. в разделе Локализация компонентов.
| Имя строки | Значение по умолчанию |
|---|---|
| comboboxPlaceholder | Select a term |
| loadingMessage | Loading... |
| noTermsFound | No terms found |
| termsetIdRequired | The termsetId property or termset-id attribute is required |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по