Alphabetical list of NCL resources

amDataXF

When amTrackData is True, amDataXF sets the X coordinate of the annotation item's base location.

Default: 0.0

amDataYF

When amTrackData is True, amDataYF sets the Y coordinate of the annotation item's base location.

Default: 0.0

amJust

This resource of type NhlTJustification, after constraint to an appropriate value based on amSide, sets the justification point of the annotation with respect to its base location. The PlotManager Location Control Model requires this resource to allow control of the annotation in a manner consistent with other annotations. Note that amJust still has an effect when amTrackData is True. Normally, amJust is constrained based on the value of amSide. However, if amZone is 0 or 1, or amTrackData is True, the PlotManager does not constrain amJust.

Note in addition that the position of the justification point is determined from the viewport of the annotation View object only. That is to say, while it is possible that View object's bounding box might be larger than its viewport, any extent outside the viewport is not considered when determining the justification point. This means that that there is the possibility of overlap if a View object has elements extending outside its own viewport along the edge closest to the PlotManager Plot viewport.

Default: CenterCenter

amOn

This boolean resource specifies whether the base plot should draw the annotation View object along with the other objects comprising the plot.

Default: True

amOrthogonalPosF

If amTrackData is False and amZone is not equal to one, amOrthogonalPosF sets the coordinate of the base location of the annotation orthogonal to the current amSide and directed away from the center of the PlotManager viewport. If amZone is equal to one, the direction is from the viewport side specified by amSide toward the viewport center. The PlotManager Location Control Model requires this resource to allow control of the annotation in a manner consistent with other annotations.

Default: 0.0

amParallelPosF

If amTrackData is False, amParallelPosF specifies the coordinate of the base location of the annotation parallel to the current amSide and directed toward increasing NDC values. The PlotManager Location Control Model requires this resource to allow control of the annotation in a manner consistent with other annotations.

Default: 0.0

amResizeNotify

If this boolean resource is True, the PlotManager sets the height and width of the annotation item whenever the size of the base plot's viewport changes. Height is adjusted based on the ratio of the new viewport height to the old height. Width is adjusted based on the ratio of the new viewport width to the old width.

Default: False

amSide

If amTrackData is False, this resource of type NhlTPosition determines which of the zone's interior sides to use as a base for establishing the coordinate system within which the annotation is placed. The PlotManager Location Control Model requires this resource to allow control of the annotation in a manner consistent with other annotations. Its value determines the origin of the coordinate system and the direction of the positional resources, amParallelPosF and amOrthogonalPosF. It also constrains the value of amJust appropriately. There are four settings, which behave as follows, unless amZone is set to one of the special zones (0 or 1):

NhlTOP

The PlotManager locates the annotation relative to a line paralleling the top viewport boundary. amOrthogonalPosF increases in the direction of increasing NDC Y-Axis values and is constrained to positive values. amParallelPosF increases in the direction of increasing NDC X-Axis values. amJust is constrained to NhlBOTTOMRIGHT, NhlBOTTOMCENTER, or NhlBOTTOMLEFT.

NhlBOTTOM

The PlotManager locates the annotation relative to a line paralleling the bottom viewport boundary. amOrthogonalPosF increases in the direction of decreasing NDC Y-Axis values and is constrained to positive values. amParallelPosF increases in the direction of increasing NDC X-Axis values. amJust is constrained to NhlTOPRIGHT, NhlTOPCENTER, or NhlTOPLEFT.

NhlRIGHT

The PlotManager locates the annotation relative to a line paralleling the right viewport boundary. amOrthogonalPosF increases in the direction of increasing NDC X-Axis values and is constrained to positive values. amParallelPosF increases in the direction of increasing NDC Y-Axis values. amJust is constrained to NhlTOPLEFT, NhlCENTERLEFT, or NhlBOTTOMLEFT.

NhlLEFT

The PlotManager locates the annotation item relative to a line paralleling the left viewport boundary. amOrthogonalPosF increases in the direction of decreasing NDC X-Axis values and is constrained to positive values. amParallelPosF increases in the direction of increasing NDC Y-Axis values. amJust is constrained to NhlTOPRIGHT, NhlCENTERRIGHT, or NhlBOTTOMRIGHT.

If amZone is set to 0, the PlotManager locates the annotation item relative to the viewport center. If amZone is 1, the annotation is located relative to the viewport boundary itself, and the direction of the amOrthogonalPosF is opposite to the specification given above. Also if the amZone is either 0 or 1, amJust is not constrained, and amOrthogonalPosF may take on negative values.

Default: Bottom

amTrackData

When amTrackData is set False, the PlotManager locates the annotation View object in NDC space using the PlotManager Location Control Model resources amZone, amSide, amParallelPosF, amOrthogonalPosF and amJust. If amTrackData is True, the annotation is positioned relative to the data coordinate space of the base plot. In this case, the PlotManager determines the base position of the annotation item from the values of the resources amDataXF and amDataYF. The resources amZone, amSide, amParallelPosF, and amOrthogonalPosF are ignored. However, the resource amJust still determines the justification point of the annotation with respect to its base location.

Default: False

amViewId

You can use this resource to retrieve the id of the View object controlled by the AnnoManager. Note that this resource can be set only when the AnnoManager object is created.

Default: <dynamic>

amZone

If amTrackData is False, amZone specifies the PlotManager zone assigned to the annotation. amZone is one of the resources you must set in order to control the location of the annotation in a manner consistent with the rules of the PlotManager Location Control Model. If amZone is set to 0, the annotation is located relative to the center of the PlotManager viewport; otherwise, it is located relative to one side of the zone's interior boundary, which is the bounding box of the previous zone.

Default: 0

appDefaultParent

This resource is only True for one App object at a time. If it is True in a given App object, then that App object is the one that will be used as the parent of any objects created with the parentid argument of NhlCreate set to NhlDEFAULT_APP or 0.

Default: <dynamic>
This resource defaults to True for the First App object created, otherwise it is False.

appFileSuffix

This resource is used to specify a suffix for the Application specific resource files. It is useful to set this resource in the $(NCARG_USRRESFILE) and $(NCARG_SYSRESFILE), if an application programmer wants to provide more than one Application Specific Resource file. For example, if some of the end users do not have color monitors, then there could be two resource files. One appname.bw.res, and another appname.color.res. Then the appFileSuffix resource can be specified to indicate which Application specific resource file to use.

Default: .res

appResources

This resource specifies an array of names. Each one of these names dynamically becomes a valid resource for the App object. This is a very useful feature for developers of multi-user applications because configuration parameters for the application can become resources to the App object. Then, users of the application can configure the application using the same resource files that they use to configure the HLU portion of the application.

Default: NULL

appSysDir

This resource is used to indicate what directory the App object should look in for the System application specific resource file.

Default: <dynamic>
This resource defaults to the value of the $(NCARG_SYSAPPRES) environment variable.

appUsrDir

This resource is used to indicate what directory the App object should look in for the User's application specific resource file.

Default: ./ (Current Working Directory)

caCopyArrays

This resource is used to determine if the CoordArrays object should make its own copy of the caXArray and caYArray data. If this resource is False, it is important for the programmer to keep the data around without modifying it. However; it is more efficient--if more dangerous--that way.

Default: True

caXArray

