Class SettingsSchema

Provides methods to access the settings schema

Index

Internal

Other

getDefaultProjectSettings getDefaultProjectUserSettings getDefaultUserSettings

Internal

constructor

new SettingsSchema(schema: Schema): SettingsSchema
Creates new instance of API
Parameters
- schema: Schema
  The schema API
Returns SettingsSchema
- Defined in submodules/editor-api/src/schema/settings.ts:18

Other

getDefaultProjectSettings

getDefaultProjectSettings(): Record<string, any>
Get the default settings for the project

Returns Record<string, any>
The default settings for the project
Example
```
const projectSettings = editor.schema.settings.getDefaultProjectSettings();
```
- Defined in submodules/editor-api/src/schema/settings.ts:53

getDefaultProjectUserSettings

getDefaultProjectUserSettings(): Record<string, any>
Get the default settings for the user in the project

Returns Record<string, any>
The default settings for the user in the project
Example
```
const projectUserSettings = editor.schema.settings.getDefaultProjectUserSettings();
```
- Defined in submodules/editor-api/src/schema/settings.ts:79

getDefaultUserSettings

getDefaultUserSettings(): Record<string, any>
Get the default settings for the user

Returns Record<string, any>
The default settings for the user
Example
```
const userSettings = editor.schema.settings.getDefaultUserSettings();
```
- Defined in submodules/editor-api/src/schema/settings.ts:66