ViewportConfig

class ViewportConfig[source]

Bases: Config

The class representation for the viewport configuration of the Layout class. The viewport configuration contains all the settings about the viewport itself: render, …

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

A TypedDict with defined keys and types.

See also

compas_viewer.configurations.layout_config.ViewportConfigType
compas_viewer.layout.viewport.ViewportLayout
compas_viewer.configurations.layout_config.LayoutConfig
Attributes:
ViewportConfigTypecompas_viewer.configurations.layout_config.ViewportConfigType

The type template for each single item of the viewport.

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.