This resource specifies the X values of the X/Y coordinate data. It is an array of X values. If it is a one-dimensional array, then it specifies a single vector of X values. If it is a two-dimensional array, then the caXCast resource is used to determine which dimension indicates the number of vectors, and which dimension indicates the number of elements within each vector. If the caXArray resource is not set, then all of the Y values set with the caYArray resource will be paired with their integer array index. For example, assuming caYCast is MultipleVectors and C syntax:

(1, yarray[0][0])
(2, yarray[0][1])
(N, yarray[0][N-1])

If the caXArray resource is not set, then the caYArray resource must be set.

Default: NULL

caXCast

This resource is used to tell the CoordArrays object how to interpret the caXArray resource. The three valid values are:

SingleVector

The value SingleVector indicates that the caXArray provides the data for a single vector. This vector will be reused to match every vector specified by the caYArray. If the caXArray resource is set with a one-dimensional array, then the entire array will be used for the vector. If the caXArray resource is set with a two-dimensional array, then the vector will be made up from the values in the fastest-changing dimension. For example, in pseudo C array notation:

float	xarray[0][0-(N-1)];

In pseudo Fortran array notation:

REAL	XARR(1-N,1)

Where N is the length of the given dimension.

MultipleVectors

The value MultipleVectors indicates that if the caXArray resource is set with a one-dimensional array, then the entire array is used to specify a single vector that is not reused. If the caXArray resource is set with a two-dimensional array, then the caXArray has the array ordered such that the fastest-changing dimension contains the elements of each vector, and the other dimension contains the vectors. For example, in pseudo C array notation:

float	xarray[NUM_VECTORS][NUM_ELEMENTS];

In pseudo Fortran array notation:

REAL	XARR(NUM_ELEMENTS,NUM_VECTORS)

SplitVectors

The value SplitVectors indicates that the caXArray has the array ordered such that the fastest-changing dimension contains the vectors, and the other dimension contains the elements. For example, in pseudo C array notation:

float	xarray[NUM_ELEMENTS][NUM_VECTORS];

In pseudo Fortran array notation:

REAL	XARR(NUM_VECTORS,NUM_ELEMENTS)

Default: <dynamic>
If the caXArray resource is specified with a one-dimensional array or not at all, then the default value is SingleVector. Otherwise, the default value is MultipleVectors.
NOTE: If the caXCast resource is set to SplitVectors, then the caXArray resource will need to be reordered and copied internally so it is not as efficient.

caXMaxV

This resource is used to tell the CoordArrays object the maximum value contained in the caXArray resource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caXMinV

This resource is used to tell the CoordArrays object the minimum value contained in the caXArray resource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caXMissingV

This resource indicates a missing value for the elements in the caXArray resource. When the HLU library is parsing the data in the caXArray elements, it will treat any element with this value as missing data. This resource has a dynamic type so that elements of any type can be set to it.

Default: None

caYArray

This resource specifies the Y values of the X/Y coordinate data. It is an array of Y values. If it is a one-dimensional array, then it specifies a single vector of Y values. If it is a two-dimensional array, then the caYCast resource is used to determine which dimension indicates the number of vectors, and which dimension indicates the number of elements within each vector. If the caYArray resource is not set, then all of the X values set with the caXArray resource will be paired with their integer array index. For example, assuming caYCast is MultipleVectors and C array syntax:

(xarray[0][0],1)
(xarray[0][1],2)
(xarray[0][N-1],N)

If the caYArray resource is not set, then the caXArray resource must be set.

Default: NULL

caYCast

This resource is used to tell the CoordArrays object how to interpret the caYArray resource. The three valid values are:

SingleVector

The value SingleVector indicates that the caYArray provides the data for a single vector. This vector will be reused to match every vector specified by the caXArray. If the caYArray resource is set with a one dimensional array, then the entire array will be used for the vector. If the caYArray resource is set with a two dimensional array, then the vector will be made up from the values in the fastest changing dimension. For example, in pseudo C array notation:

float	yarray[0][0-(N-1)];

In pseudo Fortran array notation:

REAL	YARR(1-N,1)

Where N is the length of the given dimension.

MultipleVectors

The value MultipleVectors indicates that if the caYArray resource is set with a one-dimensional array, then the entire array is used to specify a single vector that is not reused. If the caYArray resource is set with a two-dimensional array, then the caYArray has the array ordered such that the fastest-changing dimension contains the elements of each vector, and the other dimension contains the vectors. For example, in pseudo C array notation:

float	yarray[NUM_VECTORS][NUM_ELEMENTS];

In pseudo Fortran array notation:

REAL	YARR(NUM_ELEMENTS,NUM_VECTORS)

SplitVectors

The value SplitVectors indicates that the caYArray has the array ordered such that the fastest-changing dimension contains the vectors, and the other dimension contains the elements. For example, in pseudo C array notation:

float	yarray[NUM_ELEMENTS][NUM_VECTORS];

In pseudo Fortran array notation:

REAL	YARR(NUM_VECTORS,NUM_ELEMENTS)

Default: <dynamic>
If the caYArray resource is specified with a one-dimensional array or not at all, then the default value is SingleVector. Otherwise, the default value is MultipleVectors.
Note: If the caYCast resource is set to SplitVectors, then the caYArray resource will need to be reordered and copied internally so it is not as efficient.

caYMaxV

This resource is used to tell the CoordArrays object the maximum value contained in the caYArrayresource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caYMinV

This resource is used to tell the CoordArrays object the minimum value contained in the caYArray resource. If it is not specified, the CoordArrays object will compute it. This resource has a dynamic type so that elements of any type can be set to it.

Default: <dynamic>
The value will be computed if it is not set.

caYMissingV

This resource indicates a missing value for elements in the caYArray resource. When the HLU library is parsing the data in the caYArray elements, it will treat any element with this value as missing data. This resource has a dynamic type so that elements of any type can be set to it.

Default: None

cnCellFillEdgeColor

If cnFillMode is set to CellFill, this resource specifies the color used to draw boundaries around the edges of the data grid cells that contain valid non-missing values. If set to the default value, Transparent, the boundaries do not appear.

You can use a color index value (integer) or a named color (string).

Default: Transparent (-1)

cnCellFillMissingValEdgeColor

If cnFillMode is set to CellFill, this resource specifies the color used to draw boundaries around the edges of the data grid cells that contain missing values. If set to the default value, Transparent, the boundaries do not appear.

You can use a color index value (integer) or a named color (string).

Default: Transparent (-1)

cnConpackParams

This string array resource allows you limited access to a number of parameters belonging to the LLU Conpack package, in order to control certain plot features for which ContourPlot does not yet have native resources. Each element of the array is a string consisting of a Conpack parameter name and its desired value separated by the colon character. Here is an example of its use in a resource file:

*cnConpackParams: (/ RC1:0.05 , RC2:0.1 , RC3:0.05 , \
	PC1:7.0 , PC2:20.0 , PC3:120.0 , PC4:0.01 , PC5:0.05 , PC6:0.05 , \
	PW1:0.0 , PW2:0.0 , PW3:0.0 , PW4:0.0 /)

If set programmatically, each string element would need to quoted as appropriate for the source language. The example given above includes all the parameters that affect the density of line labels when the cnLineLabelPlacementMode is set to Randomized or Computed. The example values should normally result in the appearance of more labels than the default settings. See the Conpack parameter descriptions for more information.

