NGL (ngl) Resources

nglAppResFileName
If set, this specifies the resource file name that PyNGL will look for (actually that name with a ".res" appended). If not set, then the resource file name defaults to the name specified as the second argument to an Ngl.open_wks call (again with a ".res" appended). Setting this resource allows you to use the same resource file name for different workstations in the same script, or for different workstations in different scripts, while being able to produce output files using the name supplied as the second argument to the Ngl.open_wks call. For complete details on naming resource files and the path search algorithm, see the section Where to put resource files in the Selected topics chapter. For complete details on resource files, see the Resource files section of the Selected topics chapter.

Default: "" (empty string)

nglDraw
If set to False, then the plot in question will not be drawn when the plotting function is called. See also nglFrame.

Default: True

nglFrame
If set to False, then the frame will not be advanced when the plotting function is called. See also nglDraw.

Default: True

nglMaskLambertConformal
When set to True, this resource turns on masking of a lambert conformal projection. Extent of mask is determined by four resources which must be set: mpMinLonF , mpMaxLonF, mpMinLatF, mpMaxLatF. This resource is only recognized by Ngl.xxx_map routines in which a lambert conformal map is being drawn. The mpProjection resource must be set to "LambertConformal".

Available in version 1.3.0 or later.

Default: False

nglMaximize
If set to True (the default), then the plot drawn will be maximized in the workstation on which it is being drawn. For an X11 window or an NCGM file, this means the plot will be expanded to fill the biggest possible space within a square, with a small margin around all edges. The aspect ratio will be preserved. For a PostScript or PDF file, the plot will be expanded to fill the biggest possible space on an 8 1/2" x 11" sheet of paper. You can change the default orientation with the resource nglPaperOrientation.

Note: if you are setting the vpWidthF or vpHeightF resources, then you should set nglMaximize to False, as this resource will cause these two resource values to be recalculated.

Default: True

nglPanelBottom
By default, the Ngl.panel routine places all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than or equal to 0.0 and less than 1.0, allows you to set a limit for where the bottommost plot(s) can be drawn. This allows you to reserve white space at the bottom for something like a labelbar. See also the other nglPanel* resources.

Default: 0.0

nglPanelCenter
By default, the Ngl.panel routine centers all of the plots that it is paneling. If there are not enough plots to fill up the requested number of rows and columns, then it will center the remaining plots in the last row. If you set this resource to False, then the remaining plots will be left-justified.

Default: True

nglPanelFigureStrings
If you set this special resource to a list of strings, these strings will be used as figure strings in the lower right hand corner of each paneled plot. You can set the special resource nglPanelFigureStringsJust to change the location of the figure strings. ("TopRight", "TopLeft", "BottomLeft" or "BottomRight" are the choices.)

Default: None

nglPanelFigureStringsBackgroundFillColor
The color index to use for the backgound color for label boxes in panel plots.

Default: 0

nglPanelFigureStringsFontHeightF
If you set nglPanelFigureStrings in a call to Ngl.panel, then this resource allows you to control the font height of the figure strings. If you don't set this resource, then the font height is calculated internally based on a number of factors.

Default: dynamic

nglPanelFigureStringsJust
Used to justify the individual plot labels when nglPanelFigureStrings is True. The legal values are: "TopRight", "TopLeft", "BottomLeft" or "BottomRight".

Default: "BottomRight"

nglPanelFigureStringsOrthogonalPosF
Used to make minor adjustments to the labels in panel plots in a direction orthogonal to the text string. The units are in NDC space.

Default: 0.0

nglPanelFigureStringsParallelPosF
Used to make minor adjustments to the labels in panel plots in a direction parallel to the text string. The units are in NDC space.

Default: 0.0

nglPanelFigureStringsPerimOn
Determines if a perimeter is drawn around the labels for plots in a panel plot.

Default: True

nglPanelLabelBar
If you set this resource to True, then a single labelbar will be generated for all the plots on the page when Ngl.panel is called. The default is to draw the labelbar on the bottom, unless "lbOrientation" is set to the string "Vertical" or the integer 1. Note: using this resource assumes that all of your plots have the same labelbar.

Default: False

