set_plot_colors

opstool.vis.pyvista.set_plot_colors(**kwargs)

Set the display color of various element types.

Return type:

None

Parameters

kwargs: optional keyword arguments, including:

• pointstr, list[int, int, int], optional

  Color for nodal points. Either a string, RGB list, or hex color string. For example, point='white', point='w', point=[1, 1, 1], or point='#FFFFFF'.

• framestr, list[int, int, int], optional

  Color for frame elements.

• trussstr, list[int, int, int], optional

  Color for truss elements.

• linkstr, list[int, int, int], optional

  Color for link elements.

• shellstr, list[int, int, int], optional

  Color for shell elements.

• planestr, list[int, int, int], optional

  Color for plane elements.

• brickstr, list[int, int, int], optional

  Color for brick (solid) elements.

• tetstr, list[int, int, int], optional

  Color for tetrahedral (solid) elements.

• jointstr, list[int, int, int], optional

  Color for beam-column joint elements.

• contactstr, list[int, int, int], optional

  Color for contact elements.

• pfemstr, list[int, int, int], optional

  Color for PFEM elements.

• constraintstr, list[int, int, int], optional

  Color for constraint.

• bcstr, list[int, int, int], optional

  Color for boundary conditions.

• cmapstr, list, optional

  Name of the Matplotlib colormap to us when mapping the scalars. See available Matplotlib colormaps. Only applicable for when displaying scalars. Requires Matplotlib to be installed. colormap is also an accepted alias for this. If colorcet or cmocean are installed, their colormaps can be specified by name.

  You can also specify a list of colors to override an existing colormap with a custom one. For example, to create a three color colormap you might specify ['green', 'red', 'blue'].

• cmap_modelstr, list, optional, default=None

  Matplotlib colormap used for geometry model visualization. Same as cmap, except that this parameter will be used for geometry model visualization and will be automatically mapped according to different element types. If None, If None, the color specified in the function``set_plot_colors`` will be used.

  Available color maps are shown in Colormaps in Matplotlib

• nodal_label: str, default=”#048243”

  Color for nodal label.

• ele_label: str, default=”#650021”

  Color for element label.

Returns

None