MapPlot class resource descriptions

mpDataBaseVersion
This resource defines the version of the map database used by the MapPlot object. Currently it is read-only, since only one version of the map database now exists. As new versions of the map database become available, you will be able to set this resource to access a particular version of the database.

Default: "NCARG_4.0"

mpShapeMode
This resource of type NhlTMapShapeMode allows you to control whether the map projection preserves its intrinsic shape (aspect ratio), and in addition, if the aspect ratio is to be preserved, whether the MapPlot bounding box should be resized to fit the map projection extent exactly. It has three possible settings:
FreeAspect
Do not preserve the map projection aspect ratio. The projected area is "stretched" along either the horizontal or the vertical View axis such that it fills the specified View area.
FixedAspectFitBB
Preserve the map projection aspect ratio. The projected area is made as large as possible and centered within the View area. Then MapPlot resizes its View area such that its perimeter matches the bounding box of the projected area.
FixedAspectNoFitBB
Preserve the map projection aspect ratio. The projected area is made as large as possible and centered within the View area. MapPlot does not resize its View area.

Default: FixedAspectFitBB

mpAreaNames
mpAreaNames is a string array resource you can use to retrieve the names of all areas in the MapPlot database. There is a unique name for each distinct area. You can also set this resource to rename the area names, perhaps to another language than English. You must set the complete list of names at the same time. The easiest way to change the names of only a few areas would be to perform a GetValues first, change the names of the selected areas, then do a SetValues. Note that it is your responsibility to ensure that you do not duplicate the names of any areas. Only one of a group of identically-named areas will remain accessible. Also, keep in mind that the order of areas is fixed: a particular element of the array always refers to the same area in the MapPlot database regardless of the name you give it.

Default: See heading "Area Name" in MapPlot database table

mpAreaTypes
The areas in the MapPlot database are currently classified into eight area types. These types, which cannot be modified, are as follows: The read-only array resource mpAreaTypes allows you to retrieve the integer value of the type of each area in the MapPlot database. Each element gives the type of the area named by the corresponding element of the mpAreaNames array.

V4.0 Status Note 6

Default: See heading "Type" in MapPlot database table

mpFixedAreaGroups
MapPlot maintains two arrays that assign area group numbers to each area in the map database. MapPlot uses the area's group numbers to determine its fill attributes, assuming mpFillOn is True and you do not explicitly specify fill attributes for the area. This resource allows read-only access for informational purposes only to the fixed area group array, which, as its name implies, you cannot modify. The elements of this array have the same order as the mpAreaNames array. Within the array each area in the database is assigned to area group 1, 2, or 3. These are respectively the Ocean group, the Land group and the InlandWater group. For this reason mpFixedAreaGroups is sometimes known as the geophysical area groups array, since a map whose fill attributes are based on these area groups shows only physical as opposed to political features.

If fill is turned on and you set mpFillBoundarySets to the value Geophysical and do not explicitly specify any areas using the mpFillAreaSpecifiers resource, MapPlot will use the mpFixedAreaGroups group numbers to determine fill attributes for all areas of the map. For each of the three fill attribute types that has its Mono flag resource set False, the area's group number is used as an index into the fill attribute array resource. This yields, for mpFillColors, an HLU color index, for mpFillPatterns, an HLU fill pattern index, and for mpFillScales, a fill pattern scaling factor. A more complete description of the situations that result in MapPlot indexing the fill attribute array resources based on the contents of the mpFixedAreaGroups array is found in the discussion of area fill in the MapPlot object description.

Note that you can set the fill attributes of the area groups assigned by the mpFixedAreaGroups array using a set of convenience resources that act as named aliases for the Ocean, Land, and InlandWater elements of mpFillColors, mpFillPatterns, and mpFillScales. These resources are as follows: mpOceanFillColor, mpOceanFillPattern, mpOceanFillScaleF, mpLandFillColor, mpLandFillPattern, mpLandFillScaleF, mpInlandWaterFillColor, mpInlandWaterFillPattern, and mpInlandWaterFillScaleF.

Default: See heading "Fixed Group" in MapPlot database table

mpDynamicAreaGroups
MapPlot maintains two arrays that assign area group numbers to each area in the map database. MapPlot uses the area's group numbers to determine its fill attributes, assuming mpFillOn is True and you do not explicitly specify fill attributes for the area. This resource allows you to access and, if desired, set the elements of the dynamic area group array. The elements of this array have the same order as the mpAreaNames array. By default, within the dynamic group arrray MapPlot assigns each area a group number such that adjoining politically distinct land areas are guaranteed to belong to a different group. For this reason the mpDyanamicAreaGroups array is sometimes known as the political groups array, since a map whose fill attributes are based on these area groups shows only national and perhaps state boundaries as well as physical features. Anytime mpFillBoundarySets is set in such a way that national or U.S. state areas must be distinguished, and the fill attributes are not set explicitly, MapPlot uses the group numbers in the mpDyanamicAreaGroups array as indexes into the fill attribute array resources whose associated Mono flag resource is set False. A more thorough description of the situations that result in MapPlot indexing the fill attribute array resources based on the contents of the mpDyanamicAreaGroups array is found in the discussion of area fill in the MapPlot object description.

You may reassign the group numbers in the mpDyanamicAreaGroups array in any manner you please. At minimum and by default there are 10 area groups, but by setting the resource mpAreaGroupCount you can define any number of area groups up to a maximum of 255.

