Element: <oj-thematic-map-link>

Oracle® JavaScript Extension Toolkit (JET)
19.0.0
G25385-01

Since:
  • 5.2.0
Module:
  • ojthematicmap

QuickNav

Attributes

Other Topics


JET Thematic Map Link

The oj-thematic-map-link element is used to declare properties for thematic map links and is only valid as the child of a template element for the linkTemplate slot of oj-thematic-map. 


<oj-thematic-map link-data='[[linkDataProvider]]' map-provider='[[mapProvider]]'>
 <template slot='linkTemplate'>
   <oj-thematic-map-link  start-location='[[$current.data.start]]' end-location='[[$current.data.end]]'>
   </oj-thematic-map-link>
 </template>
</oj-thematic-map>


Usage

Signature:

interface ThematicMapLinkElement<K1=any,K2=any,D1=any>

Generic Parameters
ParameterDescription
K1Type of key of the linkData dataprovider
K2Type of key used to specify start-location and end-location
D1Type of data from the linkData dataprovider
Typescript Import Format
//To typecheck the element APIs, import as below.
import { ThematicMapLinkElement } from "ojs/ojthematicmap";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojthematicmap";

For additional information visit:


Styling

CSS Variables

See JET CSS Variables for additional details.
Name Type Description
--oj-thematic-map-link-color <color> Thematic map link color

Attributes

categories :Array<string>

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

color :string

The link color.
Default Value:
  • ""

end-location :object

An object used to determine the end point of the link.
Default Value:
  • {}

end-location.id :any

The marker or area id to be used as the end point.

end-location.location :string

An identifier corresponding to a Feature provided in the mapProvider geo object to be used as the end point.

end-location.x :number

The x coordinate which can represent longitude of the end point.

end-location.y :number

The y coordinate which can represent latitude of the end point.

selectable :"auto"|"off"

Specifies whether or not the link will be selectable.
Supported Values:
Value
auto
off
Default Value:
  • "auto"

(nullable) short-desc :(string | ((context: ojThematicMap.LinkShortDescContext<K1,K2,D1>) => string))

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

start-location :object

An object used to determine the start point of the link.
Default Value:
  • {}

start-location.id :any

The marker id to be used as the start point.

start-location.location :string

An identifier corresponding to a Feature provided in the mapProvider geo object to be used as the start point.

start-location.x :number

The x coordinate which can represent longitude of the start point.

start-location.y :number

The y coordinate which can represent latitude of the start point.

svg-class-name :string

The CSS style class defining the style of the link.
Deprecated:
Since Description
19.0.0 The svgClassName property is deprecated. This API is not recommended in Redwood theme. Use other customization APIs where appropriate.
Default Value:
  • ""

svg-style :Partial<CSSStyleDeclaration>

The CSS style object defining the style of the link. Only SVG CSS style properties are supported.
Deprecated:
Since Description
19.0.0 The svgStyle property is deprecated. This API is not recommended in Redwood theme. Use other customization APIs where appropriate.
Default Value:
  • {}

width :number

The link width in pixels.
Default Value:
  • 2