visbrain.objects.SceneObj.add_to_subplot

SceneObj.add_to_subplot(obj, row=0, col=0, row_span=1, col_span=1, title=None, title_size=12.0, title_color='white', title_bold=True, use_this_cam=False, rotate=None, zoom=None, camera_state={}, width_max=None, height_max=None)[source][source]

Add object to subplot.

Parameters:
obj : visbrain.object

The visbrain object to add.

row : int | 0

Row location for the object.

col : int | 0

Columns location for the object.

row_span : int | 1

Number of rows to use.

col_span : int | 1

Number of columns to use.

title : string | None

Subplot title.

title_size : float | 12.

Title font size.

title_color : string/tuple/array_like | ‘white’

Color of the title.

title_bold : bool | True

Use bold title.

use_this_cam : bool | False

If you add multiple objects to the same scene and if you want to use the camera of an object as the reference, turn this parameter to True.

rotate : string | None

Rotate the scene (only available for 3D objects). Use :

  • ‘top’ : top view
  • ‘bottom’ : bottom view
  • ‘left’ : left view
  • ‘right’ : right view
  • ‘front’ : front view
  • ‘back’ : bottom view
  • ‘side-fl’ : side view (front-left)
  • ‘side-fr’ : side view (front-right)
  • ‘side-bl’ : side view (back-left)
  • ‘side-br’ : side view (back-right)
zoom : float | None

Zoom level. If zoom is in ]0, 1[, the size of the object decrease. If zoom=1, no zoom is applied. If zoom > 1., the size of the object increase. For example, zoom=2 means that the displayed object will appear twice as large.

camera_state : dict | {}

Arguments to pass to the camera.

width_max : float | None

Maximum width of the subplot.

height_max : float | None

Maximum height of the subplot.