Taxonomieauswahlkomponente im Microsoft Graph-Toolkit

Artikel
11/07/2024

Die Taxonomieauswahl ist eine Komponente, die die Microsoft Graph-API für Taxonomie abfragen und ein Dropdown-Steuerelement mit Begriffen rendern kann, was die Auswahl eines einzelnen Ausdrucks basierend auf dem angegebenen Ausdruckssatz id oder einer Kombination aus dem angegebenen Ausdruckssatz id und dem angegebenen Ausdruck idermöglicht.

Die Komponente ruft die Begriffe der ersten Ebene ab, die unter einem angegebenen Ausdruckssatz oder Ausdruck vorhanden sind. Wenn nur die Ausdruckssatz-ID angegeben wird, werden die Begriffe der ersten Ebene unter diesem Ausdruckssatz zurückgegeben. Wenn sowohl die Ausdruckssatz-ID als auch die Ausdrucks-ID angegeben werden, werden die Begriffe der ersten Ebene unter dem angegebenen Ausdruck zurückgegeben.

Hinweis Diese Funktion unterstützt derzeit eine einzelne Auswahl von Begriffen aus dem Terminologiespeicher.

Beispiel

Das folgende Beispiel zeigt die Verwendung der mgt-taxonomy-picker -Komponente zum Auswählen eines Ausdrucks aus einem Ausdruckssatz.

HTML
React

Öffnen Sie dieses Beispiel in mgt.dev.

Eigenschaften und Attribute

Sie können mehrere Attribute verwenden, um das Verhalten der Komponente zu ändern. Das erforderliche Attribut ist term-set-id.

Attribut	Eigenschaft	Beschreibung	Typ
Ausdruckssatz-ID	termsetId	Obligatorisch. Die ID des Ausdruckssatzes, aus dem Begriffe der ersten Ebene abgerufen werden sollen.	String
Term-ID	termId	Optional. Die ID des Begriffs, aus dem Begriffe der ersten Ebene abgerufen werden sollen. Falls nicht angegeben, ruft die Funktion die Begriffe der ersten Ebene unter dem durch `term-set-id`angegebenen Ausdruckssatz ab. Beachten Sie , dass dieser Ausdruck einer der Begriffe unter dem Ausdruckssatz mit der ID `term-set-id`sein muss.	String
Site-ID	siteId	Optional. Die ID der Website, auf der der Ausdruckssatz vorhanden ist. Wenn nicht angegeben, wird davon ausgegangen, dass sich der Ausdruckssatz auf Mandantenebene befindet.	String
Version	Version	Optional. API-Version, die beim Ausführen der GET-Anforderung verwendet werden soll. Der Standardwert ist `beta`.	String
Platzhalter	Platzhalter	Optional. Der Platzhalter, der im Kombinationsfeld verwendet werden soll. Der Standardwert ist `Select a term`.	string
Gebietsschema	Gebietsschema	Optional. Das Gebietsschema der Begriffe, die angezeigt werden müssen. Dies ist nur nützlich, wenn Begriffe mehrere Bezeichnungen in verschiedenen Sprachen haben.	String
default-selected-term-id	defaultSelectedTermId	Optional. Die ID des Ausdrucks, der standardmäßig ausgewählt werden soll.	String
position	position	Optional. Die Position der Dropdownliste. Kann "oben" oder "unten" sein. Standard ist `below`	String
deaktiviert	deaktiviert	Optional. Legt fest, ob die Taxonomieauswahl deaktiviert ist. Wenn diese Option deaktiviert ist, kann der Benutzer keine Begriffe suchen oder auswählen.	–
Cache aktiviert	cacheEnabled	Optional. Wenn festgelegt, gibt dies an, dass die Antwort von der Ressource zwischengespeichert wird. Der Standardwert ist `false`.	Boolescher Wert
Cache-Invalidation-Zeitraum	cacheInvalidationPeriod	Optional. (Anzahl der Millisekunden) Wenn in Kombination mit `cacheEnabled`festgelegt wird, wird die Verzögerung, bevor der Cache seinen Gültigkeitszeitraum für die Ungültigkeit erreicht, durch diesen Wert geändert. Der Standardwert ist `0` und verwendet den Standardvalidierungszeitraum.	Zahl

Im folgenden Beispiel wird das Verhalten der Komponente geändert, um untergeordnete Ausdrücke der ersten Ebene des angegebenen Ausdruckssatzes abzurufen.

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

Im folgenden Beispiel wird das Verhalten der Komponente so geändert, dass untergeordnete Ausdrücke der ersten Ebene des angegebenen Ausdrucks abgerufen werden.

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

Im folgenden Beispiel wird das Verhalten der Komponente geändert, um die französischen Bezeichnungen der untergeordneten Begriffe der ersten Ebene des angegebenen Ausdrucks abzurufen.

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

