Oracle Fusion Middleware Data Visualization Tools Tag Reference for Oracle ADF Faces 11g Release 2 (11.1.2.0.0) E17490-01 |
UIComponent class: oracle.adf.view.faces.bi.component.common.UIMarker
Component type: oracle.dss.adf.common.Marker
A marker is used to stamp out built-in or custom shapes associated with data points on the map. Markers can be customized with different stylistic attributes such as colors and patterns based on their underlying data.
The Thematic Map supports a predefined set of shapes ("circle", "square", etc) that can be specified with the shape attribute on the marker tag. For custom markers, the shapePath attribute can be used to specify the path of an SVG file that will get displayed in place of a built-in marker shape. If a shapePath is specified, then the value of the shape attribute is ignored.
Marker shapes can also be specified via skinning. With the skinning approach, predefined marker types can be overwritten, and the paths for custom markers can also be defined without the shapePath attribute. In this case, the "shape" attribute in dvt:marker is used for defining built-in or custom shapes.
A predefined shape will be overwritten if a global or component-specific selector for that shape is specified:
<dvt:marker id="m1" shape="circle"/> af|dvt-thematicMap::shape-circle{ -tr-path: url(/resources/newCircle.svg); }
In order to specify a custom shape in the shape attribute, a "custom" prefix is required. For example if the shape is customFoo then the skin file should have a .AFDVTShapeCustomFoo:alias selector defined or the Thematic Map specific af|dvt-thematicMap::shape-customFoo defined which has the -tr-path property pointing to the svg file.
<dvt:marker id="m1" shape="customFoo"/> af|dvt-thematicMap::shape-customFoo{ -tr-path: url(/resources/newShape.svg); }
Label text and styles can be specified on the marker tag. The value attribute is used to specify the text of the label, and the labelDisplay, lableStyle, and labelPosition attributes can be used to customize the appearance and location of these labels. When labelDisplay="on" then the provided label value and labelStyle will be displayed at the given labelPosition relative to the marker. If a marker is displayed on a region (i.e. you have a marker within an areaDataLayer), and that marker has a label, then the label associated with the basemap region will NOT be shown.
The Thematic Map supports formatting of the marker labels specified in the value attribute. This can be done either by adding an <af:convertNumber> as a child of <dvt:marker> or by specifying a converter via EL directly on the <dvt:marker> tag. If the value is numeric, then the properties of the given converter will be used to format the number appropriately. For example:
<!--This uses a converter from the backing bean to convert the value--> <dvt:marker id="m1" labelDisplay="on" value="#{mapBean.value}" converter="#{mapBean.myConverter}"/> <!--This uses the child convertNumber tag to convert the value--> <dvt:marker id="m2" labelDisplay="on" value="#{mapBean.value}" > <af:convertNumber id="cn1" type="currency"/> </dvt:marker>
If both a converter and a child af:convertNumber tag are specified, then the properties of the child tag take precedence.
A marker can be used as a drag source. To make a marker a drag source, the application developer simply needs to add an <af:dragSource> as its child.
Example:
<dvt:marker fillColor="#{row.color}" scaleX="#{row.size/2}" scaleY="#{row.size/2}" shape="circle" id="m1"> <af:dragSource actions="COPY" discriminant="DnDDemoModel"/> </dvt:marker>
The <dvt:attributeGroups> tag can be used as a child of dvt:marker. Instead of specifying fillColor, pattern, opacity, shape, scaleX, or scaleY directly on the marker tag, developers can use attributeGroups with type = "color", "pattern", "opacity", "shape", "scaleX", or "scaleY" to get these attributes automatically generated based on categorical bucketing of the data set. If any of these attributes are specified both in the marker tag and within the attributeGroups type, then the style generated by the attributeGroups will take precedence.
The <dvt:marker> tag can have the following children:
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent | Invoke Application, Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
Name | Type | Supports EL? | Description |
---|---|---|---|
action | javax.el.MethodExpression | Yes | A reference to an action method sent by the component, or the static outcome of an action. |
actionListener | javax.faces.el.MethodBinding | Only EL | A method reference to an action listener |
attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
binding | oracle.adf.view.faces.bi.component.common.UIMarker | Only EL | an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean. |
converter | javax.faces.convert.Converter | Yes | A converter object |
destination | String | Yes | The URI this component references |
fillColor | String | Yes | Default Value: #000000 Specifies the fill color of this marker. Valid values are RGB hexadecimal. |
fillPattern | String | Yes | Specifies the built-in pattern used to fill this marker. Valid values are:
|
gradientEffect | String | Yes | Valid Values: auto, none Default Value: auto Determines the gradient effect that should be used for this marker. Valid values are:
|
id | String | Yes | the identifier for the component |
labelDisplay | String | Yes | Valid Values: on, off Default Value: off Determines how labels associated with this marker should be displayed. Valid values are:
|
labelPosition | String | Yes | Valid Values: top, center, bottom Default Value: center Determines the position relative to the marker that the specified value label should be displayed. Valid values are:
|
labelStyle | String | Yes | The font style for labels associated with this marker. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc. |
opacity | double | Yes | Specifies the opacity of the fill color of the marker. Valid values are from 0.0 - 1.0, where 0.0 is transparent and 1.0 is opaque. |
rendered | boolean | Yes | Default Value: true Specifies whether the component is rendered. The default value is true. |
scaleX | double | Yes | The horizontal scale factor for this marker. This determines how much to scale the marker from its default size. |
scaleY | double | Yes | The vertical scale factor for this marker. This determines how much to scale the marker from its default size. |
shape | String | Yes | Specifies the shape of this marker. The predefined shapes are:
|
shapePath | String | Yes | The path to the svg file to use as custom shape. If a shapePath is specified, then the value of the shape attribute is ignored. |
shortDesc | String | Yes | The short description of this component. This is used to customize the text that displays in the marker's tooltip. |
value | String | Yes | The value of the component. When labelDisplay="on", this value will be used as the text label for this marker. |