NCL Home > Documentation > Graphics > Resources

GSN (gsn) Resources

gsnAboveYRefLineBarColors

If gsnYRefLine is set and gsnXYBarChart is set to True, then this resource indicates what colors to use in filling the bars above the given Y reference line.

The colors will repeat if there are fewer colors than bars.

Default: None

gsnAboveYRefLineBarFillScales

If gsnYRefLine is set, gsnXYBarChart is set to True, and gsnAboveYRefLineBarPatterns is set, then this resource indicates what fill scales to use for the fill patterns. Values less than 1.0 give you a more dense pattern.

Available in version 5.1.0 and later.

Default: 1.0

gsnAboveYRefLineBarPatterns

If gsnYRefLine is set and gsnXYBarChart is set to True, then this resource indicates what patterns to use in filling the bars above the given Y reference line. The gsnXYBarChartPatterns resource will be ignored.

The patterns will repeat if there are fewer patterns than bars.

Default: 0 (solid fill)

gsnAboveYRefLineColor

If gsnYRefLine is set, then this resource fills the curve above the Y reference line with the given color.

Default: None

gsnAddCyclic

For geo-referenced data, a longitude cyclic point is added as a default to ensure a gap is not plotted at the Greenwich Meridian. This resource only applies to gsn_csm plotting routines that overlay data on a map.

This resource should be set to False if your data already has a cyclic point added, or if your data does not cover the whole globe to start with. This resource defaults to True for many gsn_csm_xxxx scripts that create contour, vector, or streamline plots, unless the function can determine automatically that this is not cyclic data.

Default: dynamic

gsnAttachBorderOn

By default, the gsn_attach_plots routine does not remove the interior borders when you attach a series of plots. If this resource is set to False, then the interior borders will be removed.

Default: True

gsnAttachPlotsXAxis

By default, the gsn_attach_plots routine attaches plots by attaching the right Y axis of the current plot to the left Y axis of the next plot. If this resource is set to True, then the plots will be attached at the bottom X axis of the current plot and the top X axis of the next plot.

Default: False

gsnBelowYRefLineBarColors

If gsnYRefLine is set and gsnXYBarChart is set to True, then this resource indicates what colors to use in filling the bars below the given Y reference line.

The colors will repeat if there are fewer colors than bars.

Default: None

gsnBelowYRefLineBarFillScales

If gsnYRefLine is set, gsnXYBarChart is set to True, and gsnBelowYRefLineBarPatterns is set, then this resource indicates what fill scales to use for the fill patterns. Values less than 1.0 give you a more dense pattern.

Available in version 5.1.0 and later.

Default: 1.0

gsnBelowYRefLineBarPatterns

If gsnYRefLine is set and gsnXYBarChart is set to True, then this resource indicates what patterns to use in filling the bars below the given Y reference line. The gsnXYBarChartPatterns resource will be ignored.

The patterns will repeat if there are fewer patterns than bars.

Default: 0 (solid fill)

gsnBelowYRefLineColor

If gsnYRefLine is set, then this resource fills the curve below the Y reference line with the given color.

Default: None

gsnBoxMargin

This resource specifies the margin (in NDC coordinates) that you want to leave around your plot, if gsnMaximize is set to True and your output is going to an X11 window or an NCGM.

Default: 0.02

gsnCenterString

For any gsn_csm plotting routine, this resource adds the given string just above the plot's upper boundary and centers it.

See other gsnLeftStringXXXX or gsnStringXXXX resources for ways to customize this string.

Default: none

gsnCenterStringFontColor

If gsnCenterString is set, this resource controls the font color of the string. This resource overrides gsnStringFontColor.

Available in version 5.1.1 and later.

Default: foreground (1)

gsnCenterStringFontHeightF

If gsnCenterString is set, this resource controls the font height of the string. This resource overrides gsnStringFontHeightF.

Default: dynamic

gsnCenterStringFuncCode

If gsnCenterString is set, this resource sets the function code for the string. This resource overrides gsnStringFuncCode.

Available in version 6.2.0 and later.

Default: ~

gsnCenterStringOrthogonalPosF

If gsnCenterString is set, this resource allows you to move this string up or down. Use small negative or positive values to nudge the string closer to or away from the plot boundary.

Default: dynamic

gsnCenterStringParallelPosF

If gsnCenterString is set, this resource allows you to move this string left or right. A value of 0.0 moves the plot to the left boundary of the plot, and a value of 1.0 moves it to the right boundary. A value of 0.5 (the default) centers it.

Default: 0.5

gsnContourLineThicknessesScale

This resource, recognized by any gsn contour drawing routine, allows you to set line thickness scale factors for all contour lines. For example, aq value of 2.0 will make the lines twice as thick. If this is set to an array that is not large enough to handle all contour lines, then the default value of 1.0 will be used for the remaining contour lines.

This resource can be used in conjunction with the resource gsnContourZeroLineThicknessF.

Default: none

gsnContourNegLineDashPattern

This resource, recognized by any gsn contour drawing routine, allows you to select a dash pattern to use for contour lines that fall below the value 0.0. Use a value between 1 and 16 to get a dash pattern.

All other contour lines will b e set to solid, unless gsnContourPosLineDashPattern is set.

Default: 0 (solid line)

gsnContourPosLineDashPattern

This resource, recognized by any gsn contour drawing routine, allows you to select a dash pattern to use for contour lines that fall above the value 0.0. Use a value between 1 and 16 to get a dash pattern.

