Element: <oj-thematic-map-marker>

Oracle® JavaScript Extension Toolkit (JET)
5.2.0
E97691-01

QuickNav

Attributes

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Version:
  • 5.2.0
Since:
  • 5.2.0
Module:
  • ojthematicmap

JET Thematic Map Marker

The oj-thematic-map-marker element is used to declare properties for thematic map markers and is only valid as the child of a template element for the markerTemplate slot of oj-thematic-map. 


<oj-thematic-map marker-data='[[markerDataProvider]]' map-provider='[[mapProvider]]'>
 <template slot='markerTemplate'>
   <oj-thematic-map-marker  color='[[$current.data.color]]' value='[[$current.data.value]]'
     x='[[$current.data.lat]]' y='[[$current.data.long]]'>
   </oj-thematic-map-marker>
 </template>
</oj-thematic-map>

Attributes

border-color :string

The marker border color.
Default Value:
  • ""
Example

Initialize the thematic map marker with the border-color attribute specified:

<oj-thematic-map-marker border-color='3'></oj-thematic-map-marker>

border-style :string

The marker border style.
Supported Values:
Name Type
"none" string
"solid" string
Default Value:
  • "solid"
Example

Initialize the thematic map marker with the border-style attribute specified:

<oj-thematic-map-marker border-style='none'></oj-thematic-map-marker>

border-width :number

The marker border width in pixels.
Default Value:
  • 0.5
Example

Initialize the thematic map marker with the border-width attribute specified:

<oj-thematic-map-marker border-width='none'></oj-thematic-map-marker>

categories :Array.<string>

An array of category strings corresponding to this marker. This allows highlighting and filtering of markers. By default, the label is used as the marker category.
Default Value:
  • []
Example

Initialize the thematic map marker with the categories attribute specified:

<oj-thematic-map-marker categories='[[$current.data.categories]]'></oj-thematic-map-marker>

color :string

The marker color. The default values come from the CSS classess and varies based on theme.
Default Value:
  • null
Example

Initialize the thematic map marker with the color attribute specified:

<oj-thematic-map-marker color='[[$current.data.color]]'></oj-thematic-map-marker>

height :number

The marker height in pixels.
Default Value:
  • 8
Example

Initialize the thematic map marker with the height attribute specified:

<oj-thematic-map-marker height='3'></oj-thematic-map-marker>

label :string

Text used for the marker's label.
Default Value:
  • ""
Example

Initialize the thematic map marker with the label attribute specified:

<oj-thematic-map-marker label='[[$current.data.label]]'></oj-thematic-map-marker>

label-position :string

Determines the label position relative to the marker.
Supported Values:
Name Type
"bottom" string
"center" string
"top" string
Default Value:
  • "center"
Example

Initialize the thematic map marker with the label-position attribute specified:

<oj-thematic-map-marker label-position='bottom'></oj-thematic-map-marker>

label-style :object

The CSS style object defining the style of the marker. The default values come from the CSS classess and varies based on theme.
Default Value:
  • null
Example

Initialize the thematic map marker with the label-style attribute specified:

<oj-thematic-map-marker label-style='{"color":"black","fontSize":"12px"}'></oj-thematic-map-marker>

location :string

An identifier corresponding to a Feature provided in the mapProvider geo object that this marker is associated with.
Default Value:
  • ""
Example

Initialize the thematic map marker with the location attribute specified:

<oj-thematic-map-marker location='[[$current.data.location}}'></oj-thematic-map-marker>

opacity :number

The marker opacity.
Default Value:
  • 1
Example

Initialize the thematic map marker with the opacity attribute specified:

<oj-thematic-map-marker opacity='0.5'></oj-thematic-map-marker>

rotation :number

The angle to rotate the marker in clockwise degrees around the marker center.
Default Value:
  • 0
Example

Initialize the thematic map marker with the rotation attribute specified:

<oj-thematic-map-marker rotation='180'></oj-thematic-map-marker>

