Compartilhar via

Componente do seletor de taxonomia no Microsoft Graph Toolkit

Cuidado

O Toolkit do Microsoft Graph foi preterido. O período de reforma começa a 1 de setembro de 2025, com a reforma completa prevista para 28 de agosto de 2026. Os programadores devem migrar para utilizar os SDKs do Microsoft Graph ou outras ferramentas suportadas do Microsoft Graph para criar experiências Web. Para obter mais informações, veja o anúncio de preterição.

O seletor de taxonomia é um componente que pode consultar o microsoft API do Graph para Taxonomia e compor um controlo pendente com termos, permitindo a seleção de um único termo com base no conjunto id de termos especificado ou uma combinação do conjunto id de termos especificado e do termo idespecificado .

O componente obtém os termos de primeiro nível que estão presentes num conjunto de termos ou termo especificado. Se for fornecido apenas o ID do conjunto de termos, devolve os termos de primeiro nível nesse conjunto de termos. Se o ID do conjunto de termos e o ID do termo forem fornecidos, devolve os termos de primeiro nível no termo especificado.

Nota Atualmente, esta capacidade suporta uma única seleção de termos provenientes do arquivo de termos.

Exemplo

O exemplo seguinte mostra a utilização do mgt-taxonomy-picker componente para selecionar um termo de um conjunto de termos.

Propriedades e atributos

Pode utilizar vários atributos para alterar o comportamento do componente. O atributo necessário é term-set-id.

Atributo Propriedade Descrição Tipo
term-set-id termsetId Obrigatório. O ID do conjunto de termos para obter os termos de primeiro nível. Cadeia de caracteres
term-id termId Opcional. O ID do termo para obter os termos de primeiro nível. Se não for fornecido, a função obtém os termos de primeiro nível no conjunto de termos especificado por term-set-id.
Tenha em atenção que este termo tem de ser um dos termos no conjunto de termos com o ID term-set-id.		 Cadeia de caracteres
site-id siteId Opcional. O ID do site onde o conjunto de termos está presente. Se não for especificado, assume-se que o conjunto de termos está ao nível do inquilino. Cadeia de caracteres
versão versão Opcional. Versão da API a utilizar ao fazer o pedido GET. O padrão é beta. Cadeia de caracteres
marcador de posição marcador de posição Opcional. O marcador de posição a utilizar na caixa de combinação. O valor padrão é Select a term. cadeia de caracteres
localidade localidade Opcional. A região dos termos que têm de ser apresentados. Só é útil quando os termos têm várias etiquetas em idiomas diferentes. Cadeia de caracteres
default-selected-term-id defaultSelectedTermId Opcional. O ID do termo que deve ser selecionado por predefinição. Cadeia de caracteres
position position Opcional. A posição da lista pendente. Pode ser "acima" ou "abaixo". O padrão é below Cadeia de caracteres
desabilitadas desabilitadas Opcional. Define se o seletor de taxonomia está desativado. Quando desativado, o utilizador não consegue procurar ou selecionar termos. NA
com cache ativada cacheEnabled Opcional. Quando definido, indica que a resposta do recurso é colocada em cache. O padrão é false. Booliano
cache-invalidation-period cacheInvalidationPeriod Opcional. (Número de milissegundos) Quando definido em combinação com cacheEnabled, o atraso antes de a cache atingir o respetivo período de invalidação é modificado por este valor. A predefinição é 0 e utiliza o período de invalidação predefinido. Número

O exemplo seguinte altera o comportamento do componente para obter os termos subordinados de primeiro nível do conjunto de termos especificado.

<mgt-taxonomy-picker
  term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
></mgt-taxonomy-picker>

O exemplo seguinte altera o comportamento do componente para obter os termos subordinados de primeiro nível do termo especificado.

<mgt-taxonomy-picker
  term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
  term-id="a56caeb7-3b7d-4d22-93a9-0232e12905f6"
></mgt-taxonomy-picker>