All other contour lines will b e set to solid, unless gsnContourNegLineDashPattern is set.

Available in version 4.3.0 and later.

Default: 0 (solid line)

gsnContourZeroLineThicknessF

This resource, recognized by any gsn contour drawing routine, allows you to set a line thickness scale factor for the zero contour line. A value of 2.0 will make the line twice as thick.

If you want to change the thicknesses of the non-zero lines, you can use the related resource gsnContourLineThicknessesScale.

Default: 1.0

gsnDebugWriteFileName

If you are having problems with a gsn_xxxxx plotting script (like gsn_csm_contour) and want to report it to an NCL developer, then set this resource to a string and rerun your script. This will cause three files to be written: 1) a netCDF file containing the data being passed to your plotting function and all the plot resources (and their values) that you set in your script, 2) a new NCL script that generates the same plot as your original script, using data and plot resource values stored in the new netCDF file, and 3) a resource file. The files will be called xxxx.nc, xxxx.ncl, and xxxx.res, respectively where xxxx is the value you set this resource to.

The intention of this resource is to help users so they don't have don't have to send us their full script and data when they want to report a plotting problem to us.

Available in version 4.3.1 and later.

Default: None

gsnDraw

This resource is recognized by all gsn functions that draw graphics. If set to False, then the graphics in question will not be drawn when the gsn function is called. See also gsnFrame.

Default: True

gsnFrame

This resource is recognized by all gsn functions that have a frame advance. If set to False, then the frame will not be advanced when the gsn function is called. See also gsnDraw.

Default: True

gsnHistogramBarColors

This resource allows you to specify colors for each bar in a histogram. You can use named color, index color, or RGB/A colors.

If you have two sets of bars, then you can input a 2 x nbars array of indexed or named colors, a 2 x nbars x 3 array of RGB values, or a 2 x nbars x 4 array of RGBA values. Using RGBA values allows you to use transparency if desired.

Available in version 6.4.0 and later.

Default: dynamic

gsnHistogramBarWidthPercent

This resource allows you to specify the width of the histogram bars as a percentage of the width of the bin that it falls in. The values must be in the range 0 to 100, and they must be smaller for comparison histograms.

Default: 66% (66.0) for single histograms, and 50% (50.) for dual histograms.

gsnHistogramBinIntervals

By default, gsn_histogram will pick the bin intervals for you, using either a set number of bins or a bin width. If you set this resource, then it will use these values for the bin class intervals. For example, to bin values between 1 and 2, 2 and 5, and 5 and 7, you would set gsnHistogramBinIntervals to (/1,2,5,7/).

The values will be binned as follows:

  1 <= bin_1 <  2 
  2 <= bin_2 <  5
  5 <= bin_3 <= 7

To specify a discrete value rather than a range, list the value twice. For example, to bin values between 1 and 2, 2 and 3, 3 and 4, and then count all values exactly equal to 4 and exactly equal to 5, you would set gsnHistogramBinIntervals to (/1,2,3,4,4,5,5/).

Note: no value will get counted twice. In the above example, values would be binned as follows:

  1 <= bin_1 < 2
  2 <= bin_2 < 3 
  3 <= bin_3 < 4 
  bin_3 = 4
  bin_4 = 5

Default: N/A

gsnHistogramBinMissing

If this resource is set to True, then when gsn_histogram is called, an extra bar will be included that counts the number of missing values in the data.

Default: False

gsnHistogramBinWidth

This resource allows you to set a bin width for class intervals when you call gsn_histogram. Depending on whether gsnHistogramSelectNiceIntervals is set to True, you will either get exactly bins of this size, or approximately this size. This resource does not work with the other histogram resources.

Default: N/A

gsnHistogramClassIntervals

Same as gsnHistogramBinIntervals.

Default: N/A

gsnHistogramCompare

If set to True, then two sets of histograms will be compared when you call gsn_histogram. Setting this resource to True requires that the first dimension of your input data be 2 (where index '0' represents the first field, and '1' represents the second field).

Default: False

gsnHistogramComputePercentages

If set to True, then percentage values will be calculated and put on the right axis (or top axis for a horizontal plot) when you call gsn_histogram. The default behavior is that missing values are not discarded in the percentage calculation. Thus, if you have 1000 values with 100 values missing and 100 values in bin "A", then the percentage calculation for bin "A" will be 10% (100/1000). If you don't want missing values included in the calculation, then set gsnHistogramComputePercentagesNoMissing to True.

Default: False

gsnHistogramComputePercentagesNoMissing

If this resource is set to True, then percentage values will be added to the right (or top) axis, and missing values won't be included in the percentage calculation when you call gsn_histogram. For example, if you have 1000 values with 100 of them missing, and 100 of them in bin "A", then the percentage calculation for bin "A" will be 11.1% (100/900) if this resource is True. Otherwise, the calculation will be 10% (100/1000). Note that if this resource is set to True, and you are comparing two datasets (gsnHistogramCompare = True), then both sets of data must either have no missing values, or exactly the same number of missing values. Otherwise, it won't make sense to have a percentage calculation. This resource will be forced to False if this situation arises.

Default: False

gsnHistogramDiscreteBinValues

By default, gsn_histogram will bin your data into bin intervals when you call gsn_histogram. If you set this resource, then your data is assumed to be already "binned", and it just counts the number of values exactly equal to the discrete values.

