MapPlot and MapTransformation (mp) Resources
- mpAreaGroupCount (MapPlot)
-
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 255. Attempts to set
mpAreaGroupCount to values outside this range result in a
warning and a restoration of the default value.
When using the
RANGSdatabase this resource is ignored. - mpAreaMaskingOn (MapPlot)
-
This boolean resource is the master switch for enabling the area
masking facility. If True, MapPlot enables area
masking, causing areas named in the mpMaskAreaSpecifiers array
to remain unfilled, consequently allowing previously drawn plot elements
to be visible within the areas' outlines. If False, no masking is performed,
regardless of the contents of mpMaskAreaSpecifiers. For convenience,
setting mpMaskAreaSpecifiers causes mpAreaMaskingOn to
be set True, if it is not explicitly set otherwise in the same call.
When using the
RANGSdatabase this resource is ignored. - mpAreaNames (MapPlot)
-
mpAreaNames is a string array resource you can use to
retrieve the names of all areas in a MapPlot
database. You need to know these names, including specific
details of their spelling, in order to use the specifier resources
(mpFillAreaSpecifiers, mpOutlineSpecifiers, or
mpMaskAreaSpecifiers). There is a unique name for each
distinct area. However, the form of the names differs depending on the
database in use.
You can also set this resource to rename the area names, perhaps to better represent the conventions of another locale. You must set the complete list of names at the same time. Keep in mind that the order of areas is fixed: a particular element of the array always refers to the same area in the database you are using regardless of the name you give it.
- When using the
Ncarg4_0database: - All names that are compounds of several words use the hyphen character ('-') to separate the individual words. In several cases where the names would otherwise not be unique, an underscore character ('_') followed by a digit is appended to the end of the name. If you use a SetValues call to rename the areas, 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. See the Ncarg4_0 database table for the list of area names.
- When using the
Ncarg4_1database: - Each geographic entity in the
Ncarg4_1database is defined in a hierarchical manner as a descendent of one of the two top level elements "Land" and "Water". Therefore each entity has a "fully-qualified" name that starts with the term "Land" or "Water". Colons separate entities that have different levels (see mpAreaTypes) and periods separate child entities that are conceptually at the same level. For example, the island of Tasmania has the fully qualified name "Land : Australia : Australia . Tasmania", where the first "Australia" is the continent and the second is the country of which Tasmania is a part. However, mpAreaNames does not return the fully-qualified name of the resource. Instead it returns only enough of the name, starting from the right, to ensure that it is unique. In this case it would be simply the string "Tasmania". If another entity named "Tasmania" existed in the dataset, it would return "Australia . Tasmania".The
Ncarg4_1version of the database provides several different datasets, that while similar in their overall content, provide different types and levels of geographic detail. See mpDataSetName for a list of the datasets available with this database, along with links to tables of detailing their contents. - When using the
RANGSdatabase: - This resource is not used and is set to
NULL.
- When using the
- mpAreaTypes (MapPlot)
-
This read-only integer array resource contains the integer value of the
type of each area in a MapPlot database. Each
element gives the type of the area named by the corresponding element
of the mpAreaNames array. The meaning and value of these types
vary depending on the value of mpDataBaseVersion.
- When using the
Ncarg4_0database: - Areas are classified into eight types. These types are as follows:
- (0) mpOcean
- (1) mpContinent
- (2) mpLargeIsland
- (3) mpSmallIsland
- (4) mpInlandWater
- (5) mpNational
- (6) mpUSStateLand
- (7) mpUSStateWater
- When using the
Ncarg4_1database: - Areas are classified into four or five
four types. These types represent the four or five levels of
the hierarchical classification scheme currently represented in the
database. More types may be added if and when areas at other levels of the
hierarchy are added to the database. The current types are as follows:
- (1) land or water
- (2) continental boundary
- (3) national boundary
- (4) state or provincial boundary
- (5) county boundary or climate division
- When using the
RANGSdatabase: - This resource is not used and is set to
NULL.
- When using the
- mpBottomAngleF (MapTransformation)
-
When mpLimitMode has the value
Angles, this resource specifies the positive angle in degrees down from the center to the edge of the projection, or, if using a satellite projection, the displacement angle down from the satellite line of sight to the projection center. Note that direction of the line over which the angle is measured remains parallel to the left edge of the viewport, regardless of the rotation angle applied to the projection. mpBottomAngleF has a maximum allowable value that varies depending on the projection. - mpBottomMapPosF (MapTransformation)
- This read-only resource contains the coordinate of the bottom edge of the projected area in NDC space.
- mpBottomNDCF (MapTransformation)
-
When mpLimitMode has the value
NDC, this resource specifies the bottom edge of the limiting rectangle in Normalized Device Coordinates. If mpBottomNDCF is set to a value greater than mpRightNDCF, a warning is issued and the values are exchanged. Since the relationship between the map projection area and NDC coordinates changes whenever the map limits are changed, as well as when the viewport area is moved or resized, MapTransformation resets the value of mpBottomNDCF to the NDC value of the bottom edge of the projected area at the end of any update to the transformation. - mpBottomNPCF (MapTransformation)
-
When mpLimitMode has the value
NPC, this resource specifies the bottom edge of the limiting rectangle in Normalized Projection Coordinates. mpBottomNPCF is constrained to values in the range 0.0 through 1.0. If mpBottomNPCF is set to a value greater than mpTopNPCF, a warning is issued and the values are exchanged. The value of mpBottomNPCF is updated whenever the map limits are set using any of the map limit modes. - mpBottomPointLatF (MapTransformation)
-
When mpLimitMode has the value
Points, this resource specifies the latitude, in degrees, of a point along the bottom edge of the limiting rectangle. - mpBottomPointLonF (MapTransformation)
-
When mpLimitMode has the value
Points, this resource specifies the longitude, in degrees, of a point along the bottom edge of the limiting rectangle. - mpBottomWindowF (MapTransformation)
-
When mpLimitMode has the value
Window, this resource specifies the value, in window coordinates, of the bottom edge of the projection. - mpCenterLatF (MapTransformation)
-
This resource defines the latitude of the center of the map projection
coordinate system. It applies for all values of the
mpProjection resource except for
LambertConformal. Its value must lie between -90.0 and +90.0, where -90.0 represents the South Pole and +90.0 represents the North Pole. - mpCenterLonF (MapTransformation)
-
This resource defines the longitude of the center of the map
projection coordinate system. It applies for all values of the
mpProjection resource except for
LambertConformal. Its value must lie between -180.0 and +180.0, where both extremes represent the longitude of the International Dateline. - mpCenterRotF (MapTransformation)
-
Unless the origin lies at one of the poles, this resource defines the
angle that the map projection coordinate system is rotated
counterclockwise from a vector directed north with origin at the
projection center. If the projection center is at the North Pole, the
vector points in the direction of mpCenterLonF+180.0. If
the center is the South Pole, the vector points in the direction of
mpCenterLonF. mpCenterRotF applies for all values of
the mpProjection resource except for
LambertConformal. - mpDataBaseVersion (MapPlot)
-
This resource of type
NhlTMapDataBaseVersion
determines which database version MapPlot should use.
Currently there are three choices:
Ncarg4_0(alias:LowRes)- Use the original
database as supplied with MapPlot in
version 4.0. This database is out of date with respect to political
boundaries and has much lower resolution than the
Ncarg4_1database. Nevertheless, for global scale plots that involve only geophysical boundaries, this database is the recommended one to use. Because there are so many fewer points, MapPlot can render the data much faster, particularly when fill is involved. This database contains 583 named geographical entities. Ncarg4_1(alias:MediumRes)- Use one of the map datasets developed for the
Ncarg4_1version of the MapPlot database. These datasets contain between 1085 and 4225 geographical entities arranged in an extensible hierarchical fashion. The database is organized in such a way that new subdivisions of existing areas can easily be added. The resolution is much higher than the original database, and the political boundaries are more up-to-date. Use of this database is recommended when plotting limited areas of the earth's surface, any time up-to-date political boundaries are required, or when certain subdivisions of the United States, Canada, or Mexico are desired. Select the dataset using the resource mpDataSetName. The datasets available are: RANGS_GSHHS(aliases:HighRes,RANGS)- Use the multi-resolution coastline database RANGS (Regionally
Accessible Nested Global Shorelines), developed by Rainer Feistel from
Wessel and Smith's GSHHS (Global Self-consistent Hierarchical
High-resolution Shoreline) database. This database is not supplied
with the NCAR Graphics software suite, but may be freely downloaded
from Feistel's
site. For this database to be accessible to NCAR Graphics
routines, the files that comprise it must be installed in a directory
named "rangs" that is a subdirectory of the directory where the other
NCAR Graphics map database files reside (typically
$NCARG_ROOT/lib/ncarg/database). Alternatively, you may set the
environment variable NCARG_RANGS to point to the directory location of
the RANGS database files. The RANGS database is capable of much higher
resolution than the other databases, but it should not be used for
maximal area projections of the whole globe since there are some
problems in rendering it at this scale. This database currently
consists of coastline data only and has no named areas associated with
it.
Plesae click here for more information on how to download and install the RANGS/GSHHS database.
You may freely switch between the databases after creating a mapplot. However, note that because the databases differ considerably in their area naming schemes, you will be likely to encounter warning messages if you have set any of the specifier resources (mpFillAreaSpecifiers, mpOutlineSpecifiers, mpMaskAreaSpecifiers, or mpMaskOutlineSpecifiers).
- mpDataResolution (MapPlot)
-
resource of type
NhlTMapDataResolution
specifies the resolution used to render the map. There are 6 choices:
UnspecifiedResolution(Alias:Unspecified)- MapPlot decides what resolution to use based on the range of the map limits currently in effect. Large scale maps will be drawn with high resolution and smaller scale maps with lower resolution.
FinestResolution(Alias:Finest)- Draw the map using the finest resolution possible.
FineResolution(Alias:Fine)- Draw the map using fine resolution.
MediumResolution(Alias:Medium)- Draw the map using medium resolution.
CoarseResolution(Alias:Coarse)- Draw the map using coarse resolution.
CoarsestResolution(Alias:Coarsest)- Draw the map using the coarsest resolution possible.
These designations for resolution are only relative to the other resolutions that can be rendered using the
RANGSdatabase.This resource is ignored when using the
Ncarg4_0orNcarg4_1databases. - mpDataSetName (MapPlot)
-
When mpDataBaseVersion is set to
Ncarg_4_1this string type resource specifies the name of the dataset used to populate the database. Currently there are three possible standard datasets from which to choose:- Earth..1
- This dataset was created in 1998 and contains geophysical and political boundaries including the states of the United States.
- Earth..2
- This dataset was created in 1999 and is similar to "Earth..1" except that it contains the country Eritrea, and several countries resulting from the breakup of the USSR that were not included in "Earth..1". It also contains the provinces of Canada, the states of Mexico, and all the counties in the United States.
- Earth..3
- This dataset was created in 2000 and is like "Earth..2" except that the US counties are replaced with climate divisions within each state.
The name of the dataset (e.g. "Earth..1") is actually the basename for a set of files comprising the dataset. Other datasets, such as paleolithic continental boundaries, conforming to the
Ncarg4_1database scheme have been created, but they are not currently part of the standard NCAR Graphics distribution. If you have a dataset that conforms to the scheme, but is not located in the directory where map data is expected to be found (typically $NCARG_ROOT/lib/ncarg/database), you may specify a complete pathname (including the dataset basename) as the value of this resource.As with changing the value of mpDataBaseVersion You may freely switch between datasets after creating a mapplot. However, you may encounter warning messages if you have set any of the specifier resources (mpFillAreaSpecifiers, mpOutlineSpecifiers, mpMaskAreaSpecifiers, or mpMaskOutlineSpecifiers) with names that appear in one dataset and not the other.
This resource is ignored when using the
Ncarg4_0orRANGSdatabases. - mpDefaultFillColor (MapPlot)
-
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 values 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. - mpDefaultFillPattern (MapPlot)
-
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.When using the
RANGSdatabase this resource is ignored. - mpDefaultFillScaleF (MapPlot)
-
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.When using the
RANGSdatabase this resource is ignored. - mpDynamicAreaGroups (MapPlot)
-
MapPlot maintains two arrays that assign
area group numbers to each
area in a MapPlot 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. The mpDynamicAreaGroups
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
mpDynamicAreaGroups array is sometimes known as the
political groups array, since a map whose fill attributes are
based on these area groups shows national and perhaps state and even county 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
mpDynamicAreaGroups 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 mpDynamicAreaGroups array is
found in the discussion of area fill in the MapPlot
object description.
You may reassign the group numbers in the mpDynamicAreaGroups array in any manner you please. At minimum and by default there are 10 area groups, but by setting the resource mpAreaGroupCount you can increase the number of area groups to any number up to a maximum of 255.
- When using the
Ncarg4_0database: - See the Ncarg4_0 database table to find the dynamic area group associated with a particular area name.
- When using the
Ncarg4_1database: - There are three datasets available with this database, and the area names available differ depending on the dataset selected. See mpDataSetName for links to tables containing the dynamic area group associated with the area names contained in the available datasets.
- When using the
RANGSdatabase: - This resource is not used and is set to
NULL.
- When using the
- mpEllipticalBoundary (MapTransformation)
- When the boolean resource mpEllipticalBoundary is set True, the map projection area is limited to an ellipse inscribed within the normal rectangular perimeter of the viewport.
- mpFillAreaSpecifiers (MapPlot)
-
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.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 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.
Note that the names from different MapPlot databases and datasets are not necessarily compatible. Therefore, if mpFillAreaSpecifiers is non-NULL when you set mpDataBaseVersion and/or mpDataSetName to a different value, you are likely to encounter warning messages unless you also set mpFillAreaSpecifiers using names compatible with the new database. You can retrieve a list of compatible names by getting the value of mpAreaNames. Case is not significant for mpFillAreaSpecifiers string values.
- When using the
Ncarg4_0database: - 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. When a fill attribute for a specified fill area is not explicitly set, MapPlot uses its normal method of setting fill attributes based on area group assignments. The group number is 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 an individual area by prepending an exclamation point ('!') to the area's name.
- When using the
Ncarg4_1database: - The
NullAreastring constant is also defined. There is no substring matching facility. When a fill attribute for a specified fill area is not explicitly set, MapPlot uses its normal method of setting fill attributes based on area group assignments. The group number is chosen from the mpFixedAreaGroups array if the area's type is 1 (mpGeophysical) or if its type is 2 (mpContinental) and its parent is Water. Otherwise, the group number is chosen from the mpDynamicAreaGroups array. The use of the exclamation point ('!') prefix and the mpSpecifiedFillPriority resource is not supported.Available in version 4.2.0.a034 or later.
In addition to individual area names, you can specify subdivisions of certain areas (states, provinces, and counties) using pre-defined group names appended to the area name following a colon (':') character. - When using the
RANGSdatabase: - This resource is ignored.
- When using the
- mpFillBoundarySets (MapPlot)
-
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 mpMaskAreaSpecifiers.
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 fill regions comprising the states of the
United States. When using the
Ncarg4_0database, Alaska and Hawaii are not included, although a few areas outside the U.S. proper, including the Bahamas and a few lakes extending into Canadian territory, are drawn. When using theNcarg4_1database, Alaska and Hawaii are drawn, but no non-U.S. territory is included. You may add geophysical and/or national areas by name using the mpFillAreaSpecifiers resource. GeophysicalAndUSStates- MapPlot will draw area fill for all global geophysical features as well as for the states of the United States. Other national boundaries do not appear unless you specify them by name using the mpFillAreaSpecifiers resource.
AllBoundaries- MapPlot draws area fill for all the
boundaries for the database/dataset currently in use. When using the
Ncarg4_0database this includes geophysical and national boundaries as well as all U.S. states and inland water. When using theNcarg4_1database, depending on the dataset, this may include Canadian provinces, Mexican and US States, and counties or climate divisions of US states.
When the
Ncarg4_1database is in use, specifying an area name whose mpAreaTypes is 1 or 2 (mpGeophysicalormpContinental) has the effect of suppressing type 3 or higher fill areas within its borders even if the setting of mpFillBoundarySets would otherwise imply that they be drawn . For instance, setting mpFillAreaSpecifiers to the value "Africa" would have the effect of suppressing national boundaries within the African continent.When using the
RANGSdatabase this resource is ignored. - mpFillColor (MapPlot)
- When mpMonoFillColor 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.
- mpFillColors (MapPlot)
-
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: 16, 10, 8, 10, 26, 22, 11, 23, 13, 19. This choice of colors is intended to look reasonable with the "default" color map.
- mpFillDotSizeF (MapPlot)
- 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.
- mpFillDrawOrder (MapPlot)
-
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 predraw phase and anything drawn during the draw and postdraw phases.
Draw- Draw area fill during the standard draw; the fill overlays anything drawn during the predraw phase but underlies any other MapPlot elements drawn during the draw phase and anything drawn during the postdraw phase.
PostDraw- Draw area fill after the standard draw; the fill overlays anything drawn during the predraw and draw phases but underlies any other MapPlot elements drawn during the postdraw phase.
- mpFillOn (MapPlot)
-
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 (True for some gsn_csm_xxxx routines)
- mpFillPatternBackground (MapPlot)
-
mpFillPatternBackground specifies the HLU index of the color
used for the background in areas filled with any HLU
fill pattern besides
SolidFill. If this resource has the valueTransparent(-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. - mpFillPattern (MapPlot)
-
When mpMonoFillPattern 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.
When using the
RANGSdatabase this resource is ignored. - mpFillPatterns (MapPlot)
-
If mpMonoFillPattern is False, each element of the array
specifies the HLU
fill 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.
When using the
RANGSdatabase this resource is ignored.Default: MapPlot assigns patterns sequentially, beginning with HLU fill pattern index 1 for the first element of mpFillPatterns.
- mpFillScaleF (MapPlot)
-
When mpMonoFillPattern is set True, this floating point
resource sets a uniform
fill pattern scale factor for all MapPlot areas,
except for those whose fill scale factor is set explicitly using the
mpSpecifiedFillScales array resource.
When using the
RANGSdatabase this resource is ignored. - mpFillScales (MapPlot)
- 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.
- mpFixedAreaGroups (MapPlot)
-
MapPlot maintains two arrays that assign
area group numbers to each
area in a MapPlot 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. The mpFixedAreaGroups 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
Geophysicaland 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.
- When using the
Ncarg4_0database: - See the Ncarg4_0 database table to find the fixed area group associated with a particular area name.
- When using the
Ncarg4_1database: - There are three datasets available with this database, and the area names available differ depending on the dataset selected. See mpDataSetName for links to tables containing the fixed area group associated with the area names contained in the available datasets.
- When using the
RANGSdatabase: - This resource is not used and is set to
NULL.
- When using the
- mpGeophysicalLineColor (MapPlot)
- 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 mpUSStateLineColor.
- mpGeophysicalLineDashPattern (MapPlot)
-
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
mpUSStateLineDashPattern.
When using the
RANGSdatabase this resource is ignored. - mpGeophysicalLineDashSegLenF (MapPlot)
-
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
mpUSStateLineDashSegLenF. MapPlot
sets the default value of mpNationalLineDashSegLenF
dynamically based on the ratio of the actual plot viewport width to a
reference viewport width of 0.6 and a reference dash segment length of
0.15.
When using the
RANGSdatabase this resource is ignored. - mpGeophysicalLineThicknessF (MapPlot)
- 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 mpUSStateLineThicknessF.
- mpGreatCircleLinesOn (MapTransformation)
-
This resource selects between two methods for defining the
transformation of lines or edges between defined points of the data
space graphics primitive functions, NhlDataPolygon and NhlDataPolyline. If
mpGreatCircleLinesOn is False, the space between the
defined points is treated as if the latitude/longitude coordinate
system were cartesian. This method of performing the transformation
results in all straight lines between the defined points when
mpProjection is set to
CylindricalEquidistant. Another characteristic of this method is that, for any projection, a line between two points at the same latitude is coincident with the line of latitude itself.If mpGreatCircleLinesOn is set True, lines between defined points follow a great circle route, the shortest distance on the surface of the globe between the two points. In this case, lines appear curved on a cylindrical equidistant projection, except for the special cases of lines between points of equal longitude or of lines drawn near the equator. For any projection, lines between points of equal latitude diverge farther and farther from the line of latitude as the distance from the equator increases.
- mpGridAndLimbDrawOrder (MapPlot)
-
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 MapPlot fill drawn during the predraw phase but underlie other predraw phase MapPlot elements and anything drawn during the draw and postdraw phases.
Draw- Draw grid lines during the standard draw; the grid lines overlay anything drawn during the predraw phase and MapPlot fill drawn during the draw phase but underlie other draw phase MapPlot elements and anything drawn during the postdraw phase.
PostDraw- Draw grid lines after the standard draw; the grid lines overlay anything drawn during the predraw and draw phases and MapPlot fill drawn during the postdraw phase but underlie other postdraw phase MapPlot elements.
- mpGridAndLimbOn (MapPlot)
- 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.
- mpGridLatSpacingF (MapPlot)
- This resource specifies the spacing, in degrees, between MapPlot grid lines representing latitude. Use this resource if you want to set the latitude spacing independently of the longitude spacing. Note that setting mpGridSpacingF at the same time or subsequently overrides the value of this resource.
- mpGridLineColor (MapPlot)
- This resource sets the HLU index of a color used to draw the grid representing latitudes and longitudes.
- mpGridLineDashPattern (MapPlot)
- This resource sets the HLU index of a dash pattern used to draw the grid representing latitudes and longitudes.
- mpGridLineDashSegLenF (MapPlot)
- This resource specifies the length of each segment of the dash patterns 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 on the ratio of the actual plot viewport width to a reference viewport width of 0.6 and a reference dash segment length of 0.15.
- mpGridLineThicknessF (MapPlot)
- 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.
- mpGridLonSpacingF (MapPlot)
- This resource specifies the spacing, in degrees, between MapPlot grid lines representing longitude. Use this resource if you want to set the longitude spacing independently of the latitude spacing. Note that setting mpGridSpacingF at the same time or subsequently overrides the value of this resource.
- mpGridMaskMode (MapPlot)
-
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 mpMaskAreaSpecifiers array.
When using the
RANGSdatabase this resource is ignored. - mpGridMaxLatF (MapPlot)
- This resource specifies the maximum absolute value of the latitude at which a latitude grid line may appear. For instance, if you set mpGridMaxLatF to 70.0, no latitude lines will appear between 70 degrees and 90 degrees or between -70 degrees and -90 degrees. If the latitude spacing were set to 20.0, then, in this case, the highest and lowest latitude lines would be at 60 degrees and -60 degrees.
- mpGridPolarLonSpacingF (MapPlot)
- This resource has an effect only when the map projection is such that the North and South poles project to single points. In this case, it controls the way longitude lines are continued in the area between the pole and the latitude line nearest the pole. Basically it allows you to set an alternate spacing for longitude lines near the poles, generally for the purpose of avoiding overcrowding. For instance, if mpGridPolarLonSpacingF is set to its default value of 90.0 and the longitudinal spacing is set to 15.0, then only the longitude lines that are multiples of 90.0 continue to the poles. Note that if the longitudinal spacing were set to 20.0, lines would continue only at multiples of 180.0, since there would be no longitude lines to continue at 90.0 and 270.0.
- mpGridSpacingF (MapPlot)
- This resource specifies the spacing, in degrees, between MapPlot grid lines representing latitude and longitude. Use this resource if you want the spacing to be equal in latitude and longitude. Setting this resource overrides any values set for the resources mpGridLatSpacingF and mpGridLonSpacingF and causes them both to be set to the value given mpGridSpacingF.
- mpInlandWaterFillColor (MapPlot)
-
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 values greater than
-1 (
Transparent). 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. - mpInlandWaterFillPattern (MapPlot)
-
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.When using the
RANGSdatabase this resource is ignored. - mpInlandWaterFillScaleF (MapPlot)
-
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.When using the
RANGSdatabase this resource is ignored. - mpLabelDrawOrder (MapPlot)
-
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 predraw phase but underlie anything drawn during the draw and postdraw phases.
Draw- Draw labels during the standard draw; the labels overlay anything drawn during the predraw phase and any other MapPlot elements drawn during the draw phase but underlie anything drawn during the postdraw phase.
PostDraw- Draw labels after the standard draw; the labels overlay anything drawn during the predraw and draw phases and all other MapPlot elements drawn during the postdraw phase.
- mpLabelFontColor (MapPlot)
- This resource specifies the hlu color index used to draw the characters used for MapPlot labels.
- mpLabelFontHeightF (MapPlot)
- 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.
- mpLabelsOn (MapPlot)
- This boolean resource determines whether the MapPlot object draws labels identifying the equator ("EQ"), Greenwich Meridian ("GM"), International Dateline ("ID"), North Pole ("NP"), and South Pole ("SP").
- mpLambertMeridianF (MapTransformation)
-
When mpProjection is set to the value
LambertConformal, this resource specifies the central meridian (line of longitude in degrees) of the projection. This resource has nearly the same meaning that mpCenterLonF has for the other projections. - mpLambertParallel1F (MapTransformation)
-
When mpProjection is set to the value
LambertConformal, this resource specifies one of the two standard parallels (lines of latitude in degrees) used to define the conic projection. A simpler conic projection is defined when mpLambertParallel1F and mpLambertParallel2F are equal. Normally, mpLambertParallel1F and mpLambertParallel2F should not be more than 90.0 degrees apart. - mpLambertParallel2F (MapTransformation)
-
When mpProjection is set to the value
LambertConformal, this resource specifies one of the two standard parallels (lines of latitude in degrees) used to define the conic projection. A simpler conic projection is defined when mpLambertParallel1F and mpLambertParallel2F are equal. Normally, mpLambertParallel1F and mpLambertParallel2F should not be more than 90.0 degrees apart. - mpLandFillColor (MapPlot)
-
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 values greater than -1 (
Transparent). 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. - mpLandFillPattern (MapPlot)
-
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.When using the
RANGSdatabase this resource is ignored. - mpLandFillScaleF (MapPlot)
-
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.When using the
RANGSdatabase this resource is ignored. - mpLeftAngleF (MapTransformation)
-
When mpLimitMode has the value
Angles, this resource specifies the positive angle in degrees left from the center to the edge of the projection, or, if using a satellite projection, the displacement angle left from the satellite line of sight to the projection center. Note that direction of the line over which the angle is measured remains parallel to the top of the viewport, regardless of the rotation angle applied to the projection. mpLeftAngleF has a maximum allowable value that varies depending on the projection. - mpLeftCornerLatF (MapTransformation)
-
When mpLimitMode has the value
Corners, this resource specifies the latitude, in degrees, of the left corner point. - mpLeftCornerLonF (MapTransformation)
-
When mpLimitMode has the value
Corners, this resource specifies the longitude, in degrees, of the left corner point. - mpLeftMapPosF (MapTransformation)
- This read-only resource contains the coordinate of the left edge of the projected area in NDC space.
- mpLeftNDCF (MapTransformation)
-
When mpLimitMode has the value
NDC, this resource specifies the left edge of the limiting rectangle in Normalized Device Coordinates. If mpLeftNDCF is set to a value greater than mpRightNDCF, a warning is issued and the values are exchanged. Since the relationship between the map projection area and NDC coordinates changes whenever the map limits are changed, as well as when the viewport area is moved or resized, MapTransformation resets the value of mpLeftNDCF to the NDC value of the left edge of the projected area at the end of any update to the transformation. - mpLeftNPCF (MapTransformation)
-
When mpLimitMode has the value
NPC, this resource specifies the left edge of the limiting rectangle in Normalized Projection Coordinates. mpLeftNPCF is constrained to values in the range 0.0 through 1.0. If mpLeftNPCF is set to a value greater than mpRightNPCF, a warning is issued and the values are exchanged. The value of mpLeftNPCF is updated whenever the map limits are set using any of the map limit modes. - mpLeftPointLatF (MapTransformation)
-
When mpLimitMode has the value
Points, this resource specifies the latitude, in degrees, of a point along the left edge of the limiting rectangle. - mpLeftPointLonF (MapTransformation)
-
When mpLimitMode has the value
Points, this resource specifies the longitude, in degrees, of a point along the left edge of the limiting rectangle. - mpLeftWindowF (MapTransformation)
-
When mpLimitMode has the value
Window, this resource specifies the value, in window coordinates, of the left edge of the projection. - mpLimbLineColor (MapPlot)
- This resource sets the HLU index of the color used for the limb line drawn at the edge of visibility in certain map projections.
- mpLimbLineDashPattern (MapPlot)
- 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.
- mpLimbLineDashSegLenF (MapPlot)
- 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 on the ratio of the actual plot viewport width to a reference viewport width of 0.6 and a reference dash segment length of 0.15.
- mpLimbLineThicknessF (MapPlot)
- 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.
- mpLimitMode (MapTransformation)
-
This resource of type NhlTMapLimitMode specifies how MapTransformation determines the extent of the projected globe that is mapped into the viewport area. It has eight possible settings:
MaximalArea- The maximum viewable area of the globe allowed by the projection is mapped into the viewport area.
LatLon- MapTransformation maps into the viewport the maximum viewable portion of the area given the projection, the projection center, and bounded by latitudes mpMinLatF and mpMaxLatF and longitudes mpMinLonF and mpMaxLonF. If you set boundaries such that the resulting area has zero extent, MapTransformation issues a warning and resets mpLimitMode to the value NhlMAXIMALAREA. If you set mpMinLatF to a value greater than mpMaxLatF or mpMinLonF to a value greater than mpMaxLatF, MapTransformation issues a warning and exchanges the values.
Angles- For most projections, the area mapped into the viewport is based
on the positive angular distance from the center of the projection, in
each of the four directions determined by the resources
mpRightAngleF, mpLeftAngleF,mpBottomAngleF,
and mpTopAngleF. For the satellite projection, the angles
represent angular deviation from the line of sight from the satellite
to the projection center. Angular limits are not supported if
mpProjection has the value NhlLAMBERTCONFORMAL or NhlROTATEDMERCATOR. Note that
left, right, bottom, and top are oriented with respect to the viewplane;
therefore, if mpCenterRotF has a non-zero value,
the angles represent varying combinations of latitudinal and longitudinal
components.
Depending on the projection, the maximum allowable value for each of the angle resources varies, as follows:
Orthographic- mpLeftAngleF and mpRightAngleF: 90.0
mpBottomAngleFand mpTopAngleF: 90.0 Stereographic- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 180.0 LambertEqualArea- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 180.0 Gnomonic- mpLeftAngleF and mpRightAngleF: 85.0
mpBottomAngleFand mpTopAngleF: 85.0 AzimuthalEquidistant- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 180.0 Satellite- mpLeftAngleF and mpRightAngleF: 90.0
mpBottomAngleFand mpTopAngleF: 90.0 Mollweide- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 180.0 Mercator- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 85.0 CylindricalEquidistant- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 90.0 LambertConformal- not supported
Robinson- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 90.0 CylindricalEqualArea- mpLeftAngleF and mpRightAngleF: 180.0
mpBottomAngleFand mpTopAngleF: 90.0 RotatedMercator- not supported
NPCNPClimits the area based on "Normalized Projection Coordinates," which map the maximal area of the projection into a rectangle bounded by 0.0 and 1.0 horizontally and vertically. Use the resources mpLeftNPCF, mpRightNPCF, mpBottomNPCF, and mpTopNPCF to set normalized projection coordinate limits. If you set NPC boundaries such that the resulting area has zero extent, MapTransformation issues a warning and resets mpLimitMode to the value NhlMAXIMALAREA. If you set mpLeftNPCF to a value greater than mpRightNPCF or mpBottomNPCF to a value greater than mpTopNPCF, MapTransformation issues a warning and exchanges the values. MapTransformation keeps the NPC resources updated to their current value no matter which method is used to set the map limits.NDCNDClimits the area based on the current location of the projected map in Normalized Device Coordinates. Use the resources mpLeftNDCF, mpRightNDCF, mpBottomNDCF, and mpTopNDCF to set normalized device coordinate limits. If you set NDC boundaries such that the resulting area has zero extent, MapTransformation issues a warning and resets mpLimitMode to the value NhlMAXIMALAREA. If you set mpLeftNDCF to a value greater than mpRightNDCF or mpBottomNDCF to a value greater than mpTopNDCF, MapTransformation issues a warning and exchanges the values. Note that setting these resources usually causes the mapping between the projection space and NDC space to change. Changes to the location of the size or shape of the viewport into which the map is projected also modify the mapping into NDC space. Therefore, at the completion of each SetValues call, MapTransformation internally sets the value of each mp...NDCF resource to the new location of the original projected coordinate: that is, to one of the boundaries of the projected area.Corners- MapTransformation maps into the viewport a rectangular
area with one corner at the point mpLeftCornerLatF and
mpLeftCornerLonF, and the opposite corner at the point
mpRightCornerLatF and mpRightCornerLonF. The value
of mpLeftCornerLonF should be less than
mpRightCornerLonF. If either point is outside the maximal
area given the projection and projection center, a warning is returned
and the limit mode defaults to
MaximalArea. Points- MapTransformation maps into the viewport an area
defined by a viewspace rectangle containing the four points defined by
mpLeftPointLatF, mpLeftPointLonF,
mpRightPointLatF, mpRightPointLonF,
mpBottomPointLatF, mpBottomPointLonF,
mpTopPointLatF, and mpTopPointLonF. If any point is
outside the maximal area given the projection and projection center, a
warning is returned and the limit mode defaults to
MaximalAreamode. Window- MapTransformation maps into the viewport an area
bounded by the window coordinates specified by the resources
mpLeftWindowF, mpRightWindowF,
mpBottomWindowF, and mpTopWindowF. The window
coordinates are in an intermediate rectangular coordinate system into
which the map coordinates are mapped prior to the mapping into NDC
coordinates. Its extents vary depending on the value of
mpProjection. If you set mpLeftWindowF to
a value greater than mpRightWindowF, or
mpBottomWindowF to a value greater than mpTopWindowF,
MapTransformation issues a warning and exchanges the
values. MapTransformation keeps the
Windowresources updated to their current value no matter which method is used to set the map limits.
- mpMaskAreaSpecifiers (MapPlot)
-
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. 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.
Note that the names from different MapPlot databases are not necessarily compatible. Therefore, if mpMaskAreaSpecifiers is non-NULL when you set mpDataBaseVersion and/or mpDataSetName to a different value, you are likely to encounter warning messages unless you also set mpMaskAreaSpecifiers using names compatible with the new database. You can retrieve a list of compatible names by getting the value of mpAreaNames. Case is not significant for mpMaskAreaSpecifiers string values.
- When using the
Ncarg4_0database: - In addition to the individual area names, you may include certain pre-defined groups of areas using a number of pre-defined string constants. Moreover, there is a substring matching facility that allows you to specify groups of areas sharing a common substring.
- When using the
Ncarg4_1database: - The
NullAreastring constant is defined. Due to the hierarchical nature of this database many area groupings occur as named entities in their own right. For instance, you can mask filling of the small islands of the Pacific Ocean by including the string "Pacific Islands" as an element of mpMaskAreaSpecifiers. There is no substring matching facility.Available in version 4.2.0.a034 or later.
In addition to individual area names, you can specify subdivisions of certain areas (states, provinces, and counties) using pre-defined group names appended to the area name following a colon (':') character. - When using the
RANGSdatabase: - This resource is ignored.
- When using the
- mpMaskOutlineSpecifiers (MapPlot)
-
Available in version 4.2.0.a034 or later.
Specify the names of outlines MapPlot is to mask, if the boolean resource mpOutlineMaskingOn is set to True. These outlines are subtracted from the outline set specified using the resource mpOutlineBoundarySets and mpOutlineSpecifiers. Note that commonly the outline of an area shares its border with a number of other areas. Masking the outline of an area causes all these common borders not to be drawn. There is an order of precedence for outline drawing masking. Explicitly named outlines take precedence over outline groupings, and small outlines take precedence over enclosing larger outlines. Otherwise masking takes precedence over filling.
Note that the names from different MapPlot databases and/or datasets are not necessarily compatible. Therefore, if mpMaskOutlineSpecifiers is non-NULL when you set mpDataBaseVersion and/or mpDataSetName to a different value, you are likely to encounter warning messages unless you also set mpMaskOutlineSpecifiers using names compatible with the new database. You can retrieve a list of compatible names for the current database/dataset by getting the value of mpAreaNames. Case is not significant for mpMaskOutlineSpecifiers string values.
- When using the
Ncarg4_0database: - In addition to the individual area names, you may include certain pre-defined groups of areas using a number of pre-defined string constants. Moreover, there is a substring matching facility that allows you to specify groups of areas sharing a common substring.
- When using the
Ncarg4_1database: - The
NullAreastring constant is defined. Due to the hierarchical nature of this database, many area groupings occur as named entities in their own right. For instance, you can mask the outlines of the small islands of the Pacific Ocean by including the string "Pacific Islands" as an element of mpMaskOutlineSpecifiers. There is no substring matching facility.In addition to individual area names, you can specify subdivisions of certain areas (states, provinces, and counties) using pre-defined group names appended to the area name following a colon (':') character.
There are some subtleties involved in outline masking when using the
Ncarg4_1database that do not occur with area masking. Areas with higher types override lower typed areas. For instance, if you want to mask interior water bodies to simplify the appearance of a map, you might specify "Water" as an element of mpMaskOutlineSpecifiers. However, this would cause all ocean coast lines to disappear because "Ocean" is a member of the "Water" hierarchy. You can overcome this problem by adding "Ocean" to the mpOutlineSpecifier array resource. Since "Ocean" is a type 2 entity it overrides the masking of "Water", one of the two type 1 entities. Also If you add national, state, or county outlines to a map in which the inland water bodies have been masked, you will find that some water bodies still appear. That is because they form part of the the boundary between entities that have been specified. - When using the
RANGSdatabase: - This resource is ignored.
- When using the
- mpMaxLatF (MapTransformation)
-
When mpLimitMode has the value
LatLon, this resource specifies the maximum latitude bounding the area to be mapped to the viewport. It should not be greater than 90.0. - mpMaxLonF (MapTransformation)
-
When mpLimitMode has the value
LatLon, this resource specifies the maximum longitude bounding the area to be mapped to the viewport. It may be set to any value in the range -540.0 to 540.0 such that mpMaxLonF minus mpMinLonF is greater than 0.0 and less than or equal to 360.0. - mpMinLatF (MapTransformation)
-
When mpLimitMode has the value
LatLon, this resource specifies the minimum latitude bounding the area to be mapped to the viewport. It should not be less than -90.0. - mpMinLonF (MapTransformation)
-
When mpLimitMode has the value
LatLon, this resource specifies the minimum longitude bounding the area to be mapped to the viewport. It may be set to any value in the range -540.0 to 540.0 such that mpMaxLonF minus mpMinLonF is greater than 0.0 and less than or equal to 360.0. - mpMonoFillColor (MapPlot)
- 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 mpFillColor. When False, the elements of the array resource mpFillColors control the fill color indexes for MapPlot areas based on the area group numbers assigned to each area.
- mpMonoFillPattern (