visman::components::visman_core::PresetList

Overview

interface PresetList extends Observable

Container managing all Preset objects within a project. Provides functionality for creation, duplication, renaming, deletion and JSON import of presets.

Operation Index

createNew: Creates a new preset with the given name.
createDuplicate: Creates a duplicate of an existing preset, including all its configuration such as viewports, layers and events.
importFromJSON: Imports a preset from a JSON representation.
changePresetName: Changes the name of an existing preset.
deletePreset: Deletes the given preset from the project.
deletePresetByName: Deletes a preset by its name.
asDictionary: Returns all presets as a dictionary.

Operations

Preset* createNew(string name) throws InvalidName, DuplicateEntity

Creates a new preset with the given name.

Parameters

name: Name of the new preset.

Return Value

The newly created Preset instance.

Exceptions

InvalidName: If the provided name does not meet naming rules.
DuplicateEntity: If a preset with the same name already exists.

Preset* createDuplicate(Preset* preset)

Creates a duplicate of an existing preset, including all its configuration such as viewports, layers and events.

Parameters

preset: The preset to duplicate.

Return Value

The newly created duplicate Preset.

Preset* importFromJSON(string json) throws FormatError, DuplicateEntity

Imports a preset from a JSON representation.

Parameters

json: JSON string describing a preset.

Return Value

The imported Preset instance.

Exceptions

FormatError: If the JSON data is malformed or does not match the expected format.
DuplicateEntity: If a preset with the same name already exists.