Default: N/A

gsnHistogramDiscreteClassValues

Same as gsnHistogramDiscreteBinValues.

Default: N/A

gsnHistogramHorizontal

If this resource is set to True when you call gsn_histogram, then the histogram bars will be drawn horizontally.

Default: False

gsnHistogramMinMaxBinsOn

If you set this resource to True when you call gsn_histogram, then two extra bins will be added: one that indicates all the values less than the smallest bin, and one that indicates all the values greater than the largest bin. This resource can only be used when gsnHistogramBinIntervals or gsnHistogramClassIntervals are set.

For example, if gsnHistogramBinIntervals is set to (/1,2,5,7/), then the values will be binned as follows:

       bin_1 <  1
  1 <= bin_2 <= 2 
  2 <  bin_3 <= 5
  5 <  bin_4 <= 7
  7 <  bin_5

Default: False

gsnHistogramNumberOfBins

Indicates number of bin intervals you want when you call gsn_histogram. Depending on whether gsnHistogramSelectNiceIntervals is set to True, you will either get exactly this many bins, or approximately this many bins.

Default: 10

gsnHistogramPercentSign

If gsnHistogramComputePercentages is set to True when you call gsn_histogram, then the right axis (top axis if doing a horizontal histogram) tickmark labels will contain the "%" symbol, instead of having "Percent" spelled out.

Default: False

gsnHistogramSelectNiceIntervals

Indicates whether "nice" values should be selected for the bin intervals when you call gsn_histogram.

Default: True

gsnLeftString

For any gsn_csm plotting routine, this resource adds the given string just above the plot's upper boundary and left-justifies it.

See other gsnLeftStringXXXX or gsnStringXXXX resources for ways to customize this string.

Default: data@long_name

gsnLeftStringFontColor

If gsnLeftString is set, this resource controls the font color of the string. This resource overrides gsnStringFontColor.

Available in version 5.1.1 and later.

Default: foreground (1)

gsnLeftStringFontHeightF

If gsnLeftString is set, this resource controls the font height of the string. This resource overrides gsnStringFontHeightF.

Default: dynamic

gsnLeftStringFuncCode

If gsnLeftString is set, this resource sets the function code for the string. This resource overrides gsnStringFuncCode.

Available in version 6.2.0 and later.

Default: ~

gsnLeftStringOrthogonalPosF

If gsnLeftString is set, this resource allows you to move this string up or down. Use small negative or positive values to nudge the string closer to or away from the plot boundary.

Default: dynamic

gsnLeftStringParallelPosF

If gsnLeftString is set, this resource allows you to move this string left or right. A value of 0.0 (the default) moves the plot to the left boundary of the plot, and a value of 1.0 moves it to the right boundary. A value of 0.5 centers it.

Default: 0.0

gsnLeftXRefLineBarColors

If gsnXRefLine is set and gsnXYBarChart is set to True, then this resource indicates what colors to use in filling the bars to the left of the given X reference line.

The colors will repeat if there are fewer colors than bars.

Available in version 6.4.0 and later.

Default: None

gsnLeftXRefLineBarFillScales

If gsnXRefLine is set, gsnXYBarChart is set to True, and gsnLeftXRefLineBarPatterns is set, then this resource indicates what fill scales to use for the fill patterns. Values less than 1.0 give you a more dense pattern.

Available in version 6.4.0 and later.

Default: 1.0

gsnLeftXRefLineBarPatterns

If gsnXRefLine is set and gsnXYBarChart is set to True, then this resource indicates what patterns to use in filling the bars to the left of the given X reference line. The gsnXYBarChartPatterns resource will be ignored.

The patterns will repeat if there are fewer patterns than bars.

Available in version 6.4.0 and later.

Default: 0 (solid fill)

gsnLeftXRefLineColor

If gsnXRefLine is set, then this resource fills the curve to the left of the X reference line with the given color.

Available in version 6.4.0 and later.

Default: None

gsnMajorLatSpacing

Used to indicate the latitude spacing to use for major tickmarks and their labels in any gsn_csm routine that is generating a cylindrical equidistant map and contains a latitude axis.

Default: dynamic

gsnMajorLonSpacing

Used to indicate the longitude spacing to use for major tickmarks and their labels in any gsn_csm routine that is generating a cylindrical equidistant map and contains a longitude axis.

Default: dynamic

gsnMaskLambertConformal

When set to True, turns on masking of a lambert conformal projection. Extent of mask is determined by the four resources mpMinLonF , mpMaxLonF, mpMinLatF, mpMaxLatF. This resource is only recognized by gsn_csm routines in which data is being overlaid on a lambert conformal projection (i.e. by calling one of the gsn_csm_xxxx_map routines and setting mpProjection to "LambertConformal").

Default: False

gsnMaskLambertConformalOutlineOn

If gsnMaskLambertConformal is set to True, then this resource indicates whether a border should be drawn around the masked plot.

Default: True

gsnMaximize

If set to True, then any plot drawn by a gsn function 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. You can get rid of this margin by setting gsnBoxMargin to 0.0. 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.

For a PS or PDF file, you can change the default paper size, margins, or orientation with the resources gsnPaperOrientation, gsnPaperMargin, gsnPaperWidth, and gsnPaperHeight.

Note: in NCL version 5.2.0, you can use better resources: wkPaperSize or wkPaperWidthF / wkPaperHeightF for setting the paper size, or the width and height. These resources can only be set when you call gsn_open_wks.

