octoprint.schema.config.appearance#
AppearanceConfig
#
Bases: BaseModel
color: ColorEnum = ColorEnum.default
class-attribute
instance-attribute
#
Use this to color the navigation bar.
colorTransparent: bool = False
class-attribute
instance-attribute
#
Makes the color of the navigation bar "transparent". In case your printer uses acrylic for its frame 😉.
components: ComponentConfig = ComponentConfig()
class-attribute
instance-attribute
#
Configures the order and availability of the UI components.
defaultLanguage: str = '_default'
class-attribute
instance-attribute
#
Default language of OctoPrint. If left unset OctoPrint will try to match up available languages with the user's browser settings.
name: str = ''
class-attribute
instance-attribute
#
Use this to give your OctoPrint instance a name. It will be displayed in the title bar (as "
showInternalFilename: bool = True
class-attribute
instance-attribute
#
Show the internal filename in the files sidebar, if necessary.
ComponentConfig
#
Bases: BaseModel
disabled: ComponentDisabledConfig = ComponentDisabledConfig()
class-attribute
instance-attribute
#
Disabled components per container. If a component is included here it will not be included in OctoPrint's UI at all. Note that this might mean that critical functionality will not be available if no replacement is registered.
order: ComponentOrderConfig = ComponentOrderConfig()
class-attribute
instance-attribute
#
Defines the order of the components within their respective containers.
ComponentDisabledConfig
#
Bases: BaseModel
about: List[str] = []
class-attribute
instance-attribute
#
Disabled about dialog items.
generic: List[str] = []
class-attribute
instance-attribute
#
Disabled generic items.
navbar: List[str] = []
class-attribute
instance-attribute
#
Disabled navbar items.
settings: List[str] = []
class-attribute
instance-attribute
#
Disabled settings.
sidebar: List[str] = []
class-attribute
instance-attribute
#
Disabled sidebar items.
tab: List[str] = []
class-attribute
instance-attribute
#
Disabled tabs.
usersettings: List[str] = []
class-attribute
instance-attribute
#
Disabled user settings.
wizard: List[str] = []
class-attribute
instance-attribute
#
Disabled wizards.
ComponentOrderConfig
#
Bases: BaseModel
about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager']
class-attribute
instance-attribute
#
Order of about dialog items.
generic: List[str] = []
class-attribute
instance-attribute
#
Order of generic items.
navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login']
class-attribute
instance-attribute
#
Order of navbar items.
settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support']
class-attribute
instance-attribute
#
Order of settings.
sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files']
class-attribute
instance-attribute
#
Order of sidebar items.
tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse']
class-attribute
instance-attribute
#
Order of tabs.
usersettings: List[str] = ['access', 'interface']
class-attribute
instance-attribute
#
Order of user settings.
wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck']
class-attribute
instance-attribute
#
Order of wizards.