tidy3d.VisualizationSpec

class VisualizationSpec

Bases: Tidy3dBaseModel

Defines specification for visualization when used with plotting functions.

Parameters:

• attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

• facecolor (str =) – Color applied to the faces in visualization.

• edgecolor (Optional[str] =) – Color applied to the edges in visualization.

• alpha (Optional[ConstrainedFloatValue] = 1.0) – Opacity/alpha value in plotting between 0 and 1.

Attributes

attrs

Methods

validate_and_copy_color(values)
validate_color()

Inherited Common Usage

facecolor

edgecolor

alpha

classmethod validate_color()

classmethod validate_and_copy_color(values)

__hash__()

Hash method.