/**
* The duration of the animations in milliseconds. Also accepts CSS strings such as 0.5s and 500ms.
* @expose
* @name animationDuration
* @memberof oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The type of animation to apply when the component is initially displayed
* @expose
* @name animationOnDisplay
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "auto"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* Specifies the maximum zoom level for this component. This can be any number greater than 1.0 which indicates the maximum point to which the map can be scaled. A value of 2.0 implies that the map can be zoomed in until it reaches twice the viewport size. A maxZoom of 1.0 indicates that the user cannot zoom the map beyond the viewport size.
* @expose
* @name maxZoom
* @memberof oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">6.0</code>
*/
/**
* The basemap shown by the thematic map. Can refer to a built-in or custom basemap
* @expose
* @name basemap
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* Specifies whether the map will zoom to fit the data objects on initial render.
* @expose
* @name initialZooming
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "auto"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* Determines whether component zooming is allowed.
* @expose
* @name zooming
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "auto"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* Determines whether component panning is allowed.
* @expose
* @name panning
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "auto"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* A function that returns a custom tooltip. The function takes a dataContext argument, provided by the thematic map, with the following properties: <ul> <li>parentElement: The tooltip element. The function can directly modify or append content to this element.</li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function may return an HTML element, which will be appended to the tooltip, or a tooltip string.
* @expose
* @name tooltip
* @memberof oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* Specifies the tooltip behavior of the thematic map.
* @expose
* @name tooltipDisplay
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "none"
* @ojvalue {string} "shortDesc"
* @ojvalue {string} "labelAndShortDesc"
* @ojvalue {string} "auto"
* @default <code class="prettyprint">"auto"</code>
*/
/**
* Specifies marker behavior on zoom.
* @expose
* @name markerZoomBehavior
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "zoom"
* @ojvalue {string} "fixed"
* @default <code class="prettyprint">"fixed"</code>
*/
/**
* Map with data layer ids for keys and arrays of selected data item ids as values.
* @expose
* @name selection
* @memberof oj.ojThematicMap
* @instance
* @type {object}
* @default <code class="prettyprint">null</code>
*/
/**
* An array of category strings used for category filtering. Data items with a category in hiddenCategories will be filtered.
* @expose
* @name hiddenCategories
* @memberof oj.ojThematicMap
* @instance
* @type {Array.<string>}
* @default <code class="prettyprint">null</code>
*/
/**
* An array of category strings used for category highlighting. Data items with a category in highlightedCategories will be highlighted.
* @expose
* @name highlightedCategories
* @memberof oj.ojThematicMap
* @instance
* @type {Array.<string>}
* @default <code class="prettyprint">null</code>
*/
/**
* The matching condition for the highlightedCategories option. By default, highlightMatch is 'all' and only items whose categories match all of the values specified in the highlightedCategories array will be highlighted. If highlightMatch is 'any', then items that match at least one of the highlightedCategories values will be highlighted.
* @expose
* @name highlightMatch
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "any"
* @ojvalue {string} "all"
* @default <code class="prettyprint">"all"</code>
*/
/**
* Defines the behavior applied when hovering over data items.
* @expose
* @name hoverBehavior
* @memberof oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "dim"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* An object defining the style defaults for this thematic map.
* @expose
* @name styleDefaults
* @memberof oj.ojThematicMap
* @instance
* @type {object}
* @default <code class="prettyprint">null</code>
*/
/**
* The CSS style for the area layer areas. Supported CSS attributes: background-color and border-color.
* @expose
* @name styleDefaults.areaStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The CSS style for the area layer labels.
* @expose
* @name styleDefaults.labelStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* Specifies initial hover delay in ms for highlighting data items. Also accepts CSS strings such as 1s and 1000ms.
* @expose
* @name styleDefaults.hoverBehaviorDelay
* @memberof! oj.ojThematicMap
* @instance
* @type {number|string}
* @default <code class="prettyprint">null</code>
*/
/**
* An object defining the default styles for data areas. Properties specified on this object may be overridden by specifications on the data object.
* @expose
* @name styleDefaults.dataAreaDefaults
* @memberof! oj.ojThematicMap
* @instance
* @type {object}
* @default <code class="prettyprint">null</code>
*/
/**
* The area stroke color for the area data layer.
* @expose
* @name styleDefaults.dataAreaDefaults.borderColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The hover data area border color.
* @expose
* @name styleDefaults.dataAreaDefaults.hoverColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The outer selected data area border color.
* @expose
* @name styleDefaults.dataAreaDefaults.selectedInnerColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The outer selected data area border color.
* @expose
* @name styleDefaults.dataAreaDefaults.selectedOuterColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The inner drilled data area border color.
* @expose
* @name styleDefaults.dataAreaDefaults.drilledInnerColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The outer drilled data area border color.
* @expose
* @name styleDefaults.dataAreaDefaults.drilledOuterColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An object defining the default styles for data markers. Properties specified on this object may be overridden by specifications on the data object.
* @expose
* @name styleDefaults.dataMarkerDefaults
* @memberof! oj.ojThematicMap
* @instance
* @type {object}
* @default <code class="prettyprint">null</code>
*/
/**
* The border color.
* @expose
* @name styleDefaults.dataMarkerDefaults.borderColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The border width in pixels. Also accepts CSS strings such as 0.5px.
* @expose
* @name styleDefaults.dataMarkerDefaults.borderWidth
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The border style.
* @expose
* @name styleDefaults.dataMarkerDefaults.borderStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "none"
* @ojvalue {string} "solid"
* @default <code class="prettyprint">"solid"</code>
*/
/**
* The fill color of a marker.
* @expose
* @name styleDefaults.dataMarkerDefaults.color
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The default marker width in pixels.
* @expose
* @name styleDefaults.dataMarkerDefaults.width
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The default marker height in pixels.
* @expose
* @name styleDefaults.dataMarkerDefaults.height
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The default marker opacity.
* @expose
* @name styleDefaults.dataMarkerDefaults.opacity
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">1.0</code>
*/
/**
* The default marker shape.
* @expose
* @name styleDefaults.dataMarkerDefaults.shape
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "square"
* @ojvalue {string} "plus"
* @ojvalue {string} "diamond"
* @ojvalue {string} "triangleUp"
* @ojvalue {string} "triangleDown"
* @ojvalue {string} "human"
* @ojvalue {string} "rectangle"
* @ojvalue {string} "star"
* @ojvalue {string} "circle"
* @default <code class="prettyprint">"circle"</code>
*/
/**
* The CSS style for a marker label.
* @expose
* @name styleDefaults.dataMarkerDefaults.labelStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An array of objects with the following properties that define an area layer.
* @expose
* @name areaLayers
* @memberof oj.ojThematicMap
* @instance
* @type {Array.<Object>}
* @default <code class="prettyprint">null</code>
*/
/**
* The name of the built-in or custom basemap layer.
* @expose
* @name areaLayers[].layer
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* Determines how labels for this layer should be displayed.
* @expose
* @name areaLayers[].labelDisplay
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "on"
* @ojvalue {string} "off"
* @ojvalue {string} "auto"
* @default <code class="prettyprint">"auto"</code>
*/
/**
* The CSS style for the area label.
* @expose
* @name areaLayers[].labelStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The CSS style for the area layer areas. Supported CSS attributes: background-color and border-color.
* @expose
* @name areaLayers[].areaStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* Determines which of the basemap labels to display
* @expose
* @name areaLayers[].labelType
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "long"
* @ojvalue {string} "short"
* @default <code class="prettyprint">"short"</code>
*/
/**
* An object with the following properties, used to define an area data layer.
* @expose
* @name areaLayers[].areaDataLayer
* @memberof! oj.ojThematicMap
* @instance
* @type {object}
* @default <code class="prettyprint">null</code>
*/
/**
* The type of animation to apply when the data for the layer is updated.
* @expose
* @name areaLayers[].areaDataLayer.animationOnDataChange
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "auto"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* The identifier for this data layer.
* @expose
* @name areaLayers[].areaDataLayer.id
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The type of selection behavior that is enabled on the thematic map.
* @expose
* @name areaLayers[].areaDataLayer.selectionMode
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "single"
* @ojvalue {string} "multiple"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* The id for the isolated area of this area data layer. If set, only the isoalted area will be displayed.
* @expose
* @name areaLayers[].areaDataLayer.isolatedItem
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* A callback function used to stamp custom SVG elements for a data layer. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name areaLayers[].areaDataLayer.renderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional callback function to update the node in response to changes in hover state. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name areaLayers[].areaDataLayer.hoverRenderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional callback function to update the data item in response to changes in selection state. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name areaLayers[].areaDataLayer.selectionRenderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional callback function to update the data item in response to changes in keyboard focus state. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name areaLayers[].areaDataLayer.focusRenderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* The knockout template name to use for stamping other data visualizations within a data layer. Only data visualizations are currently supported. The markers.location or markers.x and markers.y options will be used to determine the stamp placement within the Thematic Map. No other existing marker options will be used by the Thematic Map when a knockout template is provided.
* @expose
* @name areaLayers[].areaDataLayer.template
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An array of objects with the following properties that define a row of data for an area data layer.
* @expose
* @name areaLayers[].areaDataLayer.areas
* @memberof! oj.ojThematicMap
* @instance
* @type {Array.<Object>}
* @default <code class="prettyprint">null</code>
*/
/**
* The identifier for this data object.
* @expose
* @name areaLayers[].areaDataLayer.areas[].id
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The id of the state or country this area is associated with.
* @expose
* @name areaLayers[].areaDataLayer.areas[].location
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* Text used for the marker's label.
* @expose
* @name areaLayers[].areaDataLayer.areas[].label
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The CSS style defining the label style for this marker.
* @expose
* @name areaLayers[].areaDataLayer.areas[].labelStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The text that displays in the marker's tooltip.
* @expose
* @name areaLayers[].areaDataLayer.areas[].shortDesc
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The data object opacity.
* @expose
* @name areaLayers[].areaDataLayer.areas[].opacity
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">1.0</code>
*/
/**
* The data object color.
* @expose
* @name areaLayers[].areaDataLayer.areas[].color
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An array of objects with the following properties that define a row of data for a data layer.
* @expose
* @name areaLayers[].areaDataLayer.markers
* @memberof! oj.ojThematicMap
* @instance
* @type {Array.<Object>}
* @default <code class="prettyprint">null</code>
*/
/**
* The identifier for this data object.
* @expose
* @name areaLayers[].areaDataLayer.markers[].id
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The id of the area this marker is associated with.
* @expose
* @name areaLayers[].areaDataLayer.markers[].location
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* Text used for the marker's label.
* @expose
* @name areaLayers[].areaDataLayer.markers[].label
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The angle to rotate the marker in clockwise degrees around the center of the image.
* @expose
* @name areaLayers[].areaDataLayer.markers[].rotation
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The CSS style defining the label style for this marker.
* @expose
* @name areaLayers[].areaDataLayer.markers[].labelStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* Determines the position relative to the marker that the label should be displayed.
* @expose
* @name areaLayers[].areaDataLayer.markers[].labelPosition
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "top"
* @ojvalue {string} "bottom"
* @ojvalue {string} "center"
* @default <code class="prettyprint">"center"</code>
*/
/**
* The text that displays in the marker's tooltip.
* @expose
* @name areaLayers[].areaDataLayer.markers[].shortDesc
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The marker opacity.
* @expose
* @name areaLayers[].areaDataLayer.markers[].opacity
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">1.0</code>
*/
/**
* The marker color.
* @expose
* @name areaLayers[].areaDataLayer.markers[].color
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The width for this marker. If scaleX is specified, this value will be multiplied against the scale for the final marker width.
* @expose
* @name areaLayers[].areaDataLayer.markers[].width
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The height for this marker. If scaleY is specified, this value will be multiplied against the scale for the final marker height.
* @expose
* @name areaLayers[].areaDataLayer.markers[].height
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* Specifies the shape of a marker.
* @expose
* @name areaLayers[].areaDataLayer.markers[].shape
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "square"
* @ojvalue {string} "plus"
* @ojvalue {string} "diamond"
* @ojvalue {string} "triangleUp"
* @ojvalue {string} "triangleDown"
* @ojvalue {string} "human"
* @ojvalue {string} "rectangle"
* @ojvalue {string} "star"
* @ojvalue {string} "circle"
* @default <code class="prettyprint">"circle"</code>
*/
/**
* 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.
* @expose
* @name areaLayers[].areaDataLayer.markers[].source
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional URI specifying the location of the hover image resource. If not defined, the source image will be used.
* @expose
* @name areaLayers[].areaDataLayer.markers[].sourceHover
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional URI specifying the location of the selected image. If not defined, the source image will be used.
* @expose
* @name areaLayers[].areaDataLayer.markers[].sourceSelected
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* 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
* @name areaLayers[].areaDataLayer.markers[].sourceHoverSelected
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The border color.
* @expose
* @name areaLayers[].areaDataLayer.markers[].borderColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The border width in pixels.
* @expose
* @name areaLayers[].areaDataLayer.markers[].borderWidth
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The border style.
* @expose
* @name areaLayers[].areaDataLayer.markers[].borderStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "none"
* @ojvalue {string} "solid"
* @default <code class="prettyprint">"solid"</code>
*/
/**
* An array of objects with the following properties that define point data layers that will always be shown.
* @expose
* @name pointDataLayers
* @memberof oj.ojThematicMap
* @instance
* @type {Array.<Object>}
* @default <code class="prettyprint">null</code>
*/
/**
* The type of animation to apply when the data for the layer is updated.
* @expose
* @name pointDataLayers[].animationOnDataChange
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "auto"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* The identifier for this data layer.
* @expose
* @name pointDataLayers[].id
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The type of selection behavior that is enabled on for this data layer.
* @expose
* @name pointDataLayers[].selectionMode
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "single"
* @ojvalue {string} "multiple"
* @ojvalue {string} "none"
* @default <code class="prettyprint">"none"</code>
*/
/**
* A callback function used to stamp custom SVG elements for a data layer. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name pointDataLayers[].renderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional callback function to update the node in response to changes in hover state. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name pointDataLayers[].hoverRenderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional callback function to update the data item in response to changes in selection state. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name pointDataLayers[].selectionRenderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional callback function to update the data item in response to changes in keyboard focus state. The function takes a single argument, provided by the component, with the following properties: <ul> <li>component: A reference to the Thematic Map widget constructor so non public methods cannot be called.</li> <li>data: The data object for a stamped data visualization in the data layer.</li> <li>parentElement: An element that is part of a displayed subtree on the DOM. Modifications of the parentElement are not supported.</li> <li>rootElement: Null on initial rendering or the current data item SVG element.</li> <li>state: An object that reflects the current state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>previousState: An object that reflects the previous state of the data item with the following parameters: <ul> <li>hovered: hovered state, boolean.</li> <li>selected: selected state, boolean.</li> <li>focused: focused state, boolean.</li> </ul> </li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>location: The location id of the hovered item which can be null if x/y are set instead.</li> <li>x: The x coordinate of the hovered item which can be null if location is set instead.</li> <li>y: The y coordinate of the hovered item which can be null if location is set instead.</li> </ul> The function should return one of the following: <ul> <li>SVGElement: The SVG DOM element to be used as the data item.</li> <li>Null: Indicates that the node content should be removed.</li> </ul>
* @expose
* @name pointDataLayers[].focusRenderer
* @memberof! oj.ojThematicMap
* @instance
* @type {function(object)}
* @default <code class="prettyprint">null</code>
*/
/**
* The knockout template name to use for stamping other data visualizations within a data layer. Only data visualizations are currently supported. The markers.location or markers.x and markers.y options will be used to determine the stamp placement within the Thematic Map. No other existing marker options will be used by the Thematic Map when a knockout template is provided.
* @expose
* @name pointDataLayers[].template
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An array of objects with the following properties that define a row of data for a this data layer.
* @expose
* @name pointDataLayers[].markers
* @memberof! oj.ojThematicMap
* @instance
* @type {Array.<Object>}
* @default <code class="prettyprint">null</code>
*/
/**
* The marker color.
* @expose
* @name pointDataLayers[].markers[].color
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The height for this marker. If scaleY is specified, this value will be multiplied against the scale for the final marker height.
* @expose
* @name pointDataLayers[].markers[].height
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The identifier for this data object.
* @expose
* @name pointDataLayers[].markers[].id
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} ""
* @ojvalue {string} ""
* @default <code class="prettyprint">""</code>
*/
/**
* Text used for the marker's label
* @expose
* @name pointDataLayers[].markers[].label
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} ""
* @ojvalue {string} ""
* @default <code class="prettyprint">""</code>
*/
/**
* Determines the position relative to the marker that the label should be displayed.
* @expose
* @name pointDataLayers[].markers[].labelPosition
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "top"
* @ojvalue {string} "bottom"
* @ojvalue {string} "center"
* @default <code class="prettyprint">"center"</code>
*/
/**
* The CSS style defining the label style for this marker.
* @expose
* @name pointDataLayers[].markers[].labelStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The id of the city this marker is associated with.
* @expose
* @name pointDataLayers[].markers[].location
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The marker opacity.
* @expose
* @name pointDataLayers[].markers[].opacity
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">1.0</code>
*/
/**
* The angle to rotate the marker in clockwise degrees around the center of the image
* @expose
* @name pointDataLayers[].markers[].rotation
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* Specifies the shape of a marker.
* @expose
* @name pointDataLayers[].markers[].shape
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "square"
* @ojvalue {string} "plus"
* @ojvalue {string} "diamond"
* @ojvalue {string} "triangleUp"
* @ojvalue {string} "triangleDown"
* @ojvalue {string} "human"
* @ojvalue {string} "rectangle"
* @ojvalue {string} "star"
* @ojvalue {string} "circle"
* @default <code class="prettyprint">"circle"</code>
*/
/**
* The text that displays in the marker's tooltip.
* @expose
* @name pointDataLayers[].markers[].shortDesc
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The URI specifying the location of the image source. The shape attribute is ignored if the source image is defined. Specifies an image to use for the marker instead of a built-in shape.
* @expose
* @name pointDataLayers[].markers[].source
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional URI specifying the location of the hover image resource. If not defined, the source image will be used.
* @expose
* @name pointDataLayers[].markers[].sourceHover
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* 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. sourceSelected
* @expose
* @name pointDataLayers[].markers[].sourceHoverSelected
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* An optional URI specifying the location of the selected image. If not defined, the source image will be used.
* @expose
* @name pointDataLayers[].markers[].sourceSelected
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The width for this marker. If scaleX is specified, this value will be multiplied against the scale for the final marker width.
* @expose
* @name pointDataLayers[].markers[].width
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The x coordinate for the center of the marker. If using a built-in map the base map projection will be applied and will be interpreted as the longitude.
* @expose
* @name pointDataLayers[].markers[].x
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The y coordinate for the center of the marker. If using a built-in map the base map projection will be applied and will be interpreted as the latitude.
* @expose
* @name pointDataLayers[].markers[].y
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The border color.
* @expose
* @name pointDataLayers[].markers[].borderColor
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @default <code class="prettyprint">null</code>
*/
/**
* The border width in pixels.
* @expose
* @name pointDataLayers[].markers[].borderWidth
* @memberof! oj.ojThematicMap
* @instance
* @type {number}
* @default <code class="prettyprint">null</code>
*/
/**
* The border style.
* @expose
* @name pointDataLayers[].markers[].borderStyle
* @memberof! oj.ojThematicMap
* @instance
* @type {string}
* @ojvalue {string} "none"
* @ojvalue {string} "solid"
* @default <code class="prettyprint">"solid"</code>
*/
Source: 3rdparty/dvt/doc/ojthematicmap_options.js
Oracle® JavaScript Extension Toolkit (JET)
1.1.2
E65298-01