Skip to main content
Ctrl+K
Logo image

COMPAS Viewer

  • Introduction
  • Installation
  • Tutorials
    • File Structure
  • Examples
    • Basic Examples
    • Object Examples
    • Color Examples
    • Layout Examples
    • Dynamic Examples
    • Other Examples
  • API Reference
    • compas_viewer.viewer
    • compas_viewer.scene
    • compas_viewer.controller
    • compas_viewer.actions
    • compas_viewer.components
    • compas_viewer.configurations
    • compas_viewer.layout
    • compas_viewer.utilities
  • License
  • Acknowledgements
COMPAS.dev
  • API Reference
  • compas_viewer.configurations
  • MenubarConfig

MenubarConfig

class MenubarConfig[source]

Bases: Config

The class representation for the menu bar configuration of the Layout class. The menu bar configuration contains all the settings about the menu bar itself: items, …

Parameters:
configdict[str, dict[str, compas_viewer.configurations.layout_config.MenubarConfigType]]

A TypedDict with defined keys and types.

See also

compas_viewer.configurations.layout_config.MenubarConfigType
compas_viewer.layout.menubar.MenubarLayout
compas_viewer.configurations.layout_config.LayoutConfig
Attributes:
MenubarConfigTypecompas_viewer.configurations.layout_config.MenubarConfigType

The type template for each single item of the menu.

Methods

from_json

Construct an object of this type from a JSON file.

Inherited Methods

ToString

Converts the instance to a string.

copy

Make an independent copy of the data object.

from_jsonstring

Construct an object of this type from a JSON string.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_json

Convert an object to its native data representation and save it to a JSON file.

to_jsonstring

Convert an object to its native data representation and save it to a JSON string.

validate_data

Validate the data against the object's data schema.

On this page
  • MenubarConfig

© Copyright COMPAS Association.

Created using Sphinx 6.2.1.

Built with the PyData Sphinx Theme 0.13.3.