Note that the only Conpack parameters accessible using the cnConpackParams resource are ones that ContourPlot does not set internally and are unlikely to have an interaction with parameters that ContourPlot does set. Here is a categorized list of the Conpack parameters that can be set using cnConpackParams:

Contour hachuring control

• HCL
• HCS
• HCF

High/low label density

• HLX
• HLY

Computed placement mode ("Penalty scheme" in Conpack) label density

• PC1
• PC2
• PC3
• PC4
• PC5
• PC6
• PW1
• PW2
• PW3
• PW4

Randomized placement mode ("Regular scheme" in Conpack) label density

• RC1
• RC2
• RC3

Point interpolation for lines and edges

• PIC
• PIE

Note that you cannot get the value of cnConpackParams. Attempts to do so will result in an error.

Default: NULL

cnConstFLabelAngleF

This resource specifies the angle, in degrees, of the constant field label text and its surrounding box.

Default: 0.0

cnConstFLabelBackgroundColor

This resource sets the background color used to fill the box surrounding the constant field label. If you do not want the box to be filled at all, set cnConstFLabelBackgroundColor to Transparent (-1).

You can use a color index value (integer) or a named color (string).

Default: Background (0)

cnConstFLabelConstantSpacingF

Normally when cnLineLabelFontQuality is set to High, the ContourPlot object writes constant field label text with proportional spacing. Setting the cnConstFLabelConstantSpacingF to a value greater than 0.0 overrides this behavior. Instead, the distance from the start of one character to the next is computed by multiplying a single standard character width by the value of cnLineLabelConstantSpacingF. When cnLineLabelConstantSpacingF has a value between 0.0 and 1.0, characters will overlap. A value of 1.0 implies, on average, no space between characters, while values increasing from 1.0 cause the space between characters to grow. This parameter is ignored when cnConstFLabelFontQuality is not High. Values less than 0.0 result in an error and are replaced with the default value.

Default: 0.0

cnConstFLabelFont

This resource of type NhlTFont specifies the font used to render the constant field label.

Default: "pwritx"

cnConstFLabelFontAspectF

This resource determines the shape of the constant field label characters. Values increasing from 1.0 result in thinner characters. Values decreasing from 1.0 make the characters wider. Values less than or equal to 0.0 result in a WARNING message and a restoration of the default value.

Default: 1.3125

cnConstFLabelFontColor

This resource specifies the color to use for drawing constant field label text.

You can use a color index value (integer) or a named color (string).

Default: True

cnConstFLabelFontHeightF

This resource controls the height, in NDC units, of characters used in the text of the constant field label. The character width scales proportionally, unless you also modify the aspect ratio using the cnConstFLabelFontAspectF resource. The constant field label text height scales with changes to the viewport width, unless you explicitly set cnConstFLabelFontHeightF during the same call.

Default: <dynamic> -- 0.012 for a viewport width of 0.6

cnConstFLabelFontQuality

This resource of type NhlTFontQuality determines the quality of the font used to draw the ContourPlot constant field label.

Default: High

cnConstFLabelFontThicknessF

Sets the thickness of the line used to draw constant field label text. The value acts as a multiplier of a (device-dependent) unit thickness. This resource is ignored when the cnConstFLabelFont specifies a filled font (font indexes 21-22, 25-26, 29-30, and 33-37).

Default: 1.0

cnConstFLabelFormat

The cnConstFLabelFormat resource is a string that specifies the printing format for the number generated from a substitution substring in the cnConstFLabelString according to the HLU Floating Point Format Specification scheme. If any of the numerical format parameters have the dynamic attribute on, the corresponding parameter in the cnMaxDataValueFormat resource determines the parameter's value. The default value uses the shorthand notation '*+' to cause all numeric format parameters to be determined dynamically.

Default: "*+^sg"

cnConstFLabelFuncCode

This resource of type NhlTCharacter sets the function code character that the low level utilities will use when parsing the constant field label string.

Default: :

cnConstFLabelJust

This resource of type NhlTJustification, after constraint to an appropriate value based on cnConstFLabelSide, sets the justification of the constant field label annotation with respect to its base location. The PlotManager Location Control Model requires this resource to allow control of the constant field label consistent with other annotations.

Default: CenterCenter

cnConstFLabelOn

The ContourPlot object draws a constant field label annotation only when cnConstFLabelOn is set True and the ScalarField data are determined to have a single constant value within the limits of the available precision or when no ScalarField data are supplied.

Default: True

cnConstFLabelOrthogonalPosF

cnConstFLabelOrthogonalPosF sets the coordinate of the base location of the constant field label annotation orthogonal to the current cnConstFLabelSide and directed away from the center of the viewport. The PlotManager Location Control Model requires this resource to allow control of the constant field label consistent with other annotations.

Default: 0.0

cnConstFLabelParallelPosF

cnConstFLabelParallelPosF specifies the coordinate of the base location of the constant field label annotation parallel to the current cnConstFLabelSide and directed toward increasing NDC values. The PlotManager Location Control Model requires this resource to allow control of the constant field label consistent with other annotations.

Default: 0.0

cnConstFLabelPerimColor

This resource sets the color to use for drawing the perimeter of the constant field label box.

You can use a color index value (integer) or a named color (string).

Default: Foreground (1)

cnConstFLabelPerimOn

cnConstFLabelPerimOn is a boolean resource that determines whether ContourPlot will draw an outline around the perimeter of the box surrounding the contour constant field label. If set False, no outline will be drawn.

Default: True

cnConstFLabelPerimSpaceF

cnConstFLabelPerimSpaceF determines the spacing or margin between the text of the constant field label and the edge of the constant field label box as a fraction of the current label text height.

Default: 0.33

cnConstFLabelPerimThicknessF

This resource determines the thickness of the perimeter line around the constant field label box. The value acts as a multiplier of a (device-dependent) unit thickness.

Default: 1.0

cnConstFLabelSide

This resource of type NhlTPosition determines where to place the constant field annotation in relation to the sides of the plot object. The PlotManager Location Control Model requires this resource to allow control of the constant field label consistent with other annotations. Its value determines a coordinate system origin and the direction of the positional resources, cnConstFLabelParallelPosF and cnConstFLabelOrthogonalPosF. It also constrains the value of the cnConstFLabelJust appropriately. There are four settings, which behave as follows, unless cnConstFLabelZone is set to one of the special zones (0 or 1):

Top

PlotManager locates the constant field label annotation relative to a line that parallels the top viewport boundary. cnConstFLabelOrthogonalPosF increases in the direction of increasing NDC Y-Axis values and is constrained to positive values. cnConstFLabelParallelPosF increases in the direction of increasing NDC X-Axis values. cnConstFLabelJust is constrained to BottomRight, BottomCenter, or BottomLeft.

Bottom

PlotManager locates the constant field label annotation relative to a line that parallels the bottom viewport boundary. cnConstFLabelOrthogonalPosF increases in the direction of decreasing NDC Y-Axis values and is constrained to positive values. cnConstFLabelParallelPosF increases in the direction of increasing NDC X-Axis values. cnConstFLabelJust is constrained to TopRight, TopCenter, or TopLeft.

Right

PlotManager locates the constant field label annotation relative to a line that parallels the right viewport boundary. cnConstFLabelOrthogonalPosF increases in the direction of increasing NDC X-Axis values and is constrained to positive values. cnConstFLabelParallelPosF increases in the direction of increasing NDC Y-Axis values. cnConstFLabelJust is constrained to TopLeft, CenterLeft, or BottomLeft.

