jsx3.chart.LegendAPI
| Destroy | Fires after this legend is removed from the DOM. |
| Execute | Fires after the user double-clicks this legend. |
| Menu | Fires after the user right-clicks this legend and before the bound context menu displays. |
| Select | Fires after the user selects this legend. |
| Spyglass | Fires after the user hovers the mouse over this legend and before the spyglass displays. |
Fires after the user double-clicks this legend.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
objSERIES {
jsx3.chart.Series} - the Series that is the target of this event if the event occurs on a legend entry and this legend displays series (rather than categories).
intINDEX {
int} - the CDF index of the category that is the target of this event if the event occurs on a legend entry and this legend displays categories (rather than series).
strRECORDID {
String} - the CDF jsxid of the category that is the target of the event if the event occurs on a legend entry and this legend displays categories (rather than series).
Fires after the user selects this legend.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
objSERIES {
jsx3.chart.Series} - the Series that is the target of this event if the event occurs on a legend entry and this legend displays series (rather than categories).
intINDEX {
int} - the CDF index of the category that is the target of the event if the event occurs on a legend entry and this legend displays categories (rather than series).
strRECORDID {
String} - the CDF jsxid of the category that is the target of the event if the event occurs on a legend entry and this legend displays categories (rather than series).
Fires after the user hovers the mouse over this legend and before the spyglass displays. The event script must evaluate to the HTML content to display in the spyglass. Canceling this event prevents the spyglass from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
objSERIES {
jsx3.chart.Series} - the Series that is the target of the event if the event occurs on a legend entry and this legend displays series (rather than categories).
intINDEX {
int} - the CDF index of the category that is the target of the event if the event occurs on a legend entry and this legend displays categories (rather than series).
strRECORDID {
String} - the CDF jsxid of the category that is the target of the event if the event occurs on a legend entry and this legend displays categories (rather than series).
Fires after the user right-clicks this legend and before the bound context menu displays. Canceling this event prevents the menu from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
objSERIES {
jsx3.chart.Series} - the Series that is the target of the event if the event occurs on a legend entry and this legend displays series (rather than categories)
intINDEX {
int} - the CDF index of the category that is the target of the event if the event occurs on a legend entry and this legend displays categories (rather than series)
strRECORDID {
String} - the CDF jsxid of the category that is the target of the event if the event occurs on a legend entry and this legend displays categories (rather than series)
Return Fields
objMENU {
jsx3.gui.Menu} - use this field to override the default menu with an instance of
jsx3.gui.Menu
Fires after this legend is removed from the DOM.
Context Variables
objPARENT {
jsx3.app.Model} - the parent of this legend before it is removed from the DOM.
Copyright © 2001-2007, TIBCO Software Inc.