Im folgenden Beispiel wird das Verhalten der Komponente so geändert, dass untergeordnete Ausdrücke der ersten Ebene eines angegebenen Ausdruckssatzes abgerufen werden, der an einer angegebenen Website vorhanden ist.

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

Im folgenden Beispiel wird das Verhalten der Komponente geändert, um untergeordnete Ausdrücke des angegebenen Ausdruckssatzes der ersten Ebene abzurufen, und legt fest, dass ein angegebener Ausdruck standardmäßig ausgewählt wird.

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

Benutzerdefinierte CSS-Eigenschaften

Die mgt-taxonomy-picker Komponente definiert die folgenden benutzerdefinierten CSS-Eigenschaften, mit denen Sie Außerkraftsetzungen bereitstellen können.

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

Weitere Informationen finden Sie unter Formatieren von Komponenten.

Methoden

Methode	Beschreibung
refresh(force?:boolean)	Rufen Sie die -Methode auf, um die Daten zu aktualisieren. Standardmäßig wird die Benutzeroberfläche nur aktualisiert, wenn sich die Daten ändern. Übergeben, `true` um die Aktualisierung der Komponente zu erzwingen.

Ereignisse

Ereignis	Wann wird es ausgegeben?	Benutzerdefinierte Daten	Abbrechbare	Blasen	Funktioniert mit benutzerdefinierter Vorlage
`selectionChanged`	Wird ausgelöst, wenn der Benutzer eine Änderung an der Auswahl in der Dropdownliste vornimmt.	Der ausgewählte Ausdruck, der vom Typ ist `TermStore.Term`	Nein	Ja	Ja

Weitere Informationen zum Behandeln von Ereignissen finden Sie unter Ereignisse.

Vorlagen

Die mgt-taxonomy-picker Komponente unterstützt mehrere Vorlagen , mit denen Sie das Aussehen und Verhalten definieren können. Um eine Vorlage anzugeben, schließen Sie ein <template> Element in eine Komponente ein, und legen Sie auf data-type einen der folgenden Werte fest.

Datentyp	Datenkontext	Beschreibung
error	Der Fehler von Microsoft Graph.	Diese Vorlage wird verwendet, wenn bei der Anforderung ein Fehler auftritt.
Laden	Nicht zutreffend	Diese Vorlage wird während der Anforderung verwendet.
Keine Daten	Nicht zutreffend	Diese Vorlage wird verwendet, wenn die Anforderung keine Daten zurückgibt.

Beispiel für die Verwendung von Vorlagen

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

Diese Komponente verwendet die folgenden Microsoft Graph-APIs und -Berechtigungen. Für jede aufgerufene API muss der Benutzer mindestens über eine der aufgeführten Berechtigungen verfügen.

Konfiguration	Berechtigung	API
Standard	TermStore.Read.All, TermStore.ReadWrite.All	/termStore/sets/{setId}/children
Standard	TermStore.Read.All, TermStore.ReadWrite.All	/termStore/sets/{setId}/terms/{termId}/children
`site-id` ist festgelegt.	TermStore.Read.All, TermStore.ReadWrite.All	/sites/{site-id}/termStore/sets/{set-id}/children
`site-id` ist festgelegt.	TermStore.Read.All, TermStore.ReadWrite.All	/sites/{site-id}/termStore/sets/{set-id}/terms/{term-id}/children

Weitere Informationen zu Berechtigungen finden Sie in der Referenz zu Microsoft Graph-Berechtigungen.

Authentifizierung

Das Steuerelement verwendet den in der Authentifizierungsdokumentation beschriebenen globalen Authentifizierungsanbieter, um die erforderlichen Daten abzurufen.

Cache

Verwenden Sie zum Aktivieren und Konfigurieren des Caches die cacheEnabled Eigenschaften und cacheInvalidationPeriod . Standardmäßig speichert die mgt-taxonomy-picker Komponente keine Antworten zwischen.

Objektspeicher	Zwischengespeicherte Daten	Bemerkungen
`response`	Vollständige Antwort, die von Microsoft Graph für die Begriffe abgerufen wurde.

Weitere Informationen finden Sie unter Zwischenspeichern.

Lokalisierung

Das -Steuerelement macht die folgenden Variablen verfügbar, die lokalisiert werden können. Ausführliche Informationen zum Einrichten der Lokalisierung finden Sie unter Lokalisieren von Komponenten.

Zeichenfolgenname	Standardwert
comboboxPlaceholder	`Select a term`
loadingMessage	`Loading...`
noTermsFound	`No terms found`
termsetIdRequired	`The termsetId property or termset-id attribute is required`

Freigeben über