graphinglib.SmartFigureWCS.hide_custom_legend_elements

property SmartFigureWCS.hide_custom_legend_elements: bool

Whether to hide custom legend elements. This is useful if a custom legend was previously created using the set_custom_legend() method and you want to hide these elements. Each SmartFigure controls its own custom legend elements, so if this property is set to True in a nested SmartFigure, the custom legend elements will be hidden even if the parent SmartFigure attempts to create a general legend. However, both the nested and parent SmartFigures need to set this property to False to display the custom elements of a nested SmartFigure in a global general legend.

Note

Custom legend elements can only be plotted if the general_legend property is set to True or if the SmartFigure is a single subplot. This is because custom legend elements are associated with the figure as a whole, and not with individual subplots.