Left

PlotManager locates the constant field label annotation relative to a line that parallels the left viewport boundary. cnConstFLabelOrthogonalPosF increases in the direction of decreasing NDC X-Axis values and is constrained to positive values. cnConstFLabelParallelPosF increases in the direction of increasing NDC Y-Axis values. cnConstFLabelJust is constrained to TopRight, CenterRight, or BottomRight.

If cnConstFLabelZone is set to 0, the PlotManager locates the constant field label annotation relative to the viewport center. If cnConstFLabelZone is 1, the direction of the cnConstFLabelOrthogonalPosF is opposite to the specification given above. Also if the cnConstFLabelZone is either 0 or 1, cnConstFLabelJust is not constrained, and cnConstFLabelOrthogonalPosF may take on negative values.

Default: Bottom

cnConstFLabelString

Specifies the string to use when drawing a constant field label. The string may contain function codes and/or substitution substrings. ContourPlot will replace the substring $ZDV$ with a number representing the constant field value. cnConstFLabelFormat determines the format of the number; its value will be scaled based on the value of cnLabelScaleFactorF.

Default: "CONSTANT FIELD - VALUE IS $ZDV$"

cnConstFLabelTextDirection

This resource of type NhlTTextDirection specifies the direction of the text in the constant field label. The choices are:

Down

Each character is placed below the previous character in the text string.

Across

Each character is placed to the right of the previous character in the text string.

These directions apply before rotation due to cnConstFLabelAngleF.

Default: Across

cnConstFLabelZone

ContourPlot implements the constant field label as an embedded annotation. cnConstFLabelZone specifies the PlotManager zone assigned to the constant field annotation. The PlotManager Location Control Model requires this resource to allow control of the constant field label consistent with other annotations. If cnConstFLabelZone is set to 0, the positional origin is the center of the plot viewport; otherwise it is on or outside one of the sides of the viewport.

If you create a ContourPlot object without an active PlotManager by setting tfPlotManagerOn False, then ContourPlot manages the constant field annotation by itself. In this case, the cnConstFLabelZone resource is not as meaningful.

Default: 0

cnConstFUseInfoLabelRes

If the boolean resource cnConstFUseInfoLabelRes is set True, all the resources applying to the constant field, except for cnConstFLabelString, take their value from the corresponding informational label resources.

Default: False

cnExplicitLabelBarLabelsOn

This boolean resource allows you control the labels that appear in the ContourPlot LabelBar explicitly. When set True, ContourPlot does not block the LabelBar resources lbLabelStrings and lbLabelAlignment. Therefore you can directly control both the contents of the LabelBar's label strings and their alignment with respect to the label boxes. When cnExplicitLabelBarLabelsOn is set False, ContourPlot sets both of these resources based on the current contour line labels and the value of the resource cnLabelBarEndStyle (as of version 5.0.0 or later) or (prior to version 5.0.0 or if cnLabelBarEndStyle is not set) cnLabelBarEndLabelsOn. If you set this resource True but do not set the lbLabelStrings array resource, ContourPlot will set it for you one time. This allows you to get an initial set of strings as a starting point for any customized tweaking you want to perform.

Default: False

cnExplicitLegendLabelsOn

This boolean resource allows you control the labels that appear in the ContourPlot Legend explicitly. When set True, ContourPlot does not block the Legend resource lgLabelStrings. Therefore you can directly control the content of the Legend's label strings. When cnExplicitLegendLabelsOn is set False, ContourPlot sets lgLabelStrings based on the value of the current contour line labels. If you set this resource True but do not set the lgLabelStrings array resource, ContourPlot will set it for you one time. This allows you to get an initial set of strings as a starting point for any customized tweaking you want to perform.

Default: False

cnExplicitLineLabelsOn

This boolean resource controls the way ContourPlot handles the cnLineLabelStrings array resource. When set True, ContourPlot will not modify explicitly set values of the line label strings. When cnExplicitLineLabelsOn is set False, ContourPlot ignores values of cnLineLabelStrings set by the user.

Default: False

cnFillBackgroundColor

This resource of type NhlTColorIndex or a named color (string) sets the background color used for ContourPlot fill patterns. It only has an effect for fill patterns that are neither SolidFill nor HollowFill. By default, this resource is set to Transparent, resulting in the underlying background appearing in the spaces between the elements of the fill pattern. If set to any other valid color index, the specified color will solidly fill all spaces between the fill pattern elements.

Default: Transparent (-1)

cnFillColor

When cnMonoFillColor is set True, this resource of type NhlTColorIndex or a named color (string) sets a uniform fill color for all contour fill areas.

Default: Foreground (1)

cnFillColors

If cnMonoFillColor is False, each element of this array of type NhlTColorIndexGenArray or named color (string) specifies the color of a contour fill area. Note that there is always one more fill area than there are contour levels. The first element of cnFillColors specifies the fill pattern for any region containing a data value less than the value of cnMinLevelValF, while the highest currently used element of cnFillColors specifies the fill pattern for regions containing data values greater than the value of cnMaxLevelValF. Otherwise cnFillColors works in a fashion similar to cnLineColors. If the array is not set explicitly, it will default to a set of color indexes sequentially incremented beginning with color index 1 (NhlFOREGROUND). If the array currently contains fewer elements than cnLevelCount+1, more elements will be added to the array and given values according to the default color assignment scheme; existing elements with valid color index values will not be modified.

Default: <dynamic>

cnFillDotSizeF

This resource sets a uniform dot size, in NDC units, for the stipple dot fill pattern. 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.

Default: 0.0

cnFillDrawOrder

This resource of type NhlTDrawOrder determines when areas of the contour plot are filled relative to the drawing of other elements of the plot. There are three choices:

PreDraw

Fill contour areas before the standard draw phase; fill areas will be overlaid by any subsequently drawn elements.

Draw

Fill contour areas during the standard draw phase; the fill will overlay any elements drawn during the predraw phase, but will underlie elements drawn during the postdraw phase.

PostDraw

Fill contour areas after the standard draw; the fill will overlay any elements drawn during the predraw and draw phases.

You must manipulate this resource in order to mask contours within the context of an Overlay of multiple plot objects.

Default: Draw

cnFillMode

This resource of type NhlTcnFillMode determines how ContourPlot performs fill when cnFillOn is set True. There are three choices:

AreaFill

The area between contour levels is decomposed into polygons. The polygons are then filled based on the applicable fill color, fill pattern, the scale factor assigned to the pattern, and, if stipple fill (fill pattern 17) is specified, the size of the stippling dots.

The following resources can be used to control fill features when cnFillMode is set to AreaFill:

• cnFillBackgroundColor
• cnMonoFillColor
• cnFillColor
• cnFillColors
• cnMonoFillPattern
• cnFillPattern
• cnFillPatterns
• cnFillDotSizeF
• cnMonoFillScale
• cnFillScaleF
• cnFillScales
• cnMissingValFillColor
• cnMissingValFillPattern
• cnMissingValFillScaleF

Currently when using AreaFill mode, and cnScalarFieldData is specified using a MeshScalarField object, and the ContourPlot is overlaid on certain map projections, the edges of the plot may have a ragged appearance and not completely fill the projected data boundaries.