Default: See heading "Dynamic Group" in MapPlot database table

mpAreaGroupCount
mpAreaGroupCount specifies the total number of area groups, including the "default" group, the three fixed (or geophysical) groups, and the dynamic (or political) groups (a minimum of six). The minimum, as well as the default, value of mpAreaGroupCount is 10. The maximum value is 256. Attempts to set mpAreaGroupCount to values outside this range result in a warning and a restoration of the default value.

Default: 10

mpOutlineOn
This boolean resource is the master switch for drawing of MapPlot area outlines. If True, the MapPlot enables drawing of map area outlines. Otherwise, these outlines will not appear, regardless of the setting of any other area-outline-related resources. However, note that this resource does not apply to MapPlot grid or limb lines or to the perimeter line.

Default: True

mpOutlineDrawOrder
This resource of type NhlTDrawOrder determines when MapPlot area outlines are drawn relative to other elements of the plot. There are three choices:
PreDraw
Draw the area outlines before the standard draw phase; the lines will overlay MapPlot fill and grid or limb lines also drawn during the predraw phase but will underlie MapPlot labels and perimeter lines drawn during the pre-draw phase and anything drawn during the draw and post-draw phases.
Draw
Draw the area outlines during the standard draw; the lines will overlay any elements drawn during the pre-draw phase, as well as MapPlot fill and grid or limb lines drawn during the standard draw phase, but will underlie MapPlot labels and perimeter lines drawn during the draw phase and anything drawn during the post-draw phase.
PostDraw
Draw the lines after the standard draw; the lines will overlay all MapPlot elements except for labels and perimeter lines drawn during the post-draw phase.

Default: PostDraw

mpOutlineBoundarySets
You set this resource of type NhlTMapBoundarySets to specify the basic boundary set used to render area outlines. Given the basic boundaries you can then add other outline areas by specifying area names in the mpOutlineSpecifiers string array resource. There are six choices:
NoBoundaries
MapPlot will draw area outlines only for areas specified by name in mpOutlineSpecifiers.
Geophysical
MapPlot will draw area outlines for geophysical features: continents, oceans, islands, and inland water areas. Specific national boundary lines may be added by name in mpOutlineSpecifiers.
National
MapPlot will draw area outlines delineating all national boundary areas (although the database is several years out of date). All the geophysical features specified by Geophysical are implicitly included. You may add U.S. State area outlines by name using the mpOutlineSpecifiers resource.
USStates
MapPlot will draw area outlines delineating U.S. States and inland water features (using data of higher resolution than the national and geophysical area outlines). A few areas outside the U.S. are included as well: the Bahamas, and a few lakes extending into Canadian territory. You may add other geophysical and/or national areas by name using the mpOutlineSpecifiers resource.
GeophysicalAndUSStates
MapPlot will draw area outlines of all global geophyical feature and also U.S. States and inland water features. Other national boundaries do not appear unless you specify them by name using the mpOutlineSpecifiers resource.
AllBoundaries
MapPlot draws area outlines of all national boundaries as well as all U.S. State boundaries. All geophysical features implicitly appear. There is no effect if area names are specified using the mpOutlineSpecifiers resource, since all possible area outlines appear regardless.

Default: Geophysical

mpOutlineSpecifiers
You use the array resource mpOutlineSpecifiers to specify particular area outlines MapPlot is to draw by name. These areas are added to the basic outline area set specified using the resource mpOutlineBoundarySets. Among the specifiers, you may include groups of areas defined by a number of pre-defined string constants. In addition, a substring matching facility allows you to specify groups of areas sharing a common substring.

Default: A single element array containing the value "NullArea".

mpAreaMaskingOn
This boolean resource is the master switch for drawing of MapPlot area fill. If True, the MapPlot enables drawing of map area fill. Otherwise, no map fill will appear, regardless of the setting of any other area-fill-related resources.

Default: False

mpMaskAreaSpecifiers
You use the array resource mpMaskAreaSpecifiers to specify the names of areas MapPlot is to mask. These areas are subtracted from the fill area set specified using the resource mpFillBoundarySets and mpFillAreaSpecifiers. Among the specifiers you may include groups of areas defined by a number of pre-defined string constants. In addition, a substring matching facility allows you to specify groups of areas sharing a common substring.

Note that there is an order of precedence for fill and masking. Explicitly named areas take precedence over area groupings, and small areas take precedence over enclosing larger areas. Otherwise masking takes precedence over filling.

Default: A single element array containing the value "NullArea".

mpFillOn
This boolean resource is the master switch for drawing of MapPlot area fill. If True, the MapPlot enables drawing of map area fill. Otherwise, no map fill will appear, regardless of the setting of any other area-fill-related resources.

Default: False

mpFillDrawOrder
This resource of type NhlTDrawOrder determines when MapPlot area fill is drawn relative to other elements of the plot. There are three choices:
PreDraw
Draw area fill before the standard draw phase; the fill underlies all other MapPlot elements drawn during the pre-draw phase and anything drawn during the draw and post-draw phases.
Draw
Draw area fill during the standard draw; the fill overlays anything drawn during the pre-draw phase but underlies any other MapPlot elements drawn during the draw phase and anything drawn during the post-draw phase.
PostDraw
Draw area fill after the standard draw; the fill overlays anything drawn during the pre-draw and draw phases but underlies any other MapPlot elements drawn during the post-draw phase.