Default: False

gsnMinorLatSpacing

Used to indicate the latitude spacing to use for minor tickmarks and their labels in any gsn_csm routine that is generating a cylindrical equidistant map and contains a latitude axis.

Default: dynamic

gsnMinorLonSpacing

Used to indicate the longitude spacing to use for minor tickmarks and their labels in any gsn_csm routine that is generating a cylindrical equidistant map and contains a longitude axis.

Default: dynamic

gsnPanelBottom

By default, the gsn_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 gsnPanel* resources.

Default: 0.0

gsnPanelCenter

By default, the gsn_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

gsnPanelDebug

If you set this resource to True for the gsn_panel routine, then you will get some verbose information printed to the screen about what viewport coordinates are being used for the panelled plots. This information is useful if you want to panel the plots yourself, and you want some viewport values to start with.

Available in version 4.3.0 and later.

Default: False

gsnPanelFigureStrings

If you set this gsn_panel 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 resource amJust to change the location of the figure strings. ("TopRight", "TopLeft", or "BottomLeft" are the other choices.)

Default: none

gsnPanelFigureStringsBackgroundFillColor

If you set gsnPanelFigureStrings in a call to gsn_panel, then this resource allows you to control the background fill color of the box that surrounds each figure string. Default: 0 (background color)

gsnPanelFigureStringsFontHeightF

If you set gsnPanelFigureStrings in a call to gsn_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

gsnPanelFigureStringsJust

If you set gsnPanelFigureStrings in a call to gsn_panel, then this resource allows you to control the justification of the figure strings.

The first part of the string should be set to the desired vertical justifcation ("top", "center", "bottom"), and the second part to the desired horizontal justification ("left", "center", "right"). The default is to place the string at "BottomRight" of each plot.

This resource replaces the awkwardly named "amJust" resource that was previously used (this resource will still work, for backwards compatibility, but this new one will take precedence).

Available in version 6.4.0 and later.

Default: "BottomRight"

gsnPanelFigureStringsPerimOn

If you set gsnPanelFigureStrings in a call to gsn_panel, then this resource turns on the drawing of a box perimeter around each figure string. Default: False

gsnPanelLabelBar

If you set this gsn_panel resource to True, then a single labelbar will be generated for all the plots on the page. The default is to draw the labelbar on the bottom, unless lbOrientation is set to "Vertical". Note: using this resource assumes that all of your plots have the same labelbar!

Default: False

gsnPanelLabelBarScalePlotIndex

By default, the gsn_panel routine uses the first valid plot in its list to determine the levels and colors to use if gsnPanelLabelBar is set to True.

To change which plot in the array of plots to use for constructing the labelbar, you can set this resource to the desired plot index.

Available in version 6.6.0 and later.

Default: 0 or the id of the first valid plot in the list

gsnPanelLeft

By default, the gsn_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 gsnPanel* resources.

Default: 0.0

gsnPanelMainFont

Sets the font for the gsnPanelMainString title.

This resource replaces the awkwardly named "txFont" resource that was previously used (this resource will still work, for backwards compatibility, but this new one will take precedence).

Available in version 6.4.0 and later.

Default: "helvetica"

gsnPanelMainFontColor

Sets the font color for the gsnPanelMainString title.

This resource replaces the awkwardly named "txFontColor" resource that was previously used (this resource will still work, for backwards compatibility, but this new one will take precedence).

Available in version 6.4.0 and later.

Default: "black"

gsnPanelMainFontHeightF

Sets the font height for the gsnPanelMainString title.

This resource replaces the awkwardly named "txFontHeightF" resource that was previously used (this resource will still work, for backwards compatibility, but this new one will take precedence).

Available in version 6.4.0 and later.

Default: dynamic

gsnPanelMainPosXF

Sets the X location of the justification point for the panel main title in NDC coordinates.

Available in version 6.4.0 and later.

Default: <dynamic>

gsnPanelMainPosYF

Sets the Y location of the justification point for the panel main title in NDC coordinates.

Available in version 6.4.0 and later.

Default: <dynamic>

gsnPanelMainString

Creates a main title for paneled plots generated by gsn_panel.

This resource replaces the awkwardly named "txString" resource that was previously used (this resource will still work, for backwards compatibility, but this new one will take precedence).

Available in version 6.4.0 and later.

Default: ""

gsnPanelRight

By default, the gsn_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 gsnPanel* resources.

Default: 1.0

gsnPanelRowSpec

By default, the gsn_panel routine panels its plots according to the dims variable which indicates rows x columns. If you set gsnPanelRowSpec to True, however, then you can use the dims variable to indicate the number of plots you want per row. For example, setting gsnPanelRowSpec 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

gsnPanelScalePlotIndex

By default, the gsn_panel routine uses the first valid plot in its list to determine the scale factor for resizing all of the plots to be paneled. If your plots are slightly different sizes, you can use this resource to indicate the index of which plot should be used to determine the scale factor. This is especially useful if your first valid plot is smaller than one or more of the others in the list.

Available in version 5.1.0 and later.

Default: 0 or the id of the first valid plot in the list

gsnPanelTop

By default, the gsn_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 gsnPanel* resources.

Default: 1.0

gsnPanelXF

The gsn_panel routine calculates the NDC X and Y positions of the upper left corner of every plot on the panel. If you want to tweak any of the X positions, then you can set the gsnPanelXF resource to an array of the same length as the number of plots you want to panel, and give it the new NDC coordinates you want for the X positions.