RasterFill

ContourPlot generates a representation of the data by individually assigning colors to the elements of a two-dimensional array of rectangular cells (a raster array) superimposed on an area bounding the data grid. With raster mode, only solid fill is possible, and therefore resources related to fill pattern specification have no effect. The color of each cell is determined based on the fill color assigned to the data value at the cell's location. If cnRasterSmoothingOn is set True, the data value for each raster cell is interpolated from the values of data grid cells in the neighborhood. Otherwise, each raster cell is assigned the color associated with the grid cell within which the greatest proportion of its area lies. Cells of a raster fill plot cannot be transparent. If a fill index of Transparent is set for any cell of a raster fill plot, the Background color will be used instead.

The following resources can be used to control fill features when cnFillMode is set to RasterFill:

• cnFillColors
• cnMissingValFillColor
• cnRasterSmoothingOn
• cnRasterMinCellSizeF
• cnRasterSampleFactorF
• cnRasterCellSizeF

Currently when using RasterFill mode, and trGridType is set to TriangularMesh, and the ContourPlot is overlaid on certain map projections, the edges of the plot may have a ragged appearance and not completely fill the projected data boundaries.

CellFill

ContourPlot performs cell fill by drawing filled polygons whose edges are defined by the borders between adjacent grid cells. If the data grid is defined using cell edges, the cell boundaries are obtained explicitly from the coordinate arrays. Otherwise, the edges are assumed to pass through the halfway points in data grid space between the cell centers. Optionally, you may draw lines around the edges using the cell fill edge resources. As with raster fill, pattern fill is not supported. Unlike raster fill, however, the cells may be transparent.

The following resources can be used to control fill features when cnFillMode is set to CellFill:

• cnMonoFillColor
• cnFillColor
• cnFillColors
• cnMissingValFillColor
• cnCellFillEdgeColor
• cnCellFillMissingValEdgeColor

Currently the CellFill mode is not available when cnScalarFieldData is specified using a MeshScalarField object.

Default: AreaFill

cnFillOn

This boolean resource controls whether the areas between contour levels are filled with a solid color and/or, if the fill method permits it, a fill pattern. You can choose between three fill methods by setting the resource cnFillMode.

Default: False

cnFillPattern

When cnMonoFillPattern is set True, this resource of type NhlTFillIndex sets a uniform pattern for all contour fill areas.

Default: SolidFill

cnFillPatterns

If cnMonoFillPattern is False, each element of this array of type NhlTFillIndexGenArray specifies the fill pattern used for a contour fill area. Note that there is always one more fill area than there are contour levels. The first element of cnFillPatterns specifies the fill pattern for any region containing a data value less than the value of cnMinLevelValF, while the highest currently used element of cnFillPatterns specifies the fill pattern for regions containing data values greater than the value of cnMaxLevelValF. If the array is not set explicitly, the ContourPlot object will assign sequential fill pattern indexes (starting with fill index 1--not "SolidFill", which is fill index 0) to each array element up to the maximum number of existing fill patterns. Thereafter it will repeat the sequence using modular arithmetic. If the array currently contains fewer elements than cnLevelCount+1, more elements will be added to the array and given values according to the same assignment scheme; existing elements with valid fill pattern index values will not be modified.

Default: <dynamic>

cnFillScaleF

When cnMonoFillScale is True, this resource sets a uniform scaling value for all contour fill patterns.

Default: 1.0

cnFillScales

When cnMonoFillScale is False, the cnFillScales array resource allows individual control of the scaling of the pattern used for each contour fill area. It has no effect for solid fill (fill pattern "SolidFill", index 0). 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 have the opposite effect. Values less than or equal to 0.0 are invalid, generate a warning message, and are reset to the default value, 1.0.

Note that there is always one more fill area than there are contour levels. If the array is not set explicitly, the ContourPlot object will assign the value 1.0 to all elements of the array. If the array currently contains fewer elements than cnLevelCount+1, more elements will be added to the array and given the same default value of 1.0; existing elements with valid fill scale index values will not be modified.

Default: 1.0 for all elements

cnFixFillBleed

When cnFillOn is set True, but cnRasterModeOn is set False, ContourPlot performs area fill. Occasionally, due to limitations of the area rendering algorithm, this mode of fill fails and colors "bleed" out into areas they do not belong. If you have this kind of problem with your plot, it will probably be fixed if you set the resource cnFixFillBleed to True.

However, there are certain kinds of plots that have problems when cnFixFillBleed is set True, and so far there is no clear algorithm for distinguishing these. Therefore, the corrections that are applied as a result of setting cnFixFillBleed cannot be yet be unconditionally coded into ContourPlot. Eventually, it is hoped that the need for this resource will be eliminated.

Default: False

cnGridBoundPerimColor

This resource sets the color to use for drawing the perimeter line around the grid boundary.

You can use a color index value (integer) or a named color (string).

Default: Foreground (1)

cnGridBoundPerimDashPattern

This resource sets the HLU index of a dash pattern used to render the perimeter line around the grid boundary.

Default: 0

cnGridBoundPerimOn

If set True, this boolean resource specifies that a perimeter line be drawn around the grid boundary (extent of the ScalarField data) in the ContourPlot plot.

Default: False

cnGridBoundPerimThicknessF

This resource determines the thickness of the perimeter line around the grid boundary. The value acts as a multiplier of a (device-dependent) unit thickness.

Default: 1.0

cnHighLabelAngleF

This resource specifies the angle, in degrees, of high label text and its surrounding box.

Default: 0.0

cnHighLabelBackgroundColor

This resource sets the background color used to fill the box surrounding each high label. If you do not want the box to be filled at all, set cnHighLabelBackgroundColor to Transparent (-1).

Default: Background (0)

cnHighLabelConstantSpacingF

Normally when cnLineLabelFontQuality is set to High, the ContourPlot object writes line label text with proportional spacing. Setting the cnLineLabelConstantSpacingF to a value greater than 0.0 overrides this behavior. Instead, the distance from the start of one character to the next is computed by multiplying a single standard character width by the value of cnLineLabelConstantSpacingF. When cnLineLabelConstantSpacingF has a value between 0.0 and 1.0, characters will overlap. A value of 1.0 implies, on average, no space between characters, while values increasing from 1.0 cause the space between characters to grow. This parameter is ignored when cnLineLabelFontQuality is not High. Values less than 0.0 result in an error and are replaced with the default value.

Default: 0.0

cnHighLabelCount

Each time a ContourPlot is drawn, the read-only resource cnHighLabelCount is updated with the number of high labels actually rendered in the plot. Until the plot is drawn for the first time cnHighLabelCount has the value 0;

Default: 0

cnHighLabelFont

This resource of type NhlTFont specifies the font used to render high labels.

Default: "pwritx"

cnHighLabelFontAspectF

This resource determines the shape of the high label characters. Values increasing from 1.0 result in thinner characters. Values decreasing from 1.0 make the characters wider. Values less than or equal to 0.0 result in a WARNING message and a restoration of the default value.

Default: 1.3125

cnHighLabelFontColor

This resource specifies the color to use for the high label text. If cnHighUseLineLabelRes is True, this resource takes its value from the first element of the cnLineLabelFontColors array.

You can use a color index value (integer) or a named color (string).

Default: True

cnHighLabelFontHeightF

