PyNGL Home > Functions > PyNGL object routines

Ngl.remove_overlay

Removes an overlaid plot from the given plot.

Prototype

Ngl.remove_overlay(PlotId_base, PlotId_overlay, 
                     restore=False)

Arguments

PlotId_base

The id of the plot from which you want to remove the overlay.

PlotId_overlay

The id of the plot which was overlaid on PlotId_base.

restore=False

An optional logical value. If True and the member plot initially was a base plot of an overlay with its own members, the member plots are returned to the plot being removed.

Return value

   None

Description

This procedure removes a plot that was overlaid on a base plot via the Ngl.overlay procedure. The first two arguments are a PlotId for the base plot and a PlotId for the plot that was previously overlaid onto the base plot. The third argument, restore, is a logical value that if set to True and the overlaid plot initially was a base plot of an overlay with its own overlaid plots, then these overlaid plots are returned to the plot being removed.

See Also

Ngl.overlay, Ngl.add_annotation, Ngl.remove_annotation

Examples

See overlay1.py.