If you want to keep any of the calculated values that gsn_panel uses, then set the corresponding gsnPanelXF value to a negative value. You can set gsnPanelDebug to True to find out what values are being used for the X and Y positions.

Available in version 4.3.0 and later.

Default: None

gsnPanelXWhiteSpacePercent

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 gsn_panel. See also the other gsnPanel* resources.

Default: 1.0

gsnPanelYF

The gsn_panel routine calculates the NDC X and Y positions of the upper left corner of every plot on the panel. If you want to tweak any of the Y positions, then you can set the gsnPanelYF resource to an array of the same length as the number of plots you want to panel, and give it the new NDC coordinates you want for the Y positions.

If you want to keep any of the calculated values that gsn_panel uses, then set the corresponding gsnPanelYF value to a negative value. You can set gsnPanelDebug to True to find out what values are being used for the X and Y positions.

Available in version 4.3.0 and later.

Default: None

gsnPanelYWhiteSpacePercent

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 gsn_panel. See also the other gsnPanel* resources.

Default: 1.0

gsnPaperHeight

This resource specifies the height (in inches) of the paper that you plan to print the PostScript or PDF file on. This resource only comes into effect if gsnMaximize is set to True. See also gsnPaperMargin, gsnPaperWidth, and gsnPaperOrientation.

Default: 11.0

gsnPaperMargin

This resource specifies the margin (in inches) that you want to leave around the plotting area if gsnMaximize is set to True and your output is going to a PS, EPS, EPSI, or PDF file. See also gsnPaperHeight, gsnPaperWidth, and gsnPaperOrientation.

If your output is X11 or NCGM, then you can use gsnBoxMargin to control the margin size.

Default: 0.5

gsnPaperOrientation

This resource specifies the orientation of the plot on paper that you plan to print the PostScript or PDF file on. This resource only comes into effect if gsnMaximize is set to True. Valid values are "portrait", "landscape", and "auto". If set to "auto", then NCL 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.

If you are not using gsnMaximize, then to control the orientation you can check out the wkOrientation resource.

Default: "auto"

gsnPaperWidth

This resource specifies the width (in inches) of the paper that you plan to print the PostScript or PDF file on. This resource only comes into effect if gsnMaximize is set to True. See also gsnPaperMargin, gsnPaperHeight, and gsnPaperOrientation.

Default: 8.5

gsnPolar

Controls what polar hemisphere is shown on polar sterographic plots generated by gsn_csm_xxxx_polar routines. Set to either "SH" or "NH"

Default: "NH"

gsnPolarLabelDistance

If one of the gsn_csm_xxxx_polar routines is called, this resource applies a scale to apply to the distance (in NDC coordinates) of the polar longitude labels from the map perimeter. A value of 1.0 will cause the labels to be right up against the perimeter.

Default: 1.04, which represents a 4% increase in the distance.

gsnPolarLabelFont

If one of the gsn_csm_xxxx_polar routines is called, this resource controls the font of the polar labels.

Default: dynamic

gsnPolarLabelFontHeightF

If one of the gsn_csm_xxxx_polar routines is called, this resource controls the font height of the polar lat/lon labels. Recall that these labels are special labels added by the template, and are not true tick mark labels.

Default: dynamic

gsnPolarLabelSpacing

If one of the gsn_csm_xxxx_polar routines is called, this resource sets the longitude spacing for the longitude labels.

Default: 30 or whatever mpGridLonSpacingF is set to.

gsnPolarTime

If this resource is set to True, then instead of getting longitude labels on polar sterographic plots generated by gsn_csm_xxxx_polar, you will get local time.

Default: False

gsnPolarUT

If gsnPolarTime is set to True, then this resource can be set to some value such that the local time axis is shifted in such a way that 0 LT is always at the bottom of the plot. For example, if gsnPolarUT is set to 12 UT, then the whole field is shifted by 180 degrees

Default: 0

gsnPresHgtHeightLabelOn

If gsnPresHgtHeightLabelOn is set to False, then the "height" label on the right Y axis will not be drawn when calling functions that plot pressure/height: gsn_csm_pres_hgt, gsn_csm_pres_hgt_streamline, and gsn_csm_pres_hgt_vector.

Default: True

gsnRightString

For any gsn_csm plotting routine, this resource adds the given string just above the plot's upper boundary and right-justifies it.

See other gsnRightStringXXXX or gsnStringXXXX resources for ways to customize this string.

Default: data@units

gsnRightStringFontColor

If gsnRightString is set, this resource controls the font color of the string. This resource overrides gsnStringFontColor.

Available in version 5.1.1 and later.

Default: foreground (1)

gsnRightStringFontHeightF

If gsnRightString is set, this resource controls the font height of the string. This resource overrides gsnStringFontHeightF.

Default: dynamic

gsnRightStringFuncCode

If gsnRightString is set, this resource sets the function code for the string. This resource overrides gsnStringFuncCode.

Available in version 6.2.0 and later.

Default: ~

gsnRightStringOrthogonalPosF

If gsnRightString is set, this resource allows you to move this string up or down. Use small negative or positive values to nudge the string closer to or away from the plot boundary.

Default: dynamic

gsnRightStringParallelPosF

