SettingsManager
cartographer / SettingsManager
Class: SettingsManager
Section titled “Class: SettingsManager”Defined in: config/settingsManager.ts:16
Manages loading, saving, and validating plugin settings
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SettingsManager(
plugin):SettingsManager
Defined in: config/settingsManager.ts:20
Parameters
Section titled “Parameters”plugin
Section titled “plugin”Plugin
Returns
Section titled “Returns”SettingsManager
Methods
Section titled “Methods”loadSettings()
Section titled “loadSettings()”loadSettings():
Promise<DatacoreSettings>
Defined in: config/settingsManager.ts:25
Returns
Section titled “Returns”Promise<DatacoreSettings>
saveSettings()
Section titled “saveSettings()”saveSettings():
Promise<void>
Defined in: config/settingsManager.ts:38
Returns
Section titled “Returns”Promise<void>
getSettings()
Section titled “getSettings()”getSettings():
DatacoreSettings
Defined in: config/settingsManager.ts:42
Returns
Section titled “Returns”setSettings()
Section titled “setSettings()”setSettings(
newSettings):void
Defined in: config/settingsManager.ts:46
Parameters
Section titled “Parameters”newSettings
Section titled “newSettings”Returns
Section titled “Returns”void
addField()
Section titled “addField()”addField(
field):void
Defined in: config/settingsManager.ts:104
Add a custom field to schema
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
removeField()
Section titled “removeField()”removeField(
fieldKey):void
Defined in: config/settingsManager.ts:119
Remove a field from schema
Parameters
Section titled “Parameters”fieldKey
Section titled “fieldKey”string
Returns
Section titled “Returns”void
updateFieldProperties()
Section titled “updateFieldProperties()”updateFieldProperties(
fieldKey,updates):void
Defined in: config/settingsManager.ts:128
Update field visibility, filterability, etc.
Parameters
Section titled “Parameters”fieldKey
Section titled “fieldKey”string
updates
Section titled “updates”Partial<SchemaField>
Returns
Section titled “Returns”void
createLibrary()
Section titled “createLibrary()”createLibrary(
library):Promise<Library>
Defined in: config/settingsManager.ts:142
Create a new library
Parameters
Section titled “Parameters”library
Section titled “library”Omit<Library, "id" | "createdAt">
Returns
Section titled “Returns”Promise<Library>
Throws
Section titled “Throws”Error if vault path does not exist
updateLibrary()
Section titled “updateLibrary()”updateLibrary(
id,updates):void
Defined in: config/settingsManager.ts:163
Update an existing library
Parameters
Section titled “Parameters”string
updates
Section titled “updates”Partial<Library>
Returns
Section titled “Returns”void
deleteLibrary()
Section titled “deleteLibrary()”deleteLibrary(
id):void
Defined in: config/settingsManager.ts:173
Delete a library
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
getLibrary()
Section titled “getLibrary()”getLibrary(
id):Library|null
Defined in: config/settingsManager.ts:183
Get a library by ID
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Library | null
setActiveLibrary()
Section titled “setActiveLibrary()”setActiveLibrary(
id):void
Defined in: config/settingsManager.ts:190
Set the active library
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
getActiveLibrary()
Section titled “getActiveLibrary()”getActiveLibrary():
Library|null
Defined in: config/settingsManager.ts:199
Get the active library
Returns
Section titled “Returns”Library | null