This resource controls the height, in NDC units, of characters used in the text of high labels. The character width scales proportionally, unless you also modify the aspect ratio using the cnHighLabelFontAspectF resource. The high label text height scales with changes to the viewport width, unless you explicitly set cnHighLabelFontHeightF during the same call.

Default: <dynamic> -- 0.012 for a viewport width of 0.6

cnHighLabelFontQuality

This resource of type NhlTFontQuality determines the quality of the font used to draw ContourPlot high labels.

Default: High

cnHighLabelFontThicknessF

Sets the thickness of the line used to draw high label text. The value acts as a multiplier of a (device-dependent) unit thickness. This resource is ignored when the cnHighLabelFont specifies a filled font (font indexes 21-22, 25-26, 29-30, and 33-37).

Default: 1.0

cnHighLabelFormat

The cnHighLabelFormat resource is a string that specifies the printing format for the numeric portion of high labels according to the HLU Floating Point Format Specification scheme. If any of the numerical format parameters have the dynamic attribute on, the corresponding parameter in the cnMaxDataValueFormat resource determines the parameter's value. The default value uses the shorthand notation '*+' to cause all numeric format parameters to be determined dynamically.

Default: "*+^sg"

cnHighLabelFuncCode

This resource of type NhlTCharacter sets the function code character that the low level utilities will use when parsing the high label string.

Default: :

cnHighLabelPerimColor

This resource sets the HLU color index used to draw the perimeter of the high label box.

Default: Foreground (1)

cnHighLabelPerimOn

cnHighLabelPerimOn is a boolean resource that determines whether ContourPlot will draw an outline around the perimeter of the box surrounding contour high labels. If set False, no outline will be drawn.

Default: True

cnHighLabelPerimSpaceF

cnHighLabelPerimSpaceF determines the spacing or margin between the text of the high label and the edge of the high label box as a fraction of the current high label text height.

Default: 0.33

cnHighLabelPerimThicknessF

This resource determines the thickness of the perimeter line around the high label box. The value acts as a multiplier of a (device-dependent) unit thickness.

Default: 1.0

cnHighLabelString

Specifies the string to use when drawing high labels. The string may contain function codes and/or substitution substrings. ContourPlot will replace the substring "$ZDV$" with a number representing the value at the point where the label is to appear. cnHighLabelFormat determines the format of the number and cnLabelScaleFactorF determines the scaling of the actual data value.

Default: "H:B:$ZDV$:E:"

cnHighLabelsOn

If this boolean resource is set True, ContourPlot places labels at regions representing local maximums in the dataset.

Default: False

cnHighLowLabelOverlapMode

cnHighLowLabelOverlapMode is a resource of type NhlTcnHighLowLabelOverlapMode. It controls how high and low labels are allowed to overlap other elements of the ContourPlot plot and has six possible settings:

IgnoreOverlap

The ContourPlot object does nothing to prevent high and low labels from overlapping other elements of the ContourPlot plot.

OmitOverHL

The ContourPlot object omits high and low labels that would overlap previously determined high or low labels.

OmitOverVP

The ContourPlot object omits high and low labels that would overlap the edge of the viewport.

OmitOverVPAndHL

The ContourPlot object omits high and low labels that would overlap the edge of the viewport or previously determined high or low labels.

AdjustVP

The ContourPlot object adjusts the position of high and low labels that would overlap the edge of the viewport enough to eliminate the problem.

AdjustVPOmitOverHL

The ContourPlot object adjusts the position of high and low labels that would overlap the edge of the viewport enough to eliminate the problem and omits high and low labels that would overlap previously determined high or low labels.

V4.1 Status Note 5

Default: IgnoreOverlap

cnHighUseLineLabelRes

If the boolean resource cnHighUseLineLabelRes is set True, all resources applying to high labels, except for cnHighLabelString and cnHighLabelAngleF, take their value from the corresponding line label resources.

Default: False

cnInfoLabelAngleF

This resource specifies the angle, in degrees, of the informational label text and its surrounding box.

Default: 0.0

cnInfoLabelBackgroundColor

This resource sets the background color used to fill the box surrounding the informational label. If you do not want the box to be filled at all, set cnInfoLabelBackgroundColor to Transparent (-1).

You can use a color index value (integer) or a named color (string).

Default: Background (0)

cnInfoLabelConstantSpacingF

Normally when cnLineLabelFontQuality is set to High, the ContourPlot object writes informational label text with proportional spacing. Setting the cnInfoLabelConstantSpacingF to a value greater than 0.0 overrides this behavior. Instead, the distance from the start of one character to the next is computed by multiplying a single standard character width by the value of cnLineLabelConstantSpacingF. When cnLineLabelConstantSpacingF has a value between 0.0 and 1.0, characters will overlap. A value of 1.0 implies, on average, no space between characters, while values increasing from 1.0 cause the space between characters to grow. This parameter is ignored when cnInfoLabelFontQuality is not High. Values less than 0.0 result in an error and are replaced with the default value.

Default: 0.0

cnInfoLabelFont

This resource of type NhlTFont specifies the font used to render the informational label.

Default: "pwritx"

cnInfoLabelFontAspectF

This resource determines the shape of the informational label characters. Values increasing from 1.0 result in thinner characters. Values decreasing from 1.0 make the characters wider. Values less than or equal to 0.0 result in a WARNING message and a restoration of the default value.

Default: 1.3125

cnInfoLabelFontColor

This resource specifies the color to use for the informational label text.

You can use a color index value (integer) or a named color (string).

Default: Foreground (1)

cnInfoLabelFontHeightF

This resource controls the height, in NDC units, of characters used in the text of the informational label. The character width scales proportionally, unless you also modify the aspect ratio using the cnInfoLabelFontAspectF resource. The info label text height scales with changes to the viewport width, unless you explicitly set cnInfoLabelFontHeightF during the same call.

Default: <dynamic> -- 0.012 for a viewport width of 0.6

cnInfoLabelFontQuality

This resource of type NhlTFontQuality determines the quality of the font used to draw the ContourPlot informational label.

Default: High

cnInfoLabelFontThicknessF

Sets the thickness of the line used to draw informational label text. The value acts as a multiplier of a (device-dependent) unit thickness. This resource is ignored when the cnInfoLabelFont specifies a filled font (font indexes 21-22, 25-26, 29-30, and 33-37).

Default: 1.0

cnInfoLabelFormat

The cnInfoLabelFormat resource is a string that specifies the printing format for the numbers generated from substitution substrings in cnInfoLabelString according to the HLU Floating Point Format Specification scheme. If any of the numerical format parameters have the dynamic attribute on, the corresponding parameter in the cnMaxDataValueFormat resource determines the parameter's value. The default value uses the shorthand notation '*+' to cause all numeric format parameters to be determined dynamically.

Default: "*+^sg"

cnInfoLabelFuncCode

This resource of type NhlTCharacter sets the function code character that the low level utilities will use when parsing the informational label string.

Default: :

cnInfoLabelJust

This resource of type NhlTJustification, after constraint to an appropriate value based on cnInfoLabelSide, sets the justification of the informational label annotation with respect to its base location. The PlotManager Location Control Model requires this resource to allow control of the informational label consistent with other annotations.

Default: TopRight

cnInfoLabelOn

If this boolean resource is set False, ContourPlot will not draw an informational label.

Default: True (False for gsn_csm contour routines when contour fill is turned on.)