If gsnRightString is set, this resource allows you to move this string left or right. A value of 0.0 moves the plot to the left boundary of the plot, and a value of 1.0 (the default) moves it to the right boundary. A value of 0.5 centers it.

Default: 1.0

gsnRightXRefLineBarColors

If gsnXRefLine is set and gsnXYBarChart is set to True, then this resource indicates what colors to use in filling the bars to the right of the given X reference line.

The colors will repeat if there are fewer colors than bars.

Available in version 6.4.0 and later.

Default: None

gsnRightXRefLineBarFillScales

If gsnXRefLine is set, gsnXYBarChart is set to True, and gsnRightXRefLineBarPatterns is set, then this resource indicates what fill scales to use for the fill patterns. Values less than 1.0 give you a more dense pattern.

Available in version 6.4.0 and later.

Default: 1.0

gsnRightXRefLineBarPatterns

If gsnXRefLine is set and gsnXYBarChart is set to True, then this resource indicates what patterns to use in filling the bars to the right of the given X reference line. The gsnXYBarChartPatterns resource will be ignored.

The patterns will repeat if there are fewer patterns than bars.

Available in version 6.4.0 and later.

Default: 0 (solid fill)

gsnRightXRefLineColor

If gsnXRefLine is set, then this resource fills the curve to the right of the X reference line with the given color.

Available in version 6.4.0 and later.

Default: None

gsnScalarContour

If set to True when calling any gsn_csm vector/contour routine, the third field will be drawn as a separate contour field. Otherwise, the vectors will be colored according to the third field.

Default: False

gsnScale

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 in any gsn function that creates tickmarks. 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. See also gsnShape.

Default: False

gsnShadeFillDotSizeF