nglPanelLabelBarHeightF
This specifies the height of the label bar when nglPanelLabelBar is set to True. A nominal default height is chosen if a value for nglPanelLabelBarHeightF is not specified. Values for this resource are specified in NDC space.

Default: -999.

nglPanelLabelBarLabelAutoStride
When this resource is set True (the default), LabelBar labels are checked for overlap before being drawn. If overlap would otherwise occur, a stride is set through the labels such that overlap will be avoided. The stride proceeds in both directions from a pivot label, chosen based on how "round" it is relative to the other labels. If the labels seem to be equally "round" or if the labels are non-numeric, then the shortest label is chosen as the pivot.

If lbLabelAlignment is set to ExternalEdges, the behavior is a bit different. In this case, the stride is set as described above, but the labels at each end are guaranteed to appear. This may cause labels that would otherwise be part of the stride sequence to be eliminated. This behavior is useful when the end labels are used to show the extreme values of a dataset.

Default: True

nglPanelLabelBarLabelFontHeightF
If set, specifies the height of the labelbar font used when nglPanelLabelBar is set to True. This value is calculated internally if not specified by the user.

Default: -999.

nglPanelLabelBarOrthogonalPosF
This resource can be used to modify the position of a label bar. The values are specified in NDC space. The direction of the positional modification is orthogonal to the long axis of the label bar, i.e. up or down for a horizontal label bar, or left or right for a vertical label bar.

Default: -999.

nglPanelLabelBarParallelPosF
This resource can be used to modify the position of a label bar. The values are specified in NDC space. The direction of the positional modification is parallel to the long axis of the label bar, i.e up or down for a vertical label bar, or left or right for a horizontal label bar.

Default: -999.

nglPanelLabelBarWidthF
This specifies the width of the label bar when nglPanelLabelBar is set to True. A nominal default width is chosen if a value for nglPanelLabelBarWidthF is not specified. Values for this resource are specified in NDC space.

Default: -999.

nglPanelLabelBarXF
Specifies the location of the left edge of the label bar in NDC space. This is calculated internally unless specified by the user.

Default: -999.

nglPanelLabelBarYF
Specifies the location of the top edge of the label bar in NDC space. This is calculated internally unless specified by the user.

Default: -999.

nglPanelLeft
By default, the Ngl.panel routine tries to place all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than or equal to 0.0 and less than 1.0, allows you to set a limit for where the leftmost plot(s) can be drawn. This allows you to reserve white space at the left for something like a labelbar. See also the other nglPanel* resources.

Default: 0.0

nglPanelRight
By default, the Ngl.panel routine tries to place all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than 0.0 and less than or equal to 1.0, allows you to set a limit for where the rightmost plot(s) can be drawn. This allows you to reserve white space at the right for something like a labelbar. See also the other nglPanel* resources.

Default: 1.0

nglPanelRowSpec
Ngl.panel routine panels its plots according to the dims variable which indicates rows x columns. If you set nglPanelRowSpec to True, however, then you can use the dims variable to indicate the number of plots you want per row. For example, setting nglPanelRowSpec to True and dims to [2,3,1] will put 2 plots in the first row, 3 plots in the second row, and 1 plot in the third row.

Default: False

nglPanelTop
By default, the Ngl.panel routine tries to place all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than 0.0 and less than or equal to 1.0, allows you to set a limit for where the topmost plot(s) can be drawn. This allows you to reserve white space at the top for something like a title. See also the other nglPanel* resources.

Default: 1.0

nglPanelXWhiteSpacePercent
Takes a percentage value from 0 to 100 to indicate what percentage of the total plot width should be used for white space at the left and right of each plot in a call to Ngl.panel. See also the other nglPanel* resources.

Default: 1.0

nglPanelYWhiteSpacePercent
Takes a percentage value from 0 to 100 to indicate what percentage of the total plot height should be used for white space at the top and bottom of each plot in a call to Ngl.panel. See also the other nglPanel* resources.

Default: 1.0

nglPaperHeight
This resource specifies the height (in inches) of the paper that you plan to print the PostScript or PDF file on. It is supposed to be used in conjunction with nglMaximize. See also nglPaperMargin, nglPaperWidth, and nglPaperOrientation.

Default: 11.0

