$k. Folder

new Folder()

A folder which can contain queries, topic collections and other folders

Extends

Methods

createSemanticCollection(name) → {$k.SemanticCollection}

Creates a semantic collection and adds it to this folder

Parameters:
NameTypeDescription
namestring

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)

See
  • setId

elements() → {Array.<object>}

Returns the elements of the collection

Returns:
Type: 
Array.<object>

id() → {string}

Returns the registered ID, or undefined if not registered.

Inherited From
Returns:
Type: 
string

leafElements() → {Array.<object>}

Returns the elements which are not folders

Returns:
Type: 
Array.<object>

name() → {string}

Returns the name

Returns:
Type: 
string

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

Returns the folders that contain this element

Returns:
Type: 
Array.<$k.Folder>

registryType() → {string}

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

Returns:
Type: 
string

setId(id, replaceScriptReferences)

Registers the element with the given ID. If the element has already been registered, then the id changes. If the id is undefined, then the element will be deregistered.

Parameters:
NameTypeDescription
idstring

The ID

replaceScriptReferencesboolean

True if ID references in scripts should be replaced. Only done when the old and the new ID is not undefined.

subfolders() → {Array.<object>}

Returns the subfolders

Returns:
Type: 
Array.<object>