This resource only works with the gsn_contour_shade function. It allows you to control the size (in NDC units) of the dots when doing a stipple pattern fill (pattern #17).

The default value of 0.0 causes the dots to be drawn using a workstation dependent minimum dot size. Caveat: individual dots are not clipped around the edges of fill areas; this becomes more noticeable as the dot size increases.

Available in version 6.5.0 and later.

Default: 0.0

gsnShadeFillScaleF

This resource only works with the gsn_contour_shade function. It allows you to control the density for pattern fill using a scalar floating point value.

A value greater than 1.0 makes the pattern spacing bigger than the default spacing, resulting in a fill that appears less dense. A value less than 1.0 has the opposite effect. Values less than or equal to 0.0 are invalid.

This resource will be applied across all three levels of shading allowed by gsn_contour_shade (gsnShadeLow, gsnShadeMid, gsnShadeHigh). If you want to set individual fill scales for each level of shading, see gsnShadeFillScales.

Available in version 6.5.0 and later.

Default: 1.0

gsnShadeFillScales

This resource only works with the gsn_contour_shade function. It allows you control the densities for the three shading levels using an array of three scalar floating point values.

Values greater than 1.0 make the pattern spacing bigger than the default spacing, resulting in a fill that appears less dense. Values less than 1.0 has the opposite effect. Values less than or equal to 0.0 are invalid.

If you want to set a single fill scale across three levels of shading, see gsnShadeFillScaleF.

Available in version 6.5.0 and later.

Default: 1.0

gsnShadeFillType

This resource only works with the gsn_contour_shade function. It allows you specify whether you want color fill or pattern fill for the given levels of shading. Set to "color" or "pattern".

Default: "color"

gsnShadeHigh

This resource only works with the gsn_contour_shade function. It allows you to specify a fill pattern or color to use when filling areas greater than a specified high value. It can be used in conjunction with gsnShadeLow and gsnShadeMid.

Default: None

gsnShadeLow

This resource only works with the gsn_contour_shade function. It allows you to specify a fill pattern or color to use when filling areas less than a specified low value. It can be used in conjunction with gsnShadeMid and gsnShadeHigh.

Default: None

gsnShadeMid

This resource only works with the gsn_contour_shade function. It allows you to specify a fill pattern or color to use when filling areas greater than a specified low value and less than a specified high value. It can be used in conjunction with gsnShadeLow and gsnShadeHigh.

Default: None

gsnShape

If set to True in any non-map gsn function that has an X and Y axis, then whichever axis has the smaller range will be resized so that the ratio of the axes ranges is the same as the ratio of the axes lengths. For example, if the Y axis ranges from 1 to 50, and the X axis ranges from 1 to 100, then setting gsnShape to True will cause the Y axis to be resized to half the length of the X axis. If this resource is set to True, then gsnScale is also automatically set to True.

Default: False

gsnSpreadColorEnd

This resource only takes effect if gsnSpreadColors 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 gsnSpreadColorStart.

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

Default: -1

gsnSpreadColorStart

This resource only takes effect if gsnSpreadColors 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 gsnSpreadColorEnd.

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

Default: 2

gsnSpreadColors

In NCL version 6.1.0 and later, this resource is superceded by the use of new resources cnSpanFillPalette, vcSpanLevelPalette, and stSpanLevelPalette. For backwards compatibility, if gsnSpreadColorStart is set to something other than 2, and/or gsnSpreadColorEnd is set to something other than -1, *and* you haven't set gsnSpreadColors to False, then the xxSpanxxxPalette resources will be ignored, and your color map will be spanned according to the index values indicated by gsnSpreadColorStart and gsnSpreadColorEnd.

Otherwise, in NCL V6.0.0 and earlier, if this resource is set to True when calling any gsn function that produces vectors and/or contours, then the colors used will be spread across the whole color map. See also gsnSpreadColorStart and gsnSpreadColorEnd.

Default: deprecated in V6.1.0 and higher (False in V6.0.0 and earlier)

gsnStringFont

If any of gsnLeftString, gsnCenterString, or gsnRightString are set, this resource controls the font of these strings.

Default: dynamic

gsnStringFontColor

If any of gsnLeftString, gsnCenterString, or gsnRightString are set, this resource controls the font color of these strings.

You can use gsnLeftStringFontColor, gsnCenterStringFontColor, or gsnRightStringFontColor to control the individual colors of each string.

Available in version 5.1.1 and later.

Default: foreground (1)

gsnStringFontHeightF

If any of gsnLeftString, gsnCenterString, or gsnRightString are set, then this resource controls the font height of these strings. This resource can be overridden by setting the individual resources gsnLeftStringFontHeightF, gsnRightStringFontHeightF, or gsnCenterStringFontHeightF.

Default: dynamic

gsnStringFuncCode

If any of gsnLeftString, gsnCenterString, or gsnRightString are set, then this resource sets the function code for these strings. This resource can be overridden by setting the individual resources gsnLeftStringFuncCode, gsnRightStringFuncCode, or gsnCenterStringFuncCode.

Available in version 6.2.0 and later.

Default: ~

gsnTickMarksOn

If set to False, then no tickmarks or tickmark labels will be drawn in the gsn functions where tickmarks are drawn automatically. This also works for the polar map plots that have longitude labels drawn around the circumference.

Default: True

gsnXAxisIrregular2Linear

If set to True, then the X axis will be linearized for any contour, vector, or streamline plot created by a gsn function. This resource should only be set to True if coordinate arrays are being used to define your X axis values, and they are not linear.

Default: False

gsnXAxisIrregular2Log

If set to True, then the X axis will be changed to log scaling for any contour, vector, or streamline plot created by a gsn function. This resource should only be set to True if coordinate arrays are being used to define your X axis values, and they are not linear. Otherwise, you can just use the trXLog resource to indicate you want log scaling.

Default: False

gsnXRefLine

Draws a vertical line at the given X value in the gsn_csm_xy function.

Default: None

gsnXRefLineColor

If gsnXRefLine is set, this resource indicates the color of the line.

Default: 1 (foreground color)

gsnXRefLineColors

If gsnXRefLine is set to multiple reference lines, this resource indicates the color of each line.

Available in version 6.4.0 and later.

Default: 1 (foreground color)

gsnXRefLineDashPattern

If gsnXRefLine is set, this resource indicates the dash pattern of the line.

Default: 0 (solid line)

gsnXRefLineDashPatterns

If gsnXRefLine is set to multiple reference lines, this resource indicates the dash pattern of each line.

Available in version 6.4.0 and later.

Default: 0 (solid lines)

gsnXRefLineThicknessF

If gsnXRefLine is set, this resource indicates a scale factor for the thickness of the line. A value of 2.0 doubles the thickness.

Default: 1.0

gsnXRefLineThicknesses

If gsnXRefLine is set to multiple reference lines, this resource indicates a scale factor for the thickness of each line. A value of 2.0 doubles the thickness.

Available in version 6.4.0 and later.

Default: 1.0

gsnXYAboveFillColors

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 gsn_csm_xy function.

It should be set to an array of colors that has one fewer values than you have curves. This resource was updated in NCL V6.4.0 to allow for RGB/A color.

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 gsnXYBelowFillColors. If you want to fill between two curves that do not intersect, see gsnXYFillColors.

Available in version 5.1.0 and later.

Default: None

gsnXYBarChart

If set to True, this will turn an gsn_csm_xy line plot into a vertical bar chart, where each bar is an individual Y value.

As of Available in version 6.4.0 and later., if you set gsnXRefLine, then you will get a horizontal bar chart.

Default: False

gsnXYBarChartBarWidth

If gsnXYBarChart is set, then this resource allows the user to control the width of the bars. By default, the width of the bars is the distance between each X or Y value (dx or dy). To get a bar width that is half the default, then, use a value of dx/2 (dy/2). If you have multiple curves, then you can set an array of bar widths, one for each curve.

Default: dynamic

gsnXYBarChartColors

If gsnXYBarChart is set, then this resource controls the colors of individual bars for charts without a reference line.

Default: None

gsnXYBarChartColors2

If gsnXYBarChart is set, then this resource controls the colors of individual bars and assigns the colors consecutively, regardless of whether the bar is up or down for vertical bar plots, or left or right for horizontal bar plots.

Default: None

gsnXYBarChartFillDotSizeF

If gsnXYBarChart is set to True, and the bars are filled with the stipple dot fill pattern, then this resource allows you to increase the dot size.

The default value of 0.0 causes the dots to be drawn as before, using a workstation dependent minimum dot size. A caveat is that individual dots are not clipped around the edges of fill areas; this becomes more noticeable as the dot size increases.

Available in version 6.2.0 and later.

Default: 0.0

gsnXYBarChartFillLineThicknessF

If gsnXYBarChart is set to True, and the bars are filled with a non-solid pattern, then this resource controls the thickness of the lines in the fill pattern.

Available in version 6.2.0 and later.

Default: 1.0

gsnXYBarChartFillOpacityF

If gsnXYBarChart is set to True, and the bars are filled with a solid color, then this resource indicates what fill opacity value to use for the fill colors. Values closer to 0 give you less opacity, and values close to 1.0 give you more opacity. Available in version 6.2.0 and later.

Default: 1.0

gsnXYBarChartFillScaleF

If gsnXYBarChart is set to True, and the bars are filled with a non-solid pattern, then this resource indicates what fill scale to use for the fill pattern. Values less than 1.0 give you a more dense pattern.

Available in version 6.2.0 and later.

Default: 1.0

gsnXYBarChartOutlineOnly

If gsnXYBarChart is set, then setting this resource to True indicates you want an outline of the bars, and not each individual bar outlined.

Default: False

gsnXYBarChartOutlineThicknessF

If gsnXYBarChart is set to True, then this resource controls the thickness of the bar outlines.

Available in version 5.2.1 and later.

Default: 1.0

gsnXYBarChartPatterns

If gsnXYBarChart is set, then this resource controls the patterns of individual bars for charts w/o a reference line.

Default: None

gsnXYBarChartPatterns2

If gsnXYBarChart is set, then this resource controls the patterns of individual bars and assigns the patterns consecutively regardless of whether the bar is up or down for vertical bar plots, or left or right for horizontal bar plots.

Default: None

gsnXYBelowFillColors

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 gsn_csm_xy function.

It should be set to an array of colors that has one fewer values than you have curves. This resource was updated in NCL V6.4.0 to allow for RGB/A color.

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 gsnXYAboveFillColors.

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

Available in version 5.1.0 and later.

Default: None

gsnXYFillColors

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 gsn_csm_xy function.

It should be set to an array of colors that has one fewer values than you have curves. This resource was updated in NCL V6.4.0 to allow for RGB/A color.

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 gsnXYAboveFillColors and gsnXYBelowFillColors.

Available in version 5.1.0 and later.

Default: None

gsnXYFillOpacities

This resource can be used to indicate opacity values to use for filled curves that overlap when you set gsnXYFillColors. It should be an array of values between 0.0 and 1.0.

Note: there's a bug in V6.2.0 that causes this resource to not work if you only have gsnXYBelowFillColors set. To work around this issue, you need to set gsnXYAboveFillColors to an array of the same size as gsnXYBelowFillColors, but just set it to all -1 or "transparent" so it doesn't have any effect.

Available in version 6.2.0 and later.

Default: 1.0

gsnXYLeftFillColors

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 gsn_csm_xy function.

It should be set to an array of colors that has one fewer values than you have curves. This resource was updated in NCL V6.4.0 to allow for RGB/A color.

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 gsnXYRightFillColors. If you want to fill between two curves that do not intersect, see gsnXYFillColors.

Available in version 6.4.0 and later.

Default: None

gsnXYRightFillColors

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 gsn_csm_xy function.

It should be set to an array of colors that has one fewer values than you have curves. This resource was updated in NCL V6.4.0 to allow for RGB/A color.

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 gsnXYLeftFillColors. If you want to fill between two curves that do not intersect, see gsnXYFillColors.

Available in version 6.4.0 and later.

Default: None

gsnYAxisIrregular2Linear

If set to True, then the Y axis will be linearized for any contour, vector, or streamline plot created by a gsn function. This resource should only be set to True if coordinate arrays are being used to define your Y axis values, and they are not linear.

Default: False

gsnYAxisIrregular2Log

If set to True, then the Y axis will be changed to log scaling for any contour, vector, or streamline plot created by a gsn function. This resource should only be set to True if coordinate arrays are being used to define your Y axis values, and they are not linear. Otherwise, you can just use the trYLog resource to indicate you want log scaling.

Default: False

gsnYRefLine

Draws a horizontal line at the given Y value in the gsn_csm_xy function.

Default: None

gsnYRefLineColor

If gsnYRefLine is set, this resource indicates the color of the line.

Default: 1 (foreground color)

gsnYRefLineColors

If gsnYRefLine is set to multiple reference lines, this resource indicates the color of each line.

Default: 1 (foreground color)

gsnYRefLineDashPattern

If gsnYRefLine is set, this resource indicates the dash pattern of the line.

Default: 0 (solid line)

gsnYRefLineDashPatterns

If gsnYRefLine is set to multiple reference lines, this resource indicates the dash pattern of each line.

Default: 0 (solid line)

gsnYRefLineThicknessF

If gsnYRefLine is set, this resource indicates a scale factor for the thickness of the line. A value of 2.0 doubles the thickness.

Default: 1.0

gsnYRefLineThicknesses

If gsnYRefLine is set to multiple reference lines, this resource indicates a scale factor for the thickness of each line. A value of 2.0 doubles the thickness.

Default: 1.0

gsnZonalMean

If set to True, then a zonal mean plot is drawn on the right side of a contour/map plot generated by one of the gsn_csm_contour_map_ce or gsn_csm_contour_map routines (it will not work with polar plots). For versions version 5.0.0 and earlier, this resource only works with cylindrical equidstant projections.

Default: False

gsnZonalMeanXMaxF

If gsnZonalMean is set to True, then this resource allows the user to set the maximum value of the X axis of the attached zonal mean plot.

Default: dynamic

gsnZonalMeanXMinF

If gsnZonalMean is set to True, then this resource allows the user to set the minimum value of the X axis of the attached zonal mean plot.

Default: dynamic

gsnZonalMeanYRefLine

If gsnZonalMean is set to True, then this resource draws a horizontal line at the given value.

Default: dynamic