selectable :string

Specifies whether or not the marker will be selectable.
Supported Values:
Name Type
"auto" string
"off" string
Default Value:
  • "auto"
Example

Initialize the thematic map marker with the selectable attribute specified:

<oj-thematic-map-marker selectable='off'></oj-thematic-map-marker>

shape :string

Specifies the shape of a marker. Can take the name of a built-in shape or the svg path commands for a custom shape.
Default Value:
  • "circle"
Example

Initialize the thematic map marker with the shape attribute specified:

<oj-thematic-map-marker shape='star'></oj-thematic-map-marker>

short-desc :string

The text that displays in the marker's tooltip.
Default Value:
  • ""
Example

Initialize the thematic map marker with the short-desc attribute specified:

<oj-thematic-map-marker short-desc='[[$current.data.shortDesc]]'></oj-thematic-map-marker>

source :string

Specifies an URI specifying the location of the image resource to use for the marker instead of a built-in shape. The shape attribute is ignored if the source image is defined.
Default Value:
  • ""
Example

Initialize the thematic map marker with the source attribute specified:

<oj-thematic-map-marker source='[[$current.data.source]]'></oj-thematic-map-marker>

source-hover :string

An optional URI specifying the location of the hover image resource. If not defined, the source image will be used.
Default Value:
  • ""
Example

Initialize the thematic map marker with the source-hover attribute specified:

<oj-thematic-map-marker source-hover='[[$current.data.sourceHover]]'></oj-thematic-map-marker>

source-hover-selected :string

An optional URI specifying the location of the selected image resource on hover. If not defined, the sourceSelected image will be used. If sourceSelected is not defined, then the source image will be used. * @expose
Default Value:
  • ""
Example

Initialize the thematic map marker with the source-hover-selected attribute specified:

<oj-thematic-map-marker source-hover-selected='[[$current.data.sourceHoverSelected]]'></oj-thematic-map-marker>

source-selected :string

An optional URI specifying the location of the selected image. If not defined, the source image will be used.
Default Value:
  • ""
Example

Initialize the thematic map marker with the source-selected attribute specified:

<oj-thematic-map-marker source-selected='[[$current.data.sourceSelected]]'></oj-thematic-map-marker>

svg-class-name :string

The CSS style class defining the style of the marker.
Default Value:
  • ""
Example

Initialize the thematic map marker with the svg-class-name attribute specified:

<oj-thematic-map-marker svg-class-name='markerStyle'></oj-thematic-map-marker>

svg-style :object

The CSS style object defining the style of the marker.
Default Value:
  • {}
Example

Initialize the thematic map marker with the svg-style attribute specified:

<oj-thematic-map-marker svg-style='{"color": "red"}'></oj-thematic-map-marker>

value :number

A data value used to calculate the marker dimensions based on the range of all the data values and the element size. Markers with negative or zero data values will not be rendered. If specified, this value takes precedence over the width and height attributes.
Default Value:
  • 2
Example

Initialize the thematic map marker with the value attribute specified:

<oj-thematic-map-marker value='[[$current.data.value]]'></oj-thematic-map-marker>

width :number

The pixel width for this marker. Note that this attribute will be ignored if a value is provided to calculate marker.
Default Value:
  • 8
Example

Initialize the thematic map marker with the width attribute specified:

<oj-thematic-map-marker width='3'></oj-thematic-map-marker>

x :number|null

The x coordinate of the marker transformed using the map projection, which can be null if location is set instead.
Default Value:
  • null
Example

Initialize the thematic map marker with the x attribute specified:

<oj-thematic-map-marker x='[[$current.data.lat]]'></oj-thematic-map-marker>

y :number|null

The x coordinate of the marker transformed using the map projection, which can be null if location is set instead.
Default Value:
  • null
Example

Initialize the thematic map marker with the y attribute specified:

<oj-thematic-map-marker y='[[$current.data.long]]'></oj-thematic-map-marker>