Home > @tridion-sites/models > StructureGroup
Organizational Item used to build the Publication’s target structure.
Signature:
export declare class StructureGroup extends OrganizationalItem
Extends: OrganizationalItem
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)({ backendModel, defaultPageTemplate, publishLocationInfo, pageBundleProcess, pageProcess, …orgItemArgs }) | Constructs a new instance of the StructureGroup class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _backendModel | BackendStructureGroup | ||
| defaultPageTemplate | Link | undefined | <p>Default Page Template.</p><p>All items contained in the Structure Group which don’t have a (default) Page Template set explicitly inherit their setting from the Structure Group. The Structure Group itself may inherit its default Page Template setting from its parent (Structure Group or Publication).</p> | |
| directory | string | undefined | <p>Directory name.</p><p>The directory name is the Structure Group’s physical name in the target structure. The directory name is subject to the restrictions of the Windows file system. The directory name of the root Structure Group may be empty.</p> | |
| getInternalModel | () => BackendStructureGroup | ||
| isActive | boolean | <p>Active state of the Structure Group. If the active state is set to false, the Structure Group and the items inside it cannot be published.</p><p>Even if the active state is set to “true”, it is not enough for a Structure Group to be publishable; all of its ancestor Structure Groups must also have the active state set to “true” for that to succeed.</p> | |
| isActiveResolvedValue | boolean | <p>Whether this Structure Group and its items can be published.</p><p>Returns true if the active state of this Structure Group and all of its ancestors is true. Returns false if the active state of this Structure Group or any of its ancestors is false. The individual active state of each Structure Group is represented by the property “isActive”.</p> | |
| isDefaultPageTemplateInherited | boolean | <p>Whether the default Page Template is inherited from the Structure Group’s parent.</p><p>The Structure Group’s parent is the containing Structure Group or the Publication in case of the root Structure Group. Returns “true” if the DefaultPageTemplateInherited property is undefined.</p> | |
| locationInfo | PublishLocationInfo | undefined | <p>Location/context information, including publish location.</p><p>Structure Groups act as a publish location, therefore their LocationInfo property is refined to “PublishLocationInfo”.</p> | |
| pageBundleProcess | Link | undefined | <p>An associated Process Definition which defines the Bundle process for Pages in the Structure Group.</p><p>If a Page Bundle Process is specified, Pages must be added to a Bundle before they can be checked in. The Bundle has to be of an appropriate type. That is: The Bundle’s Schema has to be associated with this Process Definition.</p> | |
| pageProcess | Link | undefined | <p>An associated Process Definition which defines the editing process for Pages in the Structure Group.</p><p>If a Page Process is specified, a workflow process based on this Process Definition will be started when a Page is saved. This process has to be finished before the Page will be checked in. Hence we refer to this as an editing process.</p> |