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.

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)

show(renderer='browser')

Show the figure.

Parameters:

rendererstr, default=’browser’

Plotly renderer to be used.

savefig(output_file=None)

Save the figure to file.

Parameters:

output_filestr or None, optional

Path to output file.

Examples using nilearn.plotting.displays.PlotlySurfaceFigure

Making a surface plot of a 3D statistical map

Making a surface plot of a 3D statistical map