Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the user guide for the big picture.

8.11.31.22. nilearn.plotting.displays.PlotlySurfaceFigure

class nilearn.plotting.displays.PlotlySurfaceFigure(figure=None, output_file=None)

Implementation of a surface figure obtained with plotly engine.

Parameters

figurePlotly figure instance or None, optional

Plotly figure instance to be used.

output_filestr or None, optional

Output file path.

Attributes

figurePlotly figure instance

Plotly figure. Use this attribute to access the underlying plotly figure for further customization and use plotly functionality.

output_filestr

Output file path.

__init__(figure=None, output_file=None)

Initialize self. See help(type(self)) for accurate signature.

show(renderer='browser')

Show the figure.

Parameters

rendererstr, optional

Plotly renderer to be used. Default=’browser’.

savefig(output_file=None)

Saves the figure to file.

Parameters

output_filestr or None, optional

Path to output file.

8.11.31.22.1. Examples using nilearn.plotting.displays.PlotlySurfaceFigure

Making a surface plot of a 3D statistical map