Options
All
  • Public
  • Public/Protected
  • All
Menu

Module renderer/services/setting

Index

Functions

Functions

changeSchema

fetchSettings

  • fetchSettings(): Promise<any>

  • Fetch remote settings and refresh local value.

    Returns Promise<any>

    settings

getDefaultSetting

  • Get default settings.

    Returns BuildInSettings

    settings

getSchema

  • getSchema(): Schema

  • Get Schema.

    Returns Schema

    Schema

getSetting

getSettings

  • getSettings(): any

  • Get local settings.

    Returns any

    settings

hideSettingPanel

  • hideSettingPanel(): void

  • Hide setting panel.

    Returns void

setSetting

  • set setting val

    Type parameters

    Parameters

    Returns Promise<void>

showSettingPanel

  • showSettingPanel(keyOrGroup?: "editor" | "custom-css" | "license" | "theme" | "mark" | "repos" | "appearance" | "render" | "image" | "proxy" | "macros" | "other" | "language" | "assets-dir" | "shell" | "envs" | "auto-save" | "plantuml-api" | "hide-main-window-on-startup" | "keep-running-after-closing-window" | "extension.registry" | "extension.auto-upgrade" | "keybindings" | "editor.mouse-wheel-zoom" | "editor.font-size" | "editor.tab-size" | "editor.ordered-list-completion" | "editor.minimap" | "editor.line-numbers" | "editor.enable-preview" | "editor.font-family" | "editor.complete-emoji" | "editor.todo-with-time" | "editor.suggest-on-trigger-characters" | "editor.quick-suggestions" | "render.md-html" | "render.md-breaks" | "render.md-linkify" | "render.md-typographer" | "render.md-emoji" | "render.md-sub" | "render.md-sup" | "render.multimd-multiline" | "render.multimd-rowspan" | "render.multimd-headerless" | "render.multimd-multibody" | "assets.path-type" | "plugin.image-hosting-picgo.server-url" | "plugin.image-hosting-picgo.enable-paste-image" | "updater.source" | "doc-history.number-limit" | "search.number-limit" | "server.host" | "server.port" | "tree.exclude" | "proxy.enabled" | "proxy.server" | "proxy.pac-url" | "proxy.bypass-list"): Promise<void>
  • showSettingPanel(keyOrGroup?: string): Promise<void>

  • Show setting panel.

    Parameters

    • Optional keyOrGroup: "editor" | "custom-css" | "license" | "theme" | "mark" | "repos" | "appearance" | "render" | "image" | "proxy" | "macros" | "other" | "language" | "assets-dir" | "shell" | "envs" | "auto-save" | "plantuml-api" | "hide-main-window-on-startup" | "keep-running-after-closing-window" | "extension.registry" | "extension.auto-upgrade" | "keybindings" | "editor.mouse-wheel-zoom" | "editor.font-size" | "editor.tab-size" | "editor.ordered-list-completion" | "editor.minimap" | "editor.line-numbers" | "editor.enable-preview" | "editor.font-family" | "editor.complete-emoji" | "editor.todo-with-time" | "editor.suggest-on-trigger-characters" | "editor.quick-suggestions" | "render.md-html" | "render.md-breaks" | "render.md-linkify" | "render.md-typographer" | "render.md-emoji" | "render.md-sub" | "render.md-sup" | "render.multimd-multiline" | "render.multimd-rowspan" | "render.multimd-headerless" | "render.multimd-multibody" | "assets.path-type" | "plugin.image-hosting-picgo.server-url" | "plugin.image-hosting-picgo.enable-paste-image" | "updater.source" | "doc-history.number-limit" | "search.number-limit" | "server.host" | "server.port" | "tree.exclude" | "proxy.enabled" | "proxy.server" | "proxy.pac-url" | "proxy.bypass-list"

    Returns Promise<void>

  • Parameters

    • Optional keyOrGroup: string

    Returns Promise<void>

writeSettings

  • writeSettings(settings: Record<string, any>): Promise<any>

  • Write settings.

    Parameters

    • settings: Record<string, any>

    Returns Promise<any>

    settings

Generated using TypeDoc