Default: Draw

mpFillBoundarySets
You set this resource of type NhlTMapBoundarySets to specify the basic boundary set used for fill areas. Given the basic boundaries you can then add other areas by specifying area names outlines in the mpFillAreaSpecifiers string array resource. You can also desiginate areas to be masked (left unfilled) by specifying area names in the mpMaskAreaSpecifiers string array resource.
NoBoundaries
MapPlot will draw area fill only for areas specified by name in mpFillAreaSpecifiers and not specified in mpMaskSpecifiers.
Geophysical
MapPlot will draw area fill for geophysical features: land, oceans, and inland water bodies. You may specify by name other areas to be filled in the mpFillAreaSpecifiers resource.
National
MapPlot will individually fill all national boundary areas. Geophysical features are implicitly included. You may specify by name other areas to be filled in the mpFillAreaSpecifiers resource.
USStates
MapPlot will individually fill the states of the U.S. States and inland water features (using data of higher resolution than the national and geophysical area outlines). A few areas outside the U.S. are included as well: the Bahamas, and a few lakes extending into Canadian territory. In addition, you may fill other geophysical and/or national areas by name using the mpFillAreaSpecifiers resource.
GeophysicalAndUSStates
MapPlot will draw area fill for all global geophyical feature and also individually fill the U.S. states and inland water features. Other national boundaries do not appear unless you specify them by name using the mpFillAreaSpecifiers resource.
AllBoundaries
MapPlot draws area fill for all national boundaries as well as all U.S. states and inland water. All geophysical features implicitly appear. You can explicitly set the fill attributes for areas whose names are specified in the mpFillAreaSpecifiers resource.

Default: Geophysical

mpFillPatternBackground
mpFillPatternBackground specifies the HLU index of the color used for the background in areas filled with any HLU fill pattern besides SolidFill. If this reource has the value Transparent (-1), no color will be appear behind the fill pattern. The effect will be that the pattern appears transparently on top of anything already drawn.

Default: Background

mpMonoFillColor
When set True, all MapPlot fill areas (other than those whose color is set explicitly using the mpSpecifiedFillColors array resource) are set to a single color, as specified by the value of the scalar resource cnFillColor. When False, the elements of the array resource cnFillColors control the fill color indexes for MapPlot areas based on the area group numbers assigned to each area.

Default: False

mpFillColor
When cnMonoFillColor is set True, this resource of type NhlTColorIndex sets a uniform fill color for all MapPlot areas, except for those whose fill color is set explicitly using the mpSpecifiedFillColors array resource. Default: Foreground
mpFillColors
If mpMonoFillColor is False, each element of the array specifies the HLU color index used to fill the MapPlot areas belonging a particular area group. The first element of the array specifies the default color for regions within the map projection area that contain neither a filled nor a masked area. The second, third, and fourth elements specify colors for the fixed (geophysical) area groups: the Ocean group, the Land group, and the InlandWater group. For convenience, there are named alias resources for these first four elements of the array: mpDefaultFillColor, mpOceanFillColor, mpLandFillColor, and mpInlandWaterFillColor. If you set any of the alias resources at the same time as the mpFillColors array resource is set, the named alias resource value overrides. The remaining elements (by default, the fifth through the tenth elements) specify colors for the dynamic groups. If mpAreaGroupCount is increased from its minimum (and default) value of 10, more elements become available for additional dynamic group colors.

Default: By default the first 10 elements are assigned the following sequence of HLU color indexes: 106,104,57,104,19,23,41,53,60,88.

mpMonoFillPattern
When set True, all MapPlot fill areas (other than those whose pattern is set explicitly using the mpSpecifiedFillPatterns array resource) are set to a single pattern, as specified by the value of the scalar resource cnFillPattern. When False, the elements of the array resource cnFillPatterns control the fill pattern indexes for MapPlot areas based on the area group numbers assigned to each area.

Default: True

mpFillPattern
When cnMonoFillPattern is set True, this resource of type NhlTFillIndex sets a uniform fill pattern for all MapPlot areas, except for those whose fill pattern is set explicitly using the mpSpecifiedFillPatterns array resource. Default: SolidFill
mpFillPatterns
If mpMonoFillPattern is False, each element of the array specifies the HLU pattern index used to fill the MapPlot areas belonging a particular area group. The first element of the array specifies the default pattern for regions within the map projection area that contain neither a filled nor a masked area. The second, third, and fourth elements specify patterns for the fixed (geophysical) area groups: the Ocean group, the Land group, and the InlandWater group. For convenience, there are named alias resources for these first four elements of the array: mpDefaultFillPattern, mpOceanFillPattern, mpLandFillPattern, and mpInlandWaterFillPattern. If you set any of the alias resources at the same time as the mpFillPatterns array resource is set, the named alias resource value overrides. The remaining elements (by default, the fifth through the tenth elements) specify patterns for the dynamic groups. If mpAreaGroupCount is increased from its minimum (and default) value of 10, more elements become available for additional dynamic area group patterns.

Default: MapPlot assigns patterns sequentially, beginning with HLU pattern index 1 for the first element of mpFillPatterns.

mpMonoFillScale
When set True, all MapPlot fill areas (other than those whose fill scale is set explicitly using the mpSpecifiedFillScales array resource) use a single fill pattern scale factor, as specified by the value of the scalar resource cnFillScaleF. When False, the elements of the array resource cnFillScales control the fill scale values for MapPlot areas based on the area group numbers assigned to each area.