O exemplo seguinte altera o comportamento do componente para obter as etiquetas francesas dos termos subordinados de primeiro nível do termo especificado.

<mgt-taxonomy-picker
  term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
  term-id="a56caeb7-3b7d-4d22-93a9-0232e12905f6"
  locale="fr-FR"
></mgt-taxonomy-picker>

O exemplo seguinte altera o comportamento do componente para obter termos subordinados de primeiro nível do conjunto de termos especificado que está presente num site especificado.

<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>

O exemplo seguinte altera o comportamento do componente para obter os termos subordinados de primeiro nível do conjunto de termos especificado e define um termo especificado para ser selecionado por predefinição.

<mgt-taxonomy-picker
  term-set-id="138a652e-7f23-46f6-b480-13da2308c235"
  default-selected-term-id="7ab1d163-f691-4676-88b3-c2d8921b73eb"
></mgt-taxonomy-picker>

Propriedades personalizadas do CSS

O mgt-taxonomy-picker componente define as seguintes propriedades personalizadas do CSS para fornecer substituições.

<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;
  
}

Para saber mais, veja Componentes de estilo.

Métodos

Método Descrição
refresh(force?:boolean) Chame o método para atualizar os dados. Por predefinição, a IU só é atualizada se os dados forem alterados. Passe true para forçar a atualização do componente.

Eventos

Evento Quando é emitido Dados personalizados Cancelável Bolhas Funciona com um modelo personalizado
selectionChanged Acionado quando o utilizador efetua uma alteração na seleção na lista pendente. O termo selecionado do tipo TermStore.Term Não Sim Sim

Para obter mais informações sobre o processamento de eventos, veja eventos.

Modelos

O mgt-taxonomy-picker componente suporta vários modelos que pode utilizar para definir o aspeto e funcionalidade. Para especificar um modelo, inclua um <template> elemento dentro de um componente e defina como data-type um dos seguintes valores.

Tipo de dados Contexto de dados Descrição
erro O erro do Microsoft Graph. Este modelo é utilizado se ocorrer um erro ao fazer o pedido.
a carregar N/D Este modelo é utilizado enquanto o pedido está a ser feito.
sem dados N/D Este modelo é utilizado quando o pedido não devolveu dados.

Utilização de modelos de exemplo

<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>

Permissões do Microsoft Graph

Este componente utiliza as seguintes APIs e permissões do Microsoft Graph. Para cada API chamada, o utilizador tem de ter, pelo menos, uma das permissões listadas.

Configuração Permissão API
Padrão. TermStore.Read.All, TermStore.ReadWrite.All /termStore/sets/{setId}/children
Padrão. TermStore.Read.All, TermStore.ReadWrite.All /termStore/sets/{setId}/terms/{termId}/children
site-id está definido TermStore.Read.All, TermStore.ReadWrite.All /sites/{site-id}/termStore/sets/{set-id}/children
site-id está definido TermStore.Read.All, TermStore.ReadWrite.All /sites/{site-id}/termStore/sets/{set-id}/terms/{term-id}/children

Para obter mais informações sobre permissões, consulte a referência de permissões do Microsoft Graph.

Autenticação

O controlo utiliza o fornecedor de autenticação global descrito na documentação de autenticação para obter os dados necessários.

Cache

Para ativar e configurar a cache, utilize as cacheEnabled propriedades e cacheInvalidationPeriod . Por predefinição, o mgt-taxonomy-picker componente não coloca em cache quaisquer respostas.

Arquivo de objetos Dados em cache Comentários
response Resposta completa obtida do Microsoft Graph para os termos.

Para obter detalhes, veja Colocação em cache.

Localização

O controlo expõe as seguintes variáveis que podem ser localizadas. Para obter detalhes sobre como configurar a localização, veja Localizar componentes.

Nome da cadeia Valor padrão
comboboxPlaceholder Select a term
loadingMessage Loading...
noTermsFound No terms found
termsetIdRequired The termsetId property or termset-id attribute is required
  • Last updated on