cnInfoLabelOrthogonalPosF

cnInfoLabelOrthogonalPosF sets the coordinate of the base location of the informational label annotation orthogonal to the current cnInfoLabelSide and directed away from the center of the viewport. The PlotManager Location Control Model requires this resource to allow control of the informational label consistent with other annotations.

Default: 0.02

cnInfoLabelParallelPosF

cnInfoLabelParallelPosF specifies the coordinate of the base location of the informational label annotation parallel to the current cnInfoLabelSide and directed toward increasing NDC values. The PlotManager Location Control Model requires this resource to allow control of the informational label consistent with other annotations.

Default: 1.0

cnInfoLabelPerimColor

This resource sets the color to use for drawing the perimeter of the informational label box.

You can use a color index value (integer) or a named color (string).

Default: Foreground (1)

cnInfoLabelPerimOn

cnInfoLabelPerimOn is a boolean resource that determines whether ContourPlot will draw an outline around the perimeter of the box surrounding a contour informational label. If set False, no outline will be drawn.

Default: True

cnInfoLabelPerimSpaceF

cnInfoLabelPerimSpaceF determines the spacing or margin between the text of the informational label and the edge of the informational label box as a fraction of the current label text height.

Default: 0.33

cnInfoLabelPerimThicknessF

This resource determines the thickness of the perimeter line around the informational label box. The value acts as a multiplier of a (device-dependent) unit thickness.

cnInfoLabelSide

This resource of type NhlTPosition determines where to place the informational annotation in relation to the sides of the plot object. The PlotManager Location Control Model requires this resource to allow control of the informational label consistent with other annotations. Its value determines a coordinate system origin and the direction of the positional resources, cnInfoLabelParallelPosF and cnInfoLabelOrthogonalPosF. It also constrains the value of cnInfoLabelJust appropriately. There are four settings that behave as follows, unless cnInfoLabelZone is set to one of the special zones (0 or 1):

Top

PlotManager locates the informational label annotation relative to a line paralleling the top viewport boundary. cnInfoLabelOrthogonalPosF increases in the direction of increasing NDC Y-Axis values and is constrained to positive values. cnInfoLabelParallelPosF increases in the direction of increasing NDC X-Axis values. cnInfoLabelJust is constrained to BottomRight, BottomCenter, or BottomLeft.

Bottom

PlotManager locates the informational label annotation relative to a line that parallels the bottom viewport boundary. cnInfoLabelOrthogonalPosF increases in the direction of decreasing NDC Y-Axis values and is constrained to positive values. cnInfoLabelParallelPosF increases in the direction of increasing NDC X-Axis values. cnInfoLabelJust is constrained to TopRight, TopCenter, or TopLeft.

Right

PlotManager locates the informational label annotation relative to a line that parallels the right viewport boundary. cnInfoLabelOrthogonalPosF increases in the direction of increasing NDC X-Axis values and is constrained to positive values. cnInfoLabelParallelPosF increases in the direction of increasing NDC Y-Axis values. cnInfoLabelJust is constrained to TopLeft, CenterLeft, or BottomLeft.

Left

PlotManager locates the informational label annotation relative to a line that parallels the left viewport boundary. cnInfoLabelOrthogonalPosF increases in the direction of decreasing NDC X-Axis values and is constrained to positive values. cnInfoLabelParallelPosF increases in the direction of increasing NDC Y-Axis values. cnInfoLabelJust is constrained to TopRight, CenterRight, or BottomRight.

If cnInfoLabelZone is set to 0, the PlotManager locates the informational label annotation relative to the viewport center. If cnInfoLabelZone is 1, the direction of the cnInfoLabelOrthogonalPosF is opposite to the specification given above. Also if the cnInfoLabelZone is either 0 or 1, cnInfoLabelJust is not constrained, and cnInfoLabelOrthogonalPosF may take on negative values.

Default: Bottom

cnInfoLabelString

Specifies the string to use when drawing an informational label. The string may contain function codes and/or substitution substrings. ContourPlot will replace the following substrings with numeric values:

$CIU$

The contour interval used (value of cnLevelSpacingF)

$CMN$

The minimum contour level (first element of cnLevels)

$CMX$

The maximum contour level

$SFU$

The scale factor used (value of cnLabelScaleFactorF)

$ZMN$

The minimum data value

$ZMX$

The maximum data value

cnInfoLabelFormat determines the format of each number and except for the number generated from $SFU$, all values are scaled based on the value of cnLabelScaleFactorF.

Default: "CONTOUR FROM $CMN$ TO $CMX$ BY $CIU$"

cnInfoLabelTextDirection

This resource of type NhlTTextDirection specifies the direction of the text in the informational label. The choices are:

Down

Each character is placed below the previous character in the text string.

Across

Each character is placed to the right of the previous character in the text string.

These directions apply before any rotation due to cnInfoLabelAngleF is applied to the informational label.

Default: Across

cnInfoLabelZone

ContourPlot implements the informational label as an embedded annotation. cnInfoLabelZone specifies the PlotManager zone assigned to the informational annotation. The PlotManager Location Control Model requires this resource to allow control of the informational label consistent with other annotations. If cnInfoLabelZone is set to 0, the positional origin is the center of the plot viewport; otherwise it is on or outside one of the sides of the viewport.

If you create a ContourPlot object without an active PlotManager by setting tfPlotManagerOn False, then ContourPlot manages the informational annotation by itself. In this case, the cnInfoLabelZone resource is not as meaningful.

Default: 3

cnLabelBarEndLabelsOn

When this boolean resource is set True and cnExplicitLabelBarLabelsOn is False, ContourPlot creates labels for the two ends of the LabelBar. The label at one end will be a string representation of the minimum value in the dataset, and at the other end will be a string representation of the maximum value in the dataset. Both strings will be formatted according to the format specification in effect for the other labels provided by ContourPlot to the LabelBar. o

As of version 5.0.0 or later this resource is deprecated and is overridden by cnLabelBarEndStyle when both are set at the same time.

Default: False

cnLabelBarEndStyle

Available in version 5.0.0 or later.

This enumerated resource of type NhlTLabelBarEndStyle allows you to select from among three styles for the ends of the ContourPlot LabelBar:

IncludeOuterBoxes

The two end boxes represent the fill color and/or patterns used for areas of the plot where the data is below the minimum contour level or above the maximum contour level. The first and last labels, representing the minimum and maximum contour levels, are aligned with the interior boundaries of the outer boxes.

IncludeMinMaxLabels

The two end boxes represent the fill color and/or patterns used for areas of the plot where the data is below the minimum contour level or above the maximum contour level. The first and last labels, representing the minimum and maximum values in the field, are aligned with the exterior boundaries of the outer boxes. However, if the minimum and/or maximum field values fall within the range specified by the minimum and maximum contour levels, one or both of these labels will be set to an empty string.

ExcludeOuterBoxes

Only boxes representing fill colors and/or patterns between the minimum and maximum contour levels appear in the LabelBar. The first and last labels, representing the minimum and maximum contour levels, are aligned with the exterior boundaries of what have now become the outer boxes of the LabelBar. This setting is useful in cases where there exist maximum and minimum values that by the nature of the quantity always bound the data, e.g. probability or per cent cloud cover.

As of version 5.0.0 or later this resource overrides the now deprecated cnLabelBarEndLabelsOn when both are set at the same time.

