Plot Attribute Descriptions


View Attributes

plWindowF
Extent of the plot window in data coordinates. The value is a float array of length 4 with elements (/ xl, xr, yb, yt /) where xl is the coordinate at the left edge of the window, xr is the right edge, yb is the bottom, and yt is the top.

Default: <dynamic>


Title Attributes

All title attributes that are strings may contain Text Function Codes that allow you to control typographical attributes such as subscripting and superscripting, change fonts within a string, embed newlines, etc.

All font heights are the height of text from the bottom to the top of an average character in normalized device coordinates (NDC).

plMainTitle
String containing main title centered above top plot(s).

Default: <dynamic>

plMainTitleYoffF
Vertical offset in NDC from the top of the viewport that the main title is being centered over.

Default: <dynamic>

plMainTitleFontHeightF
Font height for the main title.

Default: .025

plMainTitle2
String containing main title2 which is centered just below the main title.

Default: <none>

plMainTitle2YoffF
Vertical offset in NDC from the top of the viewport that main title2 is being centered over.

Default: <dynamic>

plMainTitle2FontHeightF
Font height for main title2.

Default: .02

plPlotNTitleL
String containing plot title above plot N on the left side. N is replaced by the specific plot number.

Default: <none>

plPlotNTitleC
String containing plot title centered above plot N.

Default: <none>

plPlotNTitleR
String containing plot title above plot N on the right side.

Default: <none>

plPlotTitleYoffF
Vertical offset in NDC from the top of the viewport that the plot titles are being drawn over.

Default: .025

plPlotTitleFontHeightF
Font height for the plot title(s).

Default: .018

plColorbarTitle
String containing the colorbar title centered below a horizontal colorbar or above a vertical one.

Default: <none>

plColorbarTitleXoffF
Horizontal offset in NDC of the text justification point from the point on the viewport that the colorbar title is being positioned with respect to.

Default: <dynamic>

plColorbarTitleYoffF
Vertical offset in NDC of the text justification point from the point on the viewport that the colorbar title is being positioned with respect to.

Default: <dynamic>

plColorbarTitleFontHeightF
Font height for the colorbar title.

Default: .018


Page Layout Attributes

plPlotHeightF
Height of the plot window(s) in NDC. Setting both this and the plPlotWidthF attributes fixes the plot aspect ratio. If the user specified values of either plPlotWidthF or plPlotHeightF result in a page that goes outside NDC bounds, then the values will be scaled in a way that maintains the aspect ratio.

Default: <dynamic>

plPlotWidthF
Width of the plot window(s) in NDC. Setting both this and the plPlotHeightF attributes fixes the plot aspect ratio. If the user specified values of either plPlotWidthF or plPlotHeightF result in a page that goes outside NDC bounds, then the values will be scaled in a way that maintains the aspect ratio.

Default: <dynamic>

plPlotOrient
Plot orientation on a multiple plot page. Allowable values are horizontal or vertical. The default is chosen based on plot aspect ratio (defined as height/width).

Default: <dynamic>

plXPlotSpacingF
Spacing (in NDC) between plots in the horizontal dirction.

Default: <dynamic>

plYPlotSpacingF
Spacing (in NDC) between plots in the vertical dirction.

Default: <dynamic>

plColorbarOrient
Colorbar orientation. Allowable values are horizontal or vertical.

Default: <dynamic>

plColorbarThickF
Thickness of colorbar in NDC. Thickness is the height of a horizontal colorbar and the width of a vertical one.

Default: .04

plColorbarSpacingF
Spacing in NDC between the colorbar and the closest plot edge. This provides adjustment for either plot or colorbar labels/tickmarks.

Default: <dynamic>

plYTPlotEdgeF
NDC value of the top edge of the top plot(s). When this value is specified by the user then it is not modified even if that results in some part of the page extending outside of NDC space.

Default: <dynamic>

plXLPlotEdgeF
NDC value of the left edge of the leftmost plot(s). When this value is specified by the user then it is not modified even if that results in some part of the page extending outside of NDC space.

Default: <dynamic>


Colormap Attributes

plCenterZeroCI
Set to True to cause the bins surrounding the zero contour level to be mapped to the center of the range of colormap indices. This is done in function setFillColors and the algorithm probably still needs a little tuning. One could also try tuning the colormap if the center colors are just a bit off.

Default: False

plUseColormap2
Set to True to use the second user defined colormap specified to the rgbColorMap function at the time of the workstation definition. In page layouts that are specifically designed for difference plots then the default for plUseColormap2 is True for the difference plots.

Default: <dynamic>


Return to NCL Script Index