From ee076221b85409cbd0f1c57e22eaaf680a797b5e Mon Sep 17 00:00:00 2001 From: Tripp Date: Wed, 27 Jul 2011 11:20:11 -0700 Subject: [PATCH] Fixed issue with series update example in which the escape module was not included. Enhanced tooltip docs on index page. --- src/charts/docs/index.mustache | 41 ++++++++++++++++++- .../charts-seriesupdate-source.mustache | 2 +- 2 files changed, 40 insertions(+), 3 deletions(-) diff --git a/src/charts/docs/index.mustache b/src/charts/docs/index.mustache index bb96f7f526d..e964268e7ba 100755 --- a/src/charts/docs/index.mustache +++ b/src/charts/docs/index.mustache @@ -262,10 +262,47 @@ var myDataValues = [ PropertyTypeDescription `hideEvent``String`/`Array`Event that hides the tooltip. This allows you to specify which mouse event(s) hides the tooltip. You can also pass this an array of events and each event in the array will hide the tooltip. The default value is `mouseout`. `markerEventHandler``Function`Displays and hides a tooltip based on marker events. - `markerLabelFunction``Function`Reference to the function used to format a marker event triggered tooltip's text. + `markerLabelFunction``Function`Reference to the function used to format a marker event triggered tooltip's text. The markerLabelFunction has the following arguments: +
+
categoryItem
An object containing the following: +
+
axis
The axis that the category is bound to
+
displayName
The display name set to the category (defaults to key if not provided)
+
key
The key of the category
+
value
The value of the category
+
+
+
valueItem
An object containing the following: +
+
axis
The axis that the item's series is bound to
+
displayName
The display name of the series (defaults to key if not provided)
+
key
The key for the series
+
value
The value for the series item
+
+
+
itemIndex
The index of the item within its series.
+
series
The series that the item belongs to
+
seriesIndex
The index of the series in the seriesCollection
+
+ `node``HTMLElement`Reference (read-only) to the actual dom node of the tooltip. `planarEventHandler``Function`Displays and hides a tooltip based on planar events. - `planarLabelFunction``Function`Reference to the function used to format a planar event triggered tooltip's text + `planarLabelFunction``Function`Reference to the function used to format a planar event triggered tooltip's text. The `planarLabelFunction` has the following arguments: +
+
categoryAxis
Reference to the categoryAxis of the chart.
+
valueItems
Array of objects for each series that has a data point in the coordinate plane of the event. Each object contains the following data: +
+
axis
The value axis of the series.
+
key
The key for the series.
+
value
The value for the series item.
+
displayName
The display name of the series. (defaults to key if not provided)
+
+
+
index
The index of the item within its series.
+
seriesArray
Array of series instances for each value item.
+
seriesIndex
The index of the series in the `seriesCollection`.
+
+ `show``Boolean`Indicates whether to show a tooltip. `showEvent``String`Event that triggers the tooltip. This allows you to specify which mouse event will cause the tooltip to display. The default value is `mouseover` `styles``Object`Hash of CSS styles that are applied to the tooltip's node. diff --git a/src/charts/docs/partials/charts-seriesupdate-source.mustache b/src/charts/docs/partials/charts-seriesupdate-source.mustache index 55f38ff5cf8..73b57b3b642 100755 --- a/src/charts/docs/partials/charts-seriesupdate-source.mustache +++ b/src/charts/docs/partials/charts-seriesupdate-source.mustache @@ -29,7 +29,7 @@