Default: IncludeOuterBoxes

cnLabelDrawOrder

This resource of type NhlTDrawOrder determines when contour plot labels are drawn relative to the drawing of other elements of the plot. There are three choices:

PreDraw

Draw contour labels before the standard draw phase; the labels will be overlaid by any subsequently drawn elements.

Draw

Draw contour labels during the standard draw phase; the labels will overlay any elements drawn during the predraw phase as well as fill and contour lines drawn during the standard draw phase, but will underlie elements drawn during the postdraw phase.

PostDraw

Draw contour labels after the standard draw; the labels will overlay any elements drawn during the predraw and draw phases as well as lines and fill drawn during the postdraw phase.

Default: Draw

cnLabelMasking

This resource controls whether ContourPlot lines and fill are masked in the areas where ContourPlot labels are to appear. When working with raster type devices, it is seldom necessary to mask for labels, since they can be made to solidly overlay the areas where they appear. Also there is a noticeable performance penalty when labels are masked, so the use of this option is discouraged unless it is necessary.

Default: False

cnLabelScaleFactorF

cnLabelScaleFactorF is a read-only resource that contains the current scale factor that applies to ContourPlot object labels. Multiplying the numbers in the labels by the value of cnLabelScaleFactorF gives the actual data values the numbers represent. The ContourPlot object calculates its value based on the data value with the maximum absolute value, the current mode of the enumerated resource, cnLabelScalingMode, and perhaps the value of cnLabelScaleValueF. Its value may also be influenced by the number of significant digits specified by the format specification resource, cnMaxDataValueFormat. You may output the value of this resource in the informational label using the the substitution string "$SFU$".

Default: <dynamic>

cnLabelScaleValueF

The interpretation of cnLabelScaleValueF depends on the value of the enumerated resource cnLabelScalingMode. When cnLabelScalingMode is set to ScaleFactor, data values are divided by the value of cnLabelScaleValueF to obtain the numbers appearing in ContourPlot object labels. If cnLabelScalingMode is set to ConfineToRange, the cnLabelScaleValueF represents an exclusive upper bound for the numbers used to represent the data values. For other values of cnLabelScalingMode, the cnLabelScaleValueF resource is ignored.

Default: 1.0

cnLabelScalingMode

This resource of type NhlTScalingMode determines how to scale the numbers representing scalar field data values in the ContourPlot object's labels. cnLabelScalingMode applies to numbers that represent data values in line labels, high and low labels, the informational label, and the constant field label. There are five choices:

ScaleFactor

The ContourPlot object divides the data value by the value of cnLabelScaleValueF to obtain the number that appears in the label.

ConfineToRange

The ContourPlot object uses cnLabelScaleValueF as an exclusive upper bound. A scale factor is selected such that the number used to represent the data value with the maximum absolute value will be less than cnLabelScaleValueF, but greater than or equal to cnLabelScaleValueF divided by 10.0. As an example, setting cnLabelScaleValueF to 100.0 would result in a scaled number in the range 10.0 to 99.999....

TrimZeros

The ContourPlot object selects a scale factor such that the number representing the data value with the maximum absolute value will have the fewest possible extra zeros. If the maximum absolute value were 245000, for instance, it would scale to 245. If it were 0.000245, it would scale to 0.245. (The zero conventionally placed before the decimal point of a number less than 1.0 is not considered.)

MaxSigDigitsLeft

The ContourPlot object selects a scale factor such that the number representing the data value with the maximum absolute value will have its rightmost significant digit directly to the left of the decimal point. The number of significant digits is determined by the format string resource, cnMaxDataValueFormat.

AllIntegers

The ContourPlot object selects a scale factor such that the numbers representing labeled contour levels (as determined by examination of the values of the cnLevelFlags array) can be rendered as integers.

In each case, the scale factor selected is placed into the read-only resource, cnLabelScaleFactorF. Note that the label value multiplied by the scale factor returns the actual data value represented.

Default: ScaleFactor

cnLegendLevelFlags

This array resource of type NhlTcnLevelUseModeGenArray allows you to control which of the lines representing contour levels are to appear in the ContourPlot Legend. You can also control whether the lines that do appear are to get a line label. Although the type allows for four choices, this resource supports only three of them:

NoLine

Do not draw a line representing this contour level in the Legend.

LineOnly

Draw a line representing this contour level, but no label in the Legend.

LabelOnly

Currently, if an element is set to this value, it is treated the same as if it were set to NoLine.

LineAndLabel

Draw a line representing this contour level along with a line label in the Legend.

If you set this resource with an array containing fewer elements than the current number of contour levels, additional elements are supplied and set to the value NoLine.

Default: NULL

cnLevelCount

A read-only resource set to the actual number of levels chosen during the level selection process.

Default: <dynamic>

cnLevelFlag

When cnMonoLevelFlag is set True, this resource of type NhlTcnLevelUseMode sets the rendering of all contour levels to one of four possible values:

NoLine

No lines or labels appear.

LineOnly

Lines but no labels appear.

LabelOnly

Labels but no lines appear.

LineAndLabel

Both lines and labels appear.

Note that the resources cnLinesOn and cnLineLabelsOn must both be set True to enable all possible settings of cnLevelFlag.

Default: LineOnly

cnLevelFlags

When cnMonoLevelFlag is False, cnLevelFlags is an array of type NhlTcnLevelUseModeGenArray that allows you individual control over whether a line and/or a line label is to appear at each contour level. It has no effect on contour fill. There are four choices:

NoLine

No lines or labels appear at the contour level.

LineOnly

Lines but no labels appear at the contour level.

LabelOnly

Labels but no lines appear at the contour level.

LineAndLabel

Both lines and labels appear at the contour level.

Note that cnLinesOn and cnLineLabelsOn exert underlying control over the appearance of contour lines and line labels. If cnLinesOn is set False, no lines will appear regardless of the values of any cnLevelFlags elements; likewise, if cnLineLabelsOn is False, no line labels will appear.

If cnMonoLevelFlag is False and you do not explicitly set cnLevelFlags, the ContourPlot object will set its elements for you based on the value of cnLineLabelInterval. Elements will be set to LineOnly except that if cnLineLabelInterval is greater than 0, elements separated by the interval of cnLineLabelInterval will be set to LineAndLabel. This effect will occur both at initialization and any time you explicitly set cnLineLabelInterval.

Default: <dynamic>

cnLevelSelectionMode

This enumerated resource of type NhlTLevelSelectionMode provides four methods for selecting the contour intervals displayed in a plot:

AutomaticLevels

Ordinarily this mode determines contour levels by picking a spacing value from a set of relatively "round" numbers scaled by powers of 10 to the range of the data. This set of numbers is as follows: 1.0, 2.0, 2.5, 4.0, 5.0. The number of levels chosen will be as close as possible to the value of cnMaxLevelCount without exceeding it. Once the spacing is chosen, the minimum contour level is set to the value of the least multiple of the spacing greater than the minimum data value. Likewise the maximum contour level becomes the greatest multiple of the spacing less than the maximum data value. Based on these values, ContourPlot sets the resources cnLevelSpacingF, cnMinLevelValF, and cnMaxLevelValF appropriately.

On the other hand, if you explicitly set the resource cnLevelSpacingF to a valid value greater than 0.0 and less than the range of the data, it will be use