Home > @tridion-sites/models > KeywordCategory
Represents the data of a Category of Keywords.
Signature:
export declare class KeywordCategory extends OrganizationalItem
Extends: OrganizationalItem
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)({ backendModel, allowedParentCategories, keywordMetadataSchema, …orgItemArgs }) | Constructs a new instance of the KeywordCategory class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _backendModel | BackendCategory | ||
| allowedParentCategories | ReadonlyArray<Link> | undefined | <p>Allowed parent Categories.</p><p>Keywords from this Category are allowed to have parent Keywords from the allowed parent categories. Current implementation allows only one parent category. By default when no parent category is set the category itself is added as allowed parent category. Reassign with a new collection when changing or setting a new parent. To remove parent categories reassign with a new collection which contains the Category itself.</p> | |
| description | string | undefined | Description of the Category. | |
| getInternalModel | () => BackendCategory | ||
| isTaxonomyRoot | boolean | Whether the Category is a root Category (i.e. it has no allowed parent Categories other than itself). | |
| keywordMetadataSchema | Link | undefined | Metadata Schema for the Keywords in this Category. | |
| useForIdentification | boolean | <p>Whether the Category can be used for Taxonomy identification.</p><p>Specifies whether to enforce title uniqueness in the whole Blueprint structure on components that are classified with keywords from this Category. For example, Components can be classified by a Keyword if there is no other Component with the same title classified with this Keyword. Can be configurable only on root Categories. Title uniqueness check is performed on a Component with fields that contains a Keyword from the Category with UseForIdentification set to true.</p> | |
| useForNavigation | boolean | Whether the taxonomy in this Category can be published. | |
| xmlName | string | undefined | <p>XML (type) name of the Category.</p><p>Each publication contains a “Categories XSD” in which all Categories and their Keywords are defined. In this Categories XSD, each Category is represented as a complex type with this name.</p><p>The XML name is subject to the restrictions specified for type names in XML Schemas: * The first character must be a letter or an underscore. * Following characters may be letters, digits, underscores, dashes or dots.</p> |