Default: True

mpFillScaleF
When cnMonoFillPattern is set True, this floating point resource sets a uniform fill pattern scale factor for all MapPlot areas, except for those whose fill scale facter is set explicitly using the mpSpecifiedFillScales array resource. Default: 1.0
mpFillScales
If mpMonoFillPattern is False, each element of the array specifies the scale factor applied to the fill pattern used to fill MapPlot areas belonging a particular area group. The first element of the array specifies the default fill pattern scale factor for regions within the map projection area that contain neither a filled nor a masked area. The second, third, and fourth elements specify scale factors for the fixed (geophysical) area groups: the Ocean group, the Land group, and the InlandWater group. For convenience, there are named alias resources for these first four elements of the array: mpDefaultFillScaleF, mpOceanFillScaleF, mpLandFillScaleF, and mpInlandWaterFillScaleF. If you set any of the alias resources at the same time as the mpFillScales array resource is set, the named alias resource value overrides. The remaining elements (by default, the fifth through the tenth elements) specify patterns for the dynamic groups. If mpAreaGroupCount is increased from its minimum (and default) value of 10, more elements become available for additional dynamic area group fill scale values.

Default: 1.0 for all elements

mpFillAreaSpecifiers
You use the array resource mpFillAreaSpecifiers to specify explicitly the names of areas MapPlot is to fill. Your purpose may be to include an area that would not otherwise be drawn (such as an interior national boundary when mpFillBoundarySets has the value Geophysical) or it may be simply that you want to control the area's fill attributes explicitly using the associated specified fill attribute arrays. The named areas are added to the basic set of fill areas specified using the resource mpFillBoundarySets. Within the list you may include groups of areas defined by a number of pre-defined string constants. In addition, a substring matching facility allows you to specify groups of areas that share a common substring.

You may explicitly specify the fill attributes of areas named in the mpFillAreaSpecifiers array using any or all of the three associated attribute array resources, mpSpecifiedFillColors, mpSpecifiedFillPatterns, and mpSpecifiedFillScales. The elements of each of these arrays correspond one for one with the elements of the mpFillAreaSpecifiers array. Attributes set using these arrays override all other resources involving fill attributes, including the fill attribute Mono flags. Each of these arrays accept a pre-defined special value allowing you to specify individual elements as "unset".

If you do not explicitly set fill attributes of areas specified in the mpFillAreaSpecifiers, either by not setting the specified attribute resources, or by specifying individual elements as "unset", MapPlot uses its normal method of setting fill attributes based on area group assignments. The group numbers are chosen from the mpFixedAreaGroups array or from the mpDynamicAreaGroups array depending on the setting of the resource mpSpecifiedFillPriority. You can override the general priority for any individual area by prepending an exclamation point ('!') to the area's name.

If you also using area masking, note that there is an order of precedence for fill and masking. Explicitly named areas take precedence over area groupings, and small areas take precedence over enclosing larger areas. Otherwise masking takes precedence over filling.

Default: A single element array containing the value "NullArea".

mpSpecifiedFillDirectIndexing
This boolean resource determines whether the values contained in the specified fill attribute array resource (mpSpecifiedFillColors, mpSpecifiedFillPatterns, and mpSpecifiedFillScales) resource mpFillAreaColors directly specify the attribute value, or whether they specify an area group number used as an index into the regular fill attribute array resources ((mpFillColors, mpFillPatterns, and mpFillScales). When mpSpecifiedFillDirectIndexing is set True, the values of mpSpecifiedFillColors elements represent HLU color indexes, the values of mpSpecifiedFillPatterns elements represent HLU pattern indexes, and the values of mpSpecifiedFillPatterns elements represent fill pattern scaling factors. Otherwise, the elements of these arrays are converted into integers that represent area group numbers.

Default: True

mpSpecifiedFillPriority
Based on the setting of this resource of type NhlTSpecifiedFillPriority MapPlot decides how to choose a group number for indexing into the regular fill attribute arrays for areas specified in the mpFillAreaSpecifiers resource. The group number is only used to determine fill attributes that have not been specified explicitly using the specified fill attribute arrays. The choices are as follows:
GeophysicalPriority
Use group numbers from the mpFixedAreaGroups array as an index into the fill attribute arrays.
PoliticalPriority
Use group numbers from the mpDynamicAreaGroups array as an index into the fill attribute arrays.
You can reverse the sense of the general fill priority value for individual named areas in the mpFillAreaSpecifiers resource by prefixing the name string with the exclamation point character ('!').

Default: GeophysicalPriority Default: NULL

mpSpecifiedFillColors
You may use this array resource to set explicitly the fill color of any MapPlot area specified by name in the mpFillAreaSpecifiers array resource, overriding the usual method of determining an area's fill color based on its assigned area group numbers. The elements of the mpSpecifiedFillColors array correspond one for one to the elements of the mpFillAreaSpecifiers array.

Depending on the setting of the boolean resource mpSpecifiedFillDirectIndexing, you control the level of indirection in the way MapPlot interprets the values in mpSpecifiedFillColors. If mpSpecifiedFillDirectIndexing is True, MapPlot treats the values of mpSpecifiedFillColors as HLU color indexes directly determining the fill color of the specified areas. Otherwise, MapPlot considers each value as a MapPlot group number that temporarily overrides the group numbers normally assigned to the area. In this case, MapPlot determines the HLU fill color by using this temporary group number as an index into the mpFillColors array.

You may cause any element of the mpFillAreaSpecifiers array to retain its normal color by setting the corresponding element of mpSpecifiedFillColors to the special value NullColor (-1). If mpSpecifiedFillColors has fewer elements than mpFillAreaSpecifiers MapPlot sets all the extra elements of mpFillAreaSpecifiers using its normal scheme. If mpSpecifiedFillColors has more elements, MapPlot ignores them. If any of the elements of mpSpecifiedFillColors are invalid, MapPlot issues a warning and assigns the area a color using the normal scheme.

Default: <dynamic>

mpSpecifiedFillPatterns
You may use this array resource to set explicitly the fill pattern of any MapPlot area specified by name in the mpFillAreaSpecifiers array resource, overriding the usual method of determining an area's fill pattern based on its assigned area group numbers. The elements of the mpSpecifiedFillPatterns array correspond one for one to the elements of the mpFillAreaSpecifiers array.

Depending on the setting of the boolean resource mpSpecifiedFillDirectIndexing, you control the level of indirection in the way MapPlot interprets the values in mpSpecifiedFillPatterns. If mpSpecifiedFillDirectIndexing is True, MapPlot treats the values of mpSpecifiedFillPatterns as HLU pattern indexes directly determining the fill pattern of the specified areas. Otherwise, MapPlot considers each value as a MapPlot group number that temporarily overrides the group numbers normally assigned to the area. In this case, MapPlot determines the HLU fill pattern by using this temporary group number as an index into the mpFillPatterns array.

You may cause any element of the mpFillAreaSpecifiers array to retain its normal pattern by setting the corresponding element of mpSpecifiedFillPatterns to the special value NullFill (-1). If mpSpecifiedFillPatterns has fewer elements than mpFillAreaSpecifiers MapPlot sets all the extra elements of mpFillAreaSpecifiers using its normal scheme. If mpSpecifiedFillPatterns has more elements, MapPlot ignores them. If any of the elements of mpSpecifiedFillPatterns are invalid, MapPlot issues a warning and assigns the area a pattern using the normal scheme.

Default:

mpSpecifiedFillScales
You may use this array resource to set explicitly the fill pattern scale factor of any MapPlot area specified by name in the mpFillAreaSpecifiers array resource, overriding the usual method of determining an area's fill scale based on its assigned area group numbers. The elements of the mpSpecifiedFillScales array correspond one for one to the elements of the mpFillAreaSpecifiers array.

Depending on the setting of the boolean resource mpSpecifiedFillDirectIndexing, you control the level of indirection in the way MapPlot interprets the values in mpSpecifiedFillScales. If mpSpecifiedFillDirectIndexing is True, MapPlot treats the values of mpSpecifiedFillScales as floating point values directly determining the fill scale of the specified areas. Otherwise, MapPlot converts each number into an integer and treats it as a MapPlot group number that temporarily overrides the group numbers normally assigned to the area. In this case, MapPlot determines the fill scale value by using this temporary group number as an index into the mpFillScales array.

You may cause any element of the FillAreaSpecifiers array to retain its normal fill scale value by setting the corresponding element of mpSpecifiedFillScales to the special value 0.0. If mpSpecifiedFillScales has fewer elements than mpFillAreaSpecifiers MapPlot sets all the extra elements of mpFillAreaSpecifiers using its normal scheme. If mpSpecifiedFillScales has more elements, MapPlot ignores them. If any of the elements of mpSpecifiedFillScales are invalid, MapPlot issues a warning and assigns the area a scale using the normal scheme.

Note that a kludge is required if mpSpecifiedFillDirectIndexing is set False, so that you are indexing into the mpFillScales array using group numbers, and you want to specify that a fill scale be determined by indexing into element 0 of mpFillScales. You would need to set the element of mpSpecifiedFillScales using a number larger than 0.0 but less than 1.0. If you set the value to 0.0 it would be perceived as the special value causing MapPlot to use its "normal" method of determining the fill scale for the area.

Default: <dynamic>

mpDefaultFillColor
This resource sets the HLU index of the color used to fill all areas within the map projection that, given that mpFillOn is True, are neither filled nor masked. mpDefaultFillColor is constrained to value greater than Transparent (-1). This resource provides an alternate method of setting the value of the first element of mpFillColors. If both resources are set in the same call, the value of mpDefaultFillColor takes precedence.

Default: 106

mpDefaultFillPattern
This resource sets the HLU index of the fill pattern used to fill all areas within the map projection that, given that mpFillOn is True, are neither filled nor masked. If mpDefaultFillPattern has the value HollowFill (-1), there will be no fill of the ocean area, regardless of the setting of mpDefaultFillColor. This resource provides an alternate method of setting the value of the first element of mpFillPatterns. If both resources are set in the same call, the value of mpDefaultFillPattern takes precedence.

Default: SolidFill

mpDefaultFillScaleF
The mpDefaultFillScaleF resource controls the scaling of the pattern used to fill all areas within the map projection that, given that mpFillOn is True, are neither filled nor masked. It has no effect for solid fill (SolidFill, fill 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. This resource provides an alternate method of setting the value of the first element of mpFillScales. If both resources are set in the same call, the value of mpDefaultFillScaleF takes precedence.

Default: 1.0

mpOceanFillColor
This resource sets the HLU index of the color used to fill areas representing the oceans. mpOceanFillColor is constrained to value greater than Transparent (-1). This resource provides an alternate method of setting the value of the second element of mpFillColors. If both resources are set in the same call, the value of mpOceanFillColor takes precedence.

Default: 104

mpOceanFillPattern
This resource sets the HLU index of the fill pattern used to fill areas representing the oceans. If mpOceanFillPattern has the value HollowFill (-1), there will be no fill of the ocean area, regardless of the setting of mpOceanFillColor. This resource provides an alternate method of setting the value of the second element of mpFillPatterns. If both resources are set in the same call, the value of mpOceanFillPattern takes precedence.

Default: SolidFill

mpOceanFillScaleF
The mpOceanFillScaleF resource controls the scaling of the pattern used to fill areas representing the oceans. It has no effect for solid fill (SolidFill, fill pattern 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. This resource provides an alternate method of setting the value of the second element of mpFillScales. If both resources are set in the same call, the value of mpOceanFillScaleF takes precedence.

Default: 1.0

mpLandFillColor
This resource sets the HLU index of the color used to fill areas of land not given a special group color. mpLandFillColor is constrained to value greater than Transparent (-1). This resource provides an alternate method of setting the value of the third element of mpFillColors. If both resources are set in the same call, the value of mpLandFillColor takes precedence.

Default: 57

mpLandFillPattern
This resource sets the HLU index of the fill pattern used to fill areas of land not given a special group color. If mpLandFillPattern has the value HollowFill (-1), there will be no fill of the land area, regardless of the setting of mpInlandWaterFillColor. This resource provides an alternate method of setting the value of the third element of mpFillPatterns. If both resources are set in the same call, the value of mpLandFillPattern takes precedence.

Default: SolidFill

mpLandFillScaleF
The mpLandFillScaleF resource controls the scaling of the pattern used to fill areas of land not given a special group color. It has no effect for solid fill (SolidFill, fill pattern 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. This resource provides an alternate method of setting the value of the third element of mpFillScales. If both resources are set in the same call, the value of mpLandFillScaleF takes precedence.

Default: 1.0

mpInlandWaterFillColor
This resource sets the HLU index of the color used to fill areas representing bodies of water except for the oceans. mpInlandWaterFillColor is constrained to value greater than Transparent (-1). This resource provides an alternate method of setting the value of the fourth element of mpFillColors. If both resources are set in the same call, the value of mpInlandWaterFillColor takes precedence.

Default: 104

mpInlandWaterFillPattern
This resource sets the HLU index of the fill pattern used to fill areas representing bodies of water except for the oceans. If mpInlandWaterFillPattern has the value HollowFill (-1), there will be no fill of the inland water area, regardless of the setting of mpInlandWaterFillColor. This resource provides an alternate method of setting the value of the fourth element of mpFillPatterns. If both resources are set in the same call, the value of mpInlandWaterFillPattern takes precedence.

Default: SolidFill

mpInlandWaterFillScaleF
The mpInlandWaterFillScaleF resource controls the scaling of the pattern used to fill areas representing bodies of water except for the oceans. It has no effect for solid fill (SolidFill, fill pattern 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. This resource provides an alternate method of setting the value of the fourth element of mpFillScales. If both resources are set in the same call, the value of mpInlandWaterFillScaleF takes precedence.

Default: 1.0

mpGeophysicalLineColor
This resource sets the HLU index of a color used to render interior national boundary outlines. This resource applies to the outlines of all continents and islands, except that when one or more U.S. states are drawn, the portion of North America whose outline is contiguous with the U.S. border is rendered using USStateslLineColor.

Default: Foreground

mpGeophysicalLineDashPattern
This resource sets the HLU index of a dash pattern used to render interior national boundary outlines. This resource applies to the outlines of all continents and islands, except that when one or more U.S. states are drawn, the portion of North America whose outline is contiguous with the U.S. border is rendered using USStateslLineDashPattern.

Default: 0

mpGeophysicalLineDashSegLenF
This resource specifies the length of each segment of the dash patterns used to draw geophysical boundary outlines. It is the length in NDC before the dash pattern repeats itself. This resource automatically scales with changes in the size of the viewport of the MapPlot object. This resource applies to the outlines of all continents and islands, except that when one or more U.S. states are drawn, the portion of North America whose outline is contiguous with the U.S. border is rendered using USStateslLineDashSegLenF. MapPlot sets the default value of mpNationalLineDashSegLenF dynamically based upon the ratio of the actual plot viewport width to a reference viewport width of 0.5 and a reference dash segment length of 0.075.

Default: 0.075 (for a viewport width of 0.5)

mpGeophysicalLineThicknessF
Sets the thickness of the lines used to draw geophysical boundary outlines. The value acts as a multiplier of a (device-dependent) unit thickness. This resource applies to the outlines of all continents and islands, except that when one or more U.S. states are drawn, the portion of North America whose outline is contiguous with the U.S. border is rendered using USStateslLineThicknessF.

Default: 1.0

mpUSStateLineColor
This resource sets the HLU index of a color used to render interior U.S. state boundary outlines. This resources affects all exterior boundaries of the U.S. if any U.S. state outlines are included the MapPlot. Otherwise, U.S. boundaries are rendered like other national boundaries using mpNationalLineColor for interior boundaries and mpGeophysicalLineColor for lines separating land and ocean.

Default: Foreground

mpUSStateLineDashPattern
This resource sets the HLU index of a dash pattern used to render U.S. state boundary outlines. This resources affects all exterior boundaries of the U.S. if any U.S. state outlines are included the MapPlot. Otherwise, U.S. boundaries are rendered like other national boundaries using mpNationalLineDashPattern for interior boundaries and mpGeophysicalLineDashPattern for lines separating land and ocean. Note that this resource applies only to lines used to draw interior national boundaries. Lines separating land and oceans are not affected.

Default: 0

mpUSStateLineDashSegLenF
This resource specifies the length of each segment of the dash patterns used to draw U.S. state boundary outlines. It is the length in NDC before the dash pattern repeats itself. This resources affects all exterior boundaries of the U.S. if any U.S. state outlines are included the MapPlot. Otherwise, U.S. boundaries are rendered like other national boundaries using mpNationalLineDashSegLenF for interior boundaries and mpGeophysicalLineDashSegLenF for lines separating land and ocean. mpUSStateLineDashSegLenF automatically scales with changes in the size of the viewport of the MapPlot object. MapPlot sets the default value of mpNationalLineDashSegLenF dynamically based upon the ratio of the actual plot viewport width to a reference viewport width of 0.5 and a reference dash segment length of 0.075.

Default: 0.075 (for a viewport width of 0.5)

mpUSStateLineThicknessF
Sets the thickness of the lines used to draw U.S. state boundary outlines. The value acts as a multiplier of a (device-dependent) unit thickness. This resources affects all exterior boundaries of the U.S. if any U.S. state outlines are included the MapPlot. Otherwise, U.S. boundaries are rendered like other national boundaries using mpNationalLineThicknessF for interior boundaries and mpGeophysicalLineThicknessF for lines separating land and ocean.

Default: 1.0

mpNationalLineColor
This resource sets the HLU index of a color used to render interior national boundary outlines. Note that this resource applies only to lines used to draw interior national boundaries. Lines separating land and oceans are not affected.

Default: Foreground

mpNationalLineDashPattern
This resource sets the HLU index of a dash pattern used to render interior national boundary outlines. Note that this resource applies only to lines used to draw interior national boundaries. Lines separating land and oceans are not affected.

Default: 0

mpNationalLineDashSegLenF
This resource specifies the length of each segment of the dash patterns used to draw national boundary outlines. It is the length in NDC before the dash pattern repeats itself. This resource automatically scales with changes in the size of the viewport of the MapPlot object. Note that this resource applies only to lines used to draw interior national boundaries. Lines separating land and oceans are not affected. MapPlot sets the default value of mpNationalLineDashSegLenF dynamically based upon the ratio of the actual plot viewport width to a reference viewport width of 0.5 and a reference dash segment length of 0.075.

Default: 0.075 (for a viewport width of 0.5)

mpNationalLineThicknessF
Sets the thickness of the lines used to draw national boundary outlines. The value acts as a multiplier of a (device-dependent) unit thickness. Note that this resource applies only to lines used to draw interior national boundaries. Lines separating land and oceans are not affected by this resource.

Default: 1.0

mpGridAndLimbOn
This boolean resource determines whether the MapPlot object draws grid lines representing latitude and longitude as well as (when appropriate) a limb line around the edge of the visible surface of the map projection.

Default: True

mpGridAndLimbDrawOrder
This resource of type NhlTDrawOrder determines when MapPlot draws the grid lines representing latitude and longitude relative to other elements of the plot. When a limb line representing the edge of the visible surface of the projection is required, MapPlot always renders it at the same time as the grid lines. There are three choices:
PreDraw
Draw grid lines before the standard draw phase; the grid lines overlay MapPlotfill drawn during the pre-draw phase but underlie other pre-draw phase MapPlot elements and anything drawn during the draw and post-draw phases.
Draw
Draw grid lines during the standard draw; the grid lines overlay anything drawn during the pre-draw phase and MapPlot fill drawn during the draw phase but underlie other draw phase MapPlot elements and anything drawn during the post-draw phase.
PostDraw
Draw grid lines after the standard draw; the grid lines overlay anything drawn during the pre-draw and draw phases and MapPlot fill drawn during the post-draw phase but underlie other post-draw phase MapPlot elements.

Default: PostDraw

mpGridSpacingF
This resource specifies the spacing in degrees between MapPlot grid lines representing latitude and longitude.

Default: 0.1

mpGridMaskMode
This resource of type NhlTMapGridMaskMode specifies how the MapPlot object should mask the grid representing latitudes and longitudes. There are seven choices:
MaskNone
MapPlot does not mask the grid. Grid lines appear over the entire visible map projection area.
MaskOcean
MapPlot masks the grid over areas of the map occupied by any part of the global ocean.
MaskNotOcean
MapPlot masks the grid over areas of the map that are not part of the global ocean, including bodies of water within the interior of continents.
MaskLand
MapPlot masks the grid over areas of the map that represent land. Bodies of water within the interior of continents remain unmasked.
MaskNotLand
MapPlot masks the grid over all areas of the map that do not represent land, including bodies of water within the interior of continents.
MaskFillArea
MapPlot masks the grid over filled or masked areas in the map. The grid is drawn only over 'background' areas within the map projection, that is, those areas of the MapPlot that would be filled (assuming fill is enabled) using the color specified by mpDefaultFillColor.
MaskMaskArea
MapPlot masks the grid only over areas named in the mpMaskSpecifiers array.

Default: MaskNone

mpGridLineColor
This resource sets the HLU index of a color used to draw the grid representing latitudes and longitudes.

Default: Foreground

mpGridLineDashPattern
This resource sets the HLU index of a dash pattern used to draw the grid representing latitudes and longitudes.

Default: 0

mpGridLineDashSegLenF
This resource specifies the length of each segment of the dash patterns used used to draw the grid representing latitudes and longitudes. It is the length in NDC before the dash pattern repeats itself. This resource automatically scales with changes in the size of the viewport of the MapPlot object. MapPlot sets the default value of mpGridLineDashSegLenF dynamically based upon the ratio of the actual plot viewport width to a reference viewport width of 0.5 and a reference dash segment length of 0.075.

Default: 0.075 (for a viewport width of 0.5)

mpGridLineThicknessF
This resource determines the thickness of the lines used to draw the grid representing latitudes and longitudes. The value acts as a multiplier of a (device-dependent) unit thickness.

Default: 1.0

mpLimbLineColor
This resource sets the HLU index of the color used for the limb line drawn at the edge of visibility in certain map projections.

Default: Foreground

mpLimbLineDashPattern
This resource sets the HLU index of a dash pattern used for the limb line drawn at the edge of visibility in certain map projections.

Default: 0

mpLimbLineDashSegLenF
This resource specifies the length of each segment of the dash patterns used for the limb line drawn at the edge of visibility in certain map projections. It is the length in NDC before the dash pattern repeats itself. This resource automatically scales with changes in the size of the viewport of the MapPlot object. MapPlot sets the default value of mpLimbLineDashSegLenF dynamically based upon the ratio of the actual plot viewport width to a reference viewport width of 0.5 and a reference dash segment length of 0.075.

Default: 0.075 (for a viewport width of 0.5)

mpLimbLineThicknessF
This resource determines the thickness of the limb line drawn at the edge of visibility in certain map projections. The value acts as a multiplier of a (device-dependent) unit thickness.

Default: 1.0

mpPerimOn
This boolean resource determines whether the MapPlot object draws a perimeter line around the edge of the map projection. Depending on the setting of the MapTransObj resource, mpEllipticalBoundary this perimeter may have a rectangular or elliptical shape.

Default: True

mpPerimDrawOrder
This resource of type NhlTDrawOrder determines when the perimeter line around the edge of the map projection is drawn relative to other elements of the plot. There are three choices:
PreDraw
Draw the perimeter before the standard draw phase; the perimeter overlays all other MapPlot elements drawn during the pre-draw phase except MapPlot labels but underlies anything drawn during the draw and post-draw phases.
Draw
Draw the perimeter during the standard draw; the perimeter overlays anything drawn during the pre-draw phase and any other MapPlot elements (except MapPlot labels) drawn during the draw phase but underlies anything drawn during the post-draw phase.
PostDraw
Draw the perimeter after the standard draw; the perimeter overlays anything drawn during the pre-draw and draw phases and all other MapPlot elements (except MapPlot labels) drawn during the post-draw phase.

Default: Draw

mpPerimLineColor
This resource sets the HLU index of the color used to render the perimeter line around the edge of the map projection.

Default: Foreground

mpPerimLineDashPattern
This resource sets the HLU index of a dash pattern used to render the perimeter line around the edge of the map projection.

Default: 0

mpPerimLineDashSegLenF
This resource specifies the length of each segment of the dash patterns used to draw the perimeter line around the edge of the map projection. It is the length in NDC before the dash pattern repeats itself. This resource automatically scales with changes in the size of the viewport of the MapPlot object. MapPlot sets the default value of mpPerimLineDashSegLenF dynamically based upon the ratio of the actual plot viewport width to a reference viewport width of 0.5 and a reference dash segment length of 0.075.

Default: 0.075 (for a viewport width of 0.5)

mpPerimLineThicknessF
This resource determines the thickness of the perimeter line around the edge of the map projection. The value acts as a multiplier of a (device-dependent) unit thickness.

Default: 1.0

mpLabelsOn
This boolean resource determines whether the MapPlot object draws labels identifying the equator ("EQ"), Greenwich Meridian ("GM"), international date line ("ID") North Pole ("NP") and South Pole ("SP").

Default: True

mpLabelDrawOrder
This resource of type NhlTDrawOrder determines when MapPlot labels are drawn relative to other elements of the plot. There are three choices:
PreDraw
Draw labels before the standard draw phase; the labels overlay all other MapPlot elements drawn during the pre-draw phase but underlie anything drawn during the draw and post-draw phases.
Draw
Draw labels during the standard draw; the labels overlay anything drawn during the pre-draw phase and any other MapPlot elements drawn during the draw phase but underlie anything drawn during the post-draw phase.
PostDraw
Draw labels after the standard draw; the labels overlay anything drawn during the pre-draw and draw phases and all other MapPlot elements drawn during the post-draw phase.

Default: PostDraw

mpLabelFontHeightF
This resource controls the height in NDC of characters used in the MapPlot labels. The MapPlot text height scales with changes to the viewport width, unless you explicitly set mpLabelFontHeightF during the same call.

Default: <dynamic>

mpLabelFontColor
This resource specifies the hlu color index used to draw the characters used for MapPlot labels.

Default: True


Reference Manual Control Panel

NG4 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?


$Revision: 1.12 $ $Date: 1995/07/26 23:30:06 $