Class: Folder

Extends

$k.PersistentCollection

Methods

createSemanticCollection(name) → {$k.SemanticCollection}

Creates a semantic collection and adds it to this folder

Parameters:

Name	Type	Description
`name`	string	The name of the new semantic collection

Since: 5.3.3

Throws:

If no write transaction is active
Type $k.exception.TransactionError

Returns:

the new semantic collection

Type:: $k.SemanticCollection

deregister()

Deregisters the element. The id will be undefined afterwards. Equivalent to setId(undefined)

Inherited From: $k.RegistryElement#deregister
See: setId

elements() → {Array.<($k.FolderElement|$k.SemanticElement)>}

Returns the elements of the collection

Inherited From: $k.PersistentCollection#elements

Returns:

Type:: Array.<($k.FolderElement|$k.SemanticElement)>

id() → {string|undefined}

Returns the registered ID, or undefined if not registered.

Inherited From: $k.RegistryElement#id

Returns:

Type:: string | undefined

leafElements() → {Array.<($k.FolderElement|$k.SemanticElement)>}

Returns the elements which are not folders

Returns:

Type:: Array.<($k.FolderElement|$k.SemanticElement)>

name() → {string}

Returns the name

Inherited From: $k.PersistentCollection#name

Returns:

Type:: string

parentFolders() → {Array.<$k.Folder>}

Returns the folders that contain this element

Inherited From: $k.FolderElement#parentFolders

Returns:

Type:: Array.<$k.Folder>

registryType() → {string}

Returns the name of the registry that contains elements of this type

Inherited From: $k.RegistryElement#registryType

Returns:

Type:: string

setId(id, replaceScriptReferencesopt)

Registers the element with the given ID. If the element has already been registered, the current ID will be changed to the new ID. If the given ID is undefined or null, the element will be deregistered.

Parameters:

Name	Type	Attributes	Default	Description
`id`	string \| null			The ID to set
`replaceScriptReferences`	boolean	<optional>	false	True if ID references in scripts should be replaced. Only done when the old and the new ID is not undefined.

Inherited From: $k.RegistryElement#setId

subfolders() → {Array.<$k.Folder>}

Returns the subfolders

Returns:

Type:: Array.<$k.Folder>