fsleyes.views.colourbarpanel
¶
This module provides the ColourBarPanel
, a FSLeyesPanel
which renders a colour bar.
-
class
fsleyes.views.colourbarpanel.
ColourBarPanel
(parent, overlayList, displayCtx, frame)¶ Bases:
fsleyes.panel.FSLeyesPanel
The
ColourBarPanel
is a panel which shows a colour bar, depicting the data range of the currently selected overlay (if applicable). AColourBarCanvas
is used to render the colour bar.Note
Currently, the
ColourBarPanel
will only display a colour bar for overlays which are associated with aColourMapOpts
instance.-
__init__
(parent, overlayList, displayCtx, frame)¶ Create a
ColourBarPanel
.Parameters: - parent – The
wx
parent object. - overlayList – The
OverlayList
instance. - displayCtx – The
DisplayContext
instance. - frame – The
FSLeyesFrame
.
- parent – The
-
getCanvas
()¶ Returns the
ColourBarCanvas
which displays the rendered colour bar.
-
canvas
¶ Returns the
ColourBarCanvas
which displays the rendered colour bar.
-
destroy
()¶ Must be called when this
ColourBarPanel
is no longer needed.
-
_ColourBarPanel__layout
(*a)¶ Called when this
ColourBarPanel
needs to be laid out. Sets the panel size, and calls the__refreshColourBar()
method.
-
__module__
= 'fsleyes.views.colourbarpanel'¶
-