nglPaperMargin
This resource specifies the margin (in inches) that you want to leave around the plotting area. It is supposed to be used in conjunction with nglMaximize. See also nglPaperHeight, nglPaperWidth, and nglPaperOrientation.

Default: 0.5

nglPaperOrientation
This resource specifies the orientation of the plot on paper that you plan to print the PostScript or PDF file on. It is only to be used in conjunction with nglMaximize. Valid values are "portrait", "landscape", and "auto". If set to "auto", then PyNGL will figure out the best possible orientation to use for the type of plot being drawn. You cannot change the orientation after you already begin drawing to a frame. This resource will override any setting of wkOrientation.

Default: "auto"

nglPaperWidth
This resource specifies the width (in inches) of the paper that you plan to print the PostScript or PDF file on. It is supposed to be used in conjunction with nglMaximize. See also nglPaperMargin, nglPaperHeight, and nglPaperOrientation.

Default: 8.5

nglPointTickmarksOutward
If set to True, then the major and minor tickmarks on both the X and Y axes will be pointed outwards.

Default: False

nglScale
If set to True, then the X and Y axis labels will be scaled to be the same size and the tick marks will be scaled to be the same length. This is useful when the X and Y axis are of different lengths, but you still want the labels and tick marks to be the same for each axis.

Default: True

nglSpreadColorEnd
This resource only takes effect if nglSpreadColors is set to True. It indicates the index of the last color in the color table that should be used for a color contour or vector plot. If this value is negative, then the value indicates the position from the last color in the color table. For example, -1 indicates the last color, -2 indicates the second to the last color, and so on. (The colors go from 0 to ncol-1, where ncol is the number of colors.) See also nglSpreadColorStart.

If nglSpreadColorStart and nglSpreadColorEnd are selected such that the start color is after the end color in the color table, then the colors will be reversed.

Default: -1

nglSpreadColorStart
This resource only takes effect if nglSpreadColors is set to True. It indicates the index of the first color in the color table that should be used for a color contour or vector plot. If this value is negative, then the value indicates the position from the last color in the color table. For example, -1 indicates the last color, -2 indicates the second to the last color, and so on. (The colors go from 0 to ncol-1, where ncol is the number of colors.) See also nglSpreadColorEnd.

If nglSpreadColorStart and nglSpreadColorEnd are selected such that the start color is after the end color in the color table, then the colors will be reversed.

Default: 2

nglSpreadColors
If set to True, and you are drawing a colored contour or vector plot, then the colors used will be spread across the whole color map. If false, then there is a one-to-one matching between the color indices in the current color table and the colors between contour levels. See also nglSpreadColorStart and nglSpreadColorEnd.

Default: True

nglXAxisType
If set, this resource allows you to convert an irregular X axis to a linear or log axis. It works in conjunction with the setting of one of the scalar or vector field resources (sfXArray and vfXArray), since setting these resources automatically causes the X axis to tagged as an irregular axis (even if the values themselves are linear). Valid values are "IrregularAxis", "LinearAxis" and "LogAxis." Using a value of "IrregularAxis" will effectively cause no action to take place on the X axis.

Default: "IrregularAxis"

nglXRefLine
If set, this resource will cause a vertical reference line to be drawn at the given X value (only for calls to Ngl.xy or Ngl.y).

Default: -999.

nglXRefLineColor
If nglXRefLine is set, this resource allows you to change its line color.

Default: 1 (foreground color)

nglXRefLineThicknessF
If nglXRefLine is set, this resource allows you to change its line thickness.

Default: 1.

nglXYAboveFillColors
This resource can be used to indicate a fill color to use between two curves in an XY plot that intersect. It only applies to the Ngl.xy or Ngl.y functions.

It should be set to an array of colors (either color index values or named colors) that has one fewer values than you have curves.

The first value will be used to fill all areas between the first and second curves where the values in the first curve are greater (in the Y direction) than the values in the second curve. The second value will be used to fill all areas between the second and third curves where the values in the second curve are greater than the values in the third curve, and so on. If you set this resource to less than ncurves-1 colors, then the colors will be repeated as necessary.

If the Y axis is reversed, then this resource is a bit misleading because now the "above" curves will be reverted.

To indicate that you don't want any fill, use either "transparent" or the value -1.

To fill areas where values in one curve are less than values in another curve, use nglXYBelowFillColors. If you want to fill between two curves that do not intersect, see nglXYFillColors.

Available in version 1.3.1 or later.

Default: None

nglXYBelowFillColors
This resource can be used to indicate a fill color to use between two curves in an XY plot that intersect. It only applies to the Ngl.xy or Ngl.y functions.

It should be set to an array of colors (either color index values or named colors) that has one fewer values than you have curves.

The first value will be used to fill all areas between the first and second curves where values in the first curve are less (in the Y direction) than values in the second curve. The second value will be used to fill all areas between the second and third curves where values in the second curve are less than values in the third curve, and so on. If you set this resource to less than ncurves-1 colors, then the colors will be repeated as necessary.

If the Y axis is reversed, then this resource is a bit misleading because now the "below" curves will be reverted.

To indicate that you don't want any fill, use either "transparent" or the value -1.

To fill areas where values in one curve are greater than values in another curve, use nglXYAboveFillColors.

If you want to fill between two curves that do not intersect, see nglXYFillColors.

Available in version 1.3.1 or later.

Default: None

nglXYFillColors
This resource can be used to indicate a fill color to use between two adjacent curves in an XY plot. It only applies to the Ngl.xy or Ngl.y functions.

It should be set to an array of colors (either color index values or named colors) that has one fewer values than you have curves.

The first value will be used to fill the area between the first and second curves, the second value will be used to fill the area between the second and third curves, and so on. If you set this resource to less than ncurves-1 colors, then the colors will be repeated as necessary.

To indicate that you don't want any fill, use either "transparent" or the value -1.

If you want to fill between two curves that intersect, see nglXYAboveFillColors and nglXYBelowFillColors.

Available in version 1.3.1 or later.

Default: -1

nglXYLeftFillColors
This resource can be used to indicate a fill color to use between two curves in an XY plot that intersect. It only applies to the Ngl.xy or Ngl.y functions.

It should be set to an array of colors (either color index values or named colors) that has one fewer values than you have curves.

The first value will be used to fill all areas between the first and second curves where values in the first curve are less than values in the second curve. The second value will be used to fill all areas between the second and third curves where values in the second curve are less than values in the third curve, and so on. If you set this resource to less than ncurves-1 colors, then the colors will be repeated as necessary.

To indicate that you don't want any fill, use either "transparent" or the value -1.

To fill areas where values in one curve are greater than values in another, use nglXYRightFillColors. If you want to fill between two curves that do not intersect, see nglXYFillColors.

Available in version 1.3.1 or later.

Default: -1

nglXYRightFillColors
This resource can be used to indicate a fill color to use between two curves in an XY plot that intersect. It only applies to the Ngl.xy or Ngl.y functions.

It should be set to an array of colors (either color index values or named colors) that has one fewer values than you have curves.

The first value will be used to fill all areas between the first and second curves where values in the first curve are greater (in the X direction) than values in the second curve. The second value will be used to fill all areas between the second and third curves where values in the second curve are greater than values in the third curve, and so on. If you set this resource to less than ncurves-1 colors, then the colors will be repeated as necessary.

To indicate that you don't want any fill, use either "transparent" or the value -1.

To fill areas where values in one curve are less than values in another, use nglXYLeftFillColors. If you want to fill between two curves that do not intersect, see nglXYFillColors.

Available in version 1.3.1 or later.

Default: -1

nglYAxisType
If set, this resource allows you to convert an irregular Y axis to a linear or log axis. It works in conjunction with the setting of one of the scalar or vector field resources (sfYArray and vfYArray), since setting these resources automatically causes the Y axis to tagged as an irregular axis (even if the values themselves are linear). Valid values are "IrregularAxis", "LinearAxis" and "LogAxis." Using a value of "IrregularAxis" will effectively cause no action to take place on the Y axis.

Default: "IrregularAxis"

nglYRefLine
If set, this resource will cause a horizontal reference line to be drawn at the given Y value (only for calls to Ngl.xy or Ngl.y).

Default: -999.

nglYRefLineColor
If nglYRefLine is set, this resource allows you to change its line color.

Default: 1 (foreground color)

nglYRefLineThicknessF
If nglYRefLine is set, this resource allows you to change its line thickness.

Default: 1.