Skip to main content

Variable: appSettingsSchema

const appSettingsSchema: object

Defined in: src/lib/settings/schema.ts:174

Schema of an app settings file. Parts it doesn't name are added by wrapper apps, which check them (see SettingsExtension), and can publish schemas of their own that extend this one.

Type Declaration​

@type​

readonly @type: "PaintCanvas/AppSettings" = APP_SETTINGS_TYPE

$id​

readonly $id: string

$schema​

readonly $schema: "https://json-schema.org/draft/2020-12/schema" = SCHEMA_DIALECT

properties​

readonly properties: object

properties.@type​

readonly @type: object

properties.@type.const​

readonly const: "PaintCanvas/AppSettings" = APP_SETTINGS_TYPE

properties.$schema​

readonly $schema: object = fileSchemaUrlSchema

properties.$schema.maxLength​

readonly maxLength: 2048 = MAX_URL_LENGTH

properties.$schema.minLength​

readonly minLength: 1 = 1

properties.$schema.type​

readonly type: "string" = "string"

properties.brushes​

readonly brushes: object

properties.brushes.items​

readonly items: object

properties.brushes.items.$ref​

readonly $ref: string = brushPresetSchema.$id

properties.brushes.maxItems​

readonly maxItems: 1000 = MAX_PRESETS_PER_FILE

properties.brushes.type​

readonly type: "array" = "array"

properties.colours​

readonly colours: object

properties.colours.additionalProperties​

readonly additionalProperties: false = false

properties.colours.properties​

readonly properties: object

properties.colours.properties.background​

readonly background: object = hexColour

properties.colours.properties.background.pattern​

readonly pattern: "^#[0-9a-fA-F]{6}$" = HEX_COLOUR_PATTERN

properties.colours.properties.background.type​

readonly type: "string" = "string"

properties.colours.properties.foreground​

readonly foreground: object = hexColour

properties.colours.properties.foreground.pattern​

readonly pattern: "^#[0-9a-fA-F]{6}$" = HEX_COLOUR_PATTERN

properties.colours.properties.foreground.type​

readonly type: "string" = "string"

properties.colours.required​

readonly required: readonly ["foreground", "background"]

properties.colours.type​

readonly type: "object" = "object"

properties.input​

readonly input: object

properties.input.additionalProperties​

readonly additionalProperties: false = false

properties.input.properties​

readonly properties: object

properties.input.properties.focusPen​

readonly focusPen: object

properties.input.properties.focusPen.type​

readonly type: "boolean" = "boolean"

properties.input.properties.gestures​

readonly gestures: object

properties.input.properties.gestures.additionalProperties​

readonly additionalProperties: object

properties.input.properties.gestures.additionalProperties.maxLength​

readonly maxLength: 50 = 50

properties.input.properties.gestures.additionalProperties.type​

readonly type: "string" = "string"

properties.input.properties.gestures.maxProperties​

readonly maxProperties: 20 = 20

properties.input.properties.gestures.type​

readonly type: "object" = "object"

properties.input.properties.modifierScrollZoom​

readonly modifierScrollZoom: object

properties.input.properties.modifierScrollZoom.type​

readonly type: "boolean" = "boolean"

properties.input.properties.penPressure​

readonly penPressure: object

properties.input.properties.penPressure.type​

readonly type: "boolean" = "boolean"

properties.input.properties.penTilt​

readonly penTilt: object

properties.input.properties.penTilt.type​

readonly type: "boolean" = "boolean"

properties.input.properties.pinchZoom​

readonly pinchZoom: object

properties.input.properties.pinchZoom.type​

readonly type: "boolean" = "boolean"

properties.input.properties.scrollPan​

readonly scrollPan: object

properties.input.properties.scrollPan.type​

readonly type: "boolean" = "boolean"

properties.input.type​

readonly type: "object" = "object"

properties.palettes​

readonly palettes: object

properties.palettes.items​

readonly items: object

properties.palettes.items.$ref​

readonly $ref: string = colourPaletteSchema.$id

properties.palettes.maxItems​

readonly maxItems: 100 = MAX_PALETTES_PER_FILE

properties.palettes.type​

readonly type: "array" = "array"

properties.profiles​

readonly profiles: object

properties.profiles.items​

readonly items: object

properties.profiles.items.$ref​

readonly $ref: string = profileGraphSchema.$id

properties.profiles.maxItems​

readonly maxItems: 100 = MAX_SAVED_PROFILES

properties.profiles.type​

readonly type: "array" = "array"

properties.shortcuts​

readonly shortcuts: object

properties.shortcuts.additionalProperties​

readonly additionalProperties: object

properties.shortcuts.additionalProperties.anyOf​

readonly anyOf: readonly [{ type: "null"; }, { additionalProperties: false; properties: { alt: { type: "boolean"; }; cmd: { type: "boolean"; }; ctrl: { type: "boolean"; }; key: { maxLength: 32; minLength: 1; type: "string"; }; shift: { type: "boolean"; }; }; required: readonly ["key"]; type: "object"; }]

properties.shortcuts.maxProperties​

readonly maxProperties: 200 = MAX_SAVED_SHORTCUTS

properties.shortcuts.propertyNames​

readonly propertyNames: object

properties.shortcuts.propertyNames.maxLength​

readonly maxLength: 64 = 64

properties.shortcuts.type​

readonly type: "object" = "object"

properties.ui​

readonly ui: object

properties.ui.additionalProperties​

readonly additionalProperties: false = false

properties.ui.properties​

readonly properties: object

properties.ui.properties.locale​

readonly locale: object

properties.ui.properties.locale.maxLength​

readonly maxLength: 35 = MAX_LOCALE_LENGTH

properties.ui.properties.locale.minLength​

readonly minLength: 1 = 1

properties.ui.properties.locale.pattern​

readonly pattern: "^[A-Za-z0-9-]+$" = LOCALE_PATTERN

properties.ui.properties.locale.type​

readonly type: "string" = "string"

properties.ui.properties.rendering​

readonly rendering: object

properties.ui.properties.rendering.enum​

readonly enum: readonly ["cpu", "gpu"] = RENDERINGS

properties.ui.properties.theme​

readonly theme: object

properties.ui.properties.theme.enum​

readonly enum: readonly ["light", "dark", "system"] = THEMES

properties.ui.type​

readonly type: "object" = "object"

properties.updatedAt​

readonly updatedAt: object = dateTimeSchema

properties.updatedAt.pattern​

readonly pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$" = DATE_TIME_PATTERN

properties.updatedAt.type​

readonly type: "string" = "string"

required​

readonly required: readonly ["$schema", "@type"]

type​

readonly type: "object" = "object"