<dvt:mapColorTheme>

mapColorTheme map color theme

The mapColorTheme tag is used within the <dvt:map> tag to provide the ability to associate different regions of a map with different colors. Each color represents a range of data values known as a "bucket", and the color of a region depends on which bucket its data falls into. For example, this tag might be used to identify a range of colors to represent the popularity of a product in different states, where a state gets colored red if the product is not popular and green if the product is very popular.

To use a Color Theme, the developer needs to specify the colors that will be used. This can be done either by defining the min and max color values with the total number of buckets, or by defining a list of discrete colors to use.

Only one color theme can be visible in a map at a given time.

Model

The Color Theme uses an underlying model to abstract the data that gets displayed in the theme. The specific model class is oracle.adf.view.faces.bi.model.GeoMapDataModel . The GeoMapDataModel contains information about the location and data associated with each colored region. The model can be set through the value attribute of the mapColorTheme tag.

Min/Max Colors

A Color Theme can be defined by a gradient of colors over a particular range specified by the minColor and maxColor attributes. In this case the map will divide the data associated with the theme into a number of buckets determined by the bucketCount attribute. It will then calculate the colors, ranging from minColor to maxColor with graduated colors in between, to assign to each bucket.

In the example below, the Color Theme has minColor = #000000, maxColor = #ffffff, and bucketCount = 5, so the colors of the five buckets are: #000000, #444444, #888888, #bbbbbb, and #ffffff.

            <dvt:map ...map attributes...>
              <dvt:mapColorTheme id="mapColorTheme1" value="#{backingBean.geoMapModel}"
                themename="MAP_STATES_NAME" locationColumn="POLYGON_NAME" bucketCount="5"
                 minColor="#000000" maxColor="#ffffff" />
            </dvt:map>
            

Discrete Colors

A Color Theme can also be defined by a list of discrete colors set by the attribute. In this case, each bucket is represented by a color explicitely named in the colorList. The colorList can either be a color array or a semicolon-separated string.

In the example below, the theme's colorList is "#ff0000;#00ff00;#0000ff", so the color of the first bucket is #ff0000, the second bucket is #00ff00, and the third bucket is #0000ff.

            <dvt:map ...map attributes...>
              <dvt:mapColorTheme 
                themename="MAP_STATES_NAME" colorList = "#ff0000; #00ff00; #0000ff" />
            </dvt:map>
            

Connection to Base Map Themes

The base map theme on which this Color Theme layer is based is specified by the themeName attribute. This base map theme determines the geometries of the colored and uncolored regions, and must come from the same data source as the base map.

If you are using Oracle's hosted eLocation services to configure the Map component, the themeName attribute for this tag should be set to one of the following five choices:

• MAP_CONTINENTS_NAME
• MAP_COUNTIES_NAME
• MAP_COUNTRIES_NAME
• MAP_STATES_NAME
• MAP_STATES_ABBRV

Depending on the base map theme you choose your data model should have the corresponding polygon names. If you choose MAP_STATES_ABBRV then your data model must have state abbreviations for matching the rows with the appropriate polygons.

Legend Customization

By default, the ID of the mapColorTheme is used as the label when that theme is displayed in the legend or in the Theme Selection dialog. However, each mapColorTheme tag has the following attributes that serve as optional labels for the theme:

• shortLabel: Specifies a label for the theme when displayed in the map legend
• menuLabel: Specifies a label for the theme in the Theme Selection dialog

Selection

The Color Theme supports the ability to select one or more regions on the map using the mapToolbar's rectangle/circle/polygon/point selection tools. When the user defines a selected area on the map, any of the predefined theme regions, colored or uncolored, that fall within the selected area will be highlighted and the selectionListener will be fired.

Relationship with other tags

The <dvt:mapColorTheme> tag is a child of the <dvt:map> tag

The <dvt:mapColorTheme> tag can have the following children:

• <af:convertNumber>

Deprecated children:

• <dvt:numberFormat>

Events

Attributes

public void processSelection(MapSelectionEvent mapSelectionEvent) {
    Iterator iterator = mapSelectionEvent.getIterator();
        
    while (iterator.hasNext())
    {
        DataContent dt = (DataContent)iterator.next();    
        String selectedLocation = dt.getLocationName();
        System.out.println (selectedLocation);
    }                        
}                
        

 public void processMouseClick(MapClickActionEvent mapClickActionEvent) {
     if (mapClickActionEvent.getDataContent() != null)
     {
         DataContent dt = mapClickActionEvent.getDataContent();
         System.out.println ("Location Name: " + dt.getLocationName());
     }
        
     System.out.println("MouseX " + mapClickActionEvent.getMouseX()); 
     System.out.println("MouseY " + mapClickActionEvent.getMouseY());         
}