Interface ITaxonomy

Taxonomy Helper

Hierarchy

ITaxonomy

Index

Methods

Methods

findById

findById(term: ITerm, termId: string): ITerm

- Defined in @types/helper/taxonomy.d.ts:16
Method to find a term by id

Parameters
- term: ITerm
  
  The term
- termId: string
  
  The term id to search for
Returns ITerm

findByName

findByName(term: ITerm, termName: string): ITerm

- Defined in @types/helper/taxonomy.d.ts:23
Method to find a term by name

Parameters
- term: ITerm
  
  The term
- termName: string
  
  The term name to search for
Returns ITerm

getTermGroup

getTermGroup(groupName?: string): PromiseLike<{ context: any; termGroup: any }>

- Defined in @types/helper/taxonomy.d.ts:29
Method to get the term group

Parameters
- Optional groupName: string
  
  The group name.
Returns PromiseLike<{ context: any; termGroup: any }>

getTermGroups

getTermGroups(): PromiseLike<Array<ITermGroupInfo>>

- Defined in @types/helper/taxonomy.d.ts:34
Method to get the term groups

Returns PromiseLike<Array<ITermGroupInfo>>

getTermSetByGroupName

getTermSetByGroupName(termSetName: string, groupName: string): PromiseLike<ITerm>

- Defined in @types/helper/taxonomy.d.ts:87
Method to get the term set from the default site collection

Parameters
- termSetName: string
- groupName: string
Returns PromiseLike<ITerm>

getTermSetById

getTermSetById(termStoreId: string, termSetId: string): PromiseLike<ITerm>

- Defined in @types/helper/taxonomy.d.ts:66
Method to get the term set by id

Parameters
- termStoreId: string
  
  The term store guid
- termSetId: string
  
  The term set guid
Returns PromiseLike<ITerm>

getTermSetFromDefaultSC

getTermSetFromDefaultSC(termSetName: string): PromiseLike<ITerm>

- Defined in @types/helper/taxonomy.d.ts:77
Method to get the term set from the default site collection

Parameters
- termSetName: string
Returns PromiseLike<ITerm>

getTermSets

getTermSets(groupName: string): PromiseLike<Array<ITermSetInfo>>

- Defined in @types/helper/taxonomy.d.ts:40
Method to get the term sets for a group

Parameters
- groupName: string
  
  The group name.
Returns PromiseLike<Array<ITermSetInfo>>

getTermSetsFromDefaultSC

getTermSetsFromDefaultSC(): PromiseLike<Array<ITermSetInfo>>

- Defined in @types/helper/taxonomy.d.ts:45
Method to get the term sets for the site collection

Returns PromiseLike<Array<ITermSetInfo>>

getTerms

getTerms(termSet: any, termSetTerms: any): Array<ITermInfo>

- Defined in @types/helper/taxonomy.d.ts:52
Method to get the terms

Parameters
- termSet: any
  
  The term set.
- termSetTerms: any
  
  The term set terms.
Returns Array<ITermInfo>

getTermsByGroupName

getTermsByGroupName(termSetName: string, groupName: string): PromiseLike<Array<ITermInfo>>

- Defined in @types/helper/taxonomy.d.ts:82
Method to get a terms from a specified group

Parameters
- termSetName: string
- groupName: string
Returns PromiseLike<Array<ITermInfo>>

getTermsById

getTermsById(termStoreId: string, termSetId: string): PromiseLike<Array<ITermInfo>>

- Defined in @types/helper/taxonomy.d.ts:59
Method to get the terms by id

Parameters
- termStoreId: string
  
  The term store guid
- termSetId: string
  
  The term set guid
Returns PromiseLike<Array<ITermInfo>>

getTermsFromDefaultSC

getTermsFromDefaultSC(termSetName: string): PromiseLike<Array<ITermInfo>>

- Defined in @types/helper/taxonomy.d.ts:72
Method to get the terms from the default site collection

Parameters
- termSetName: string
  
  The term set name
Returns PromiseLike<Array<ITermInfo>>

loadScripts

loadScripts(): PromiseLike<void>

- Defined in @types/helper/taxonomy.d.ts:92
Method to ensure the taxonomy script references are loaded.

Returns PromiseLike<void>

toArray

toArray(term: ITerm | ITermInfo): Array<ITermInfo>

- Defined in @types/helper/taxonomy.d.ts:98
Method to convert a term set into an array of terms

Parameters
- term: ITerm | ITermInfo
  
  The term
Returns Array<ITermInfo>

toFieldMultiValue

toFieldMultiValue(terms: Array<ITerm | ITermInfo>): any

- Defined in @types/helper/taxonomy.d.ts:110
Method to convert a collection of terms to a field value

Parameters
- terms: Array<ITerm | ITermInfo>
  
  The terms
Returns any

toFieldValue

toFieldValue(term: ITerm | ITermInfo): any

- Defined in @types/helper/taxonomy.d.ts:104
Method to convert a term to a field value

Parameters
- term: ITerm | ITermInfo
  
  The term
Returns any

toObject

toObject(terms: Array<ITermInfo>): ITerm

- Defined in @types/helper/taxonomy.d.ts:116
Method to convert an array of terms into a term set

Parameters
- terms: Array<ITermInfo>
  
  The terms
Returns ITerm

Generated using TypeDoc