You are viewing documentation for an older version. For current documentation - click here.
FusionCharts JavaScript API - Events

FusionMaps XT uses FusionCharts JavaScript Class that takes care of all the products of FusionCharts Suite XT including FusionMaps XT.

FusionCharts JavaScript Class API provides a number of events. Events are categorized into two broad groups - Simple Events and Advanced events.

Each event provides arguments to the event-listeners. In simple event, most of the events (except for the FC_Exported and FC_Resized events) provide DOMId of the source map that raised the event.  In advanced model, two event parameters are passed to the event listener function. The first parameter, eventObject, is structurally common for all events. The second parameter, argumentsObject contains event specific properties. Details of eventObject are given as follows:

Event parameters in advanced model

Each event sends parameters to event listener functions. In advanced event model, two event argument Objects are sent to event listener. The properties contained by the arguments are as follows:

  • The first argument is eventObject which provides details of the event. It is an object which provides three properties :
    • eventId: An unique id given to the event
    • eventType: A string containing the name or the event type, for example, "rendered", etc.
    • sender: A FusionCharts JavaScript Object reference to the map which has raised that event
  • The second argument argumentsObject is an object which contains details of the particular event fired. As per the type of the event the properties of parameter objects varies.

The list shown below contains names of events of both Simple and Advanced events. Moreover, details of argumentsObject for each event are listed in the table below.

Name (Advanced model) Name ( Simple model) What is it and when is it raised? Event parameters
Events raised by FusionCharts.printManager
PrintReadyStateChange not available This event is raised to notify the status of the Print Manager.

It is raised twice. First, when the Print Manager starts processing all maps. It is raised again when all the maps are ready for managed print.		 The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • ready: (Boolean) Whether Print Manager has made the all the maps present in a page ready for managed print
  • bypass:(Boolean) Whether Print Manager has been bypassed due to error, incompatibility, etc
Events raised by FusionCharts Global static class
Initialized not available This event is raised when an instance of FusionCharts JavaScript class is initialized. This happens prior to data loading and chart creation events. The event arguments provided in the advanced model are :

eventObject : This object contains eventId, eventType and sender properties.

argumentsObject : This is passed as a blank object.
Disposed not available This event is raised after a chart is removed and cleaned from memory. Technically, it is raised just after a chart is disposed or deleted using dispose() by user or by JavaScript internally. The event arguments provided in the advanced model are :

eventObject : This object contains eventId, eventType and sender properties.

argumentsObject : This is passed as a blank object.
Error FC_Error This event is raised when error occurs in JavaScript implementation. The event arguments provided by FC_Error function (simple event model) is same event arguments passed to event listener in advanced model as described below:

The event arguments provided in the advanced model are :

eventObject : This object contains eventId, eventType and sender properties.

argumentsObject : This object contains properties listed below:

  • id :  Unique ID of the error
  • nature : Nature of the error. The value can be one of these - 'TypeException', 'ValueRangeException', 'NotImplementedException', 'ParameterException', 'RuntimeException', DesignTimeError'
  • source :  This gives a hint at the function, object etc. where the error is raised
  • message : Error message
Warning FC_Warning This event is raised when there are minor errors or warnings while implementing the chart. The event arguments provided by FC_Warning function (simple event model) is same event arguments passed to event listener in advanced model as described below:

The event arguments provided in the advanced model are :

eventObject : This object contains eventId, eventType and sender properties.

argumentsObject : This object contains properties listed below:

  • id :  Unique ID of the error
  • nature : Nature of the error. The value can be one of these - 'TypeException', 'ValueRangeException', 'NotImplementedException', 'ParameterException', 'RuntimeException', DesignTimeError'
  • source :  This gives a hint at the function, object etc. where the error is raised
  • message : Error message
 
 
Events raised by FusionCharts JavaScript instance
DataLoadRequested not available This event is raised when map data is requested from a URL. This is fired only when data source is a URL. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • dataFormat: Type of Data format. Its can be either xml or json
  • source: Nature of data load request. Presently it's value is "XmlHttpRequest"
  • url: URL of the data source
  • cancelDataloadRequest(): function which can be called to cancel a data load (if required)
DataLoadRequestCancelled not available This event is raised when data load process is cancelled by calling cancelDataloadRequest() function in DataLoadRequested event-listener.

In cases where data source is a local path, this event is automatically raised. 		The event arguments provided in the advanced model are :

eventObject : This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • dataFormat: Type of Data format. It can be either xml or json
  • source : Nature of data load request. Presently its value is "XmlHttprequest"
  • url: URL of the data source
  • xmlHttpRequestObject: The object which has fetched data
DataLoadRequestCompleted not available This event is raised before map data is loaded. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • data: Map data as XML or JSON string
  • dataFormat: Type of Data format. Its can be either xml or json
  • source: Nature of data load request. Presently its value is "XmlHttprequest"
  • url: URL of the data source
  • xmlHttpRequestObject: The object which has fetched data
  • cancelDataLoad(): function which can be called to cancel a data load (if required)
DataLoadCancelled not available This event is raised when map data loading is cancelled. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:
  • dataFormat: Type of Data format. It can be either xml or json
  • source: Nature of data load request. Presently its value is "XmlHttprequest"
  • url: URL of the data source
  • xmlHttpRequestObject: The object which has fetched data
BeforeDataUpdate not available This event is raised before data is loaded into FusionCharts JavaScript Class and is ready to be passed to the map. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:
  • dataFormat: Type of Data format. It can be either xml or json
  • dataSource: URL of the data source
  • chartData: The original data sent by user
  • dataError: Error object if any error occurred
  • cancelDataUpdate(): The function which can be called to cancel a data update (if required)
DataUpdated not available This event is raised when data is loaded into FusionCharts JavaScript Class and is ready to be passed to the map. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:
  • dataFormat: Type of Data format. It can be either xml or json
  • dataSource: URL of the data source
  • underlyingDataSource: The original data sent by user
Loaded FC_Loaded This event is raised when the map has finished downloading itself in the user's browser. You can use this to hide any loader components that you might have on your page. The event argument provided by FC_Loaded function (simple event model) is DOMId of the map raising the event.

The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType, and sender properties.

argumentsObject: This is passed as a blank object.
DataLoaded FC_DataLoaded This event is raised when the map has finished loading data. It can be used to further process data in any other components in your page. The event argument provided by the FC_DataLoaded function (simple event model) is DOMId of the map raising the event.

The event arguments provided in the advanced model are:

eventObject : This object contains eventId, eventType and sender properties.

argumentsObject : This is passed as a blank object.
Rendered FC_Rendered This event is raised when the map has finished rendering. This call is made only once per loaded map SWF (even if new data is supplied to it).  It can be used to invoke any further JavaScript methods on map, or to change the data of map. The event argument provided by the FC_Rendered function (simple event model) is DOMId of the map raising the event.

The event arguments provided in the advanced model are :

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This is passed as a blank object.
DrawComplete not available This event is raised every time FusionCharts completes drawing a map. This is also raised on each resize or map reload. Even when you interact with the map, say you slice a Pie, this event will be fired. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:
  • drawCount: Number specifying the number of times the map is redrawn
  • height: Current height of the map
  • width: Current width of the map
Resized FC_Resized This event is raised when map resizes. The event arguments provided by FC_Resized function (simple event model) are as follows:

  • DOMId: Id of the map raising this event
  • width: Width of the map after resize
  • height: Height of the map after resize
  • prevWidth: Original width of the map before resize
  • prevHeight: Original height of the map before resize


The event arguments provided in the advanced model are :

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject : This object contains properties listed below:

  • width: Width of the map after resize
  • height: Height of the map after resize
  • prevWidth: Original width of the map before resize
  • prevHeight: Original height of the map before resize
Exported FC_Exported This event is raised when the map has finished export as server-side save or client-side download. This is used to know whether the export is successful. It also provides the path (web path for server side save and local path for client side download) where the exported file has been saved.

This event is not raised when Download action is performed.

The event argument provided by FC_Exported function (simple event model) is an Object containing the following properties:

  • DOMId: Id of the map that has been exported
  • statusCode: Indicated the success status of the export process. In case of failure the value is passed as 0. On success, 1 is provided
  • statusMessage: Success or failure message
  • fileName: The name and path of the file where the exported file has been saved
  • width: The width of the map
  • height: The height of the map
  • notice: A consolidated string which contains export related notices and warnings. This is applicable only for server side export

The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • DOMId: Id of the map that has been exported
  • statusCode: Indicated the success status of the export process. In case of failure the value is passed as 0. On success, 1 is provided
  • statusMessage: Success or failure message
  • fileName: The name and path of the file where the exported file has been saved
  • width: The width of the map
  • height: The height of the map
  • notice: A consolidated string which contains export related notices and warnings. This is applicable only for server side export
BatchExported FC_BatchExported This event is raised after Batch Export is performed using Client Side Export handler. The event argument provided by FC_BatchExported function (simple event model) is an Object containing the following properties:

  • DOMId: Id of the map that has been exported
  • statusCode: Indicated the success status of the export process. In case of failure the value is passed as 0. On success, 1 is provided
  • statusMessage: Success or failure message
  • fileName: The name and path of the file where the exported file has been saved
  • width: The width of the map
  • height: The height of the map

The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • DOMId: Id of the map that has been exported
  • statusCode: Indicated the success status of the export process. In case of failure the value is passed as 0. On success, 1 is provided
  • statusMessage: Success or failure message
  • fileName: The name and path of the file where the exported file has been saved
  • width: The width of the map
  • height: The height of the map
BeforeDispose not available This event is raised before a map is going to be removed and cleaned from memory. Technically, It is raised just before a map is to be disposed or deleted using dispose() by user or by JavaScript internally. This event is, in most cases, followed by a Disposed event.

 The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This is passed as a blank object.
BeforeLinkedItemOpen not available This event is raised before a LinkedChart is opened. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • level: Level (as number) of the LinkedChart
LinkedItemOpened not available This event is raised after a LinkedChart is opened. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • level: Level (as number) of the LinkedChart
  • item: The JavaScript object instance of the LinkedChart that is opened
BeforeLinkedItemClose not available This event is raised before a LinkedChart is closed. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • level: Level (as number) of the LinkedChart
  • item: The JavaScript object instance of the LinkedChart that is opened
LinkedItemClosed not available This event is raised after a LinkedChart is closed. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • level: Level (as number) of the LinkedChart
FC_Event not available This is a generic event listener. Currently, it is raised during roll over and roll out on entities.

To enable this event in Flash maps, set exposeHoverEvent attribute to 1 in <map> element of the XML (or in map Object of the JSON)

The event argument provided by FC_Event function (simple event model) are:

  • DOMId: Id of the map.
  • eventType: Type of event as string. Currently, it can be either "rollOver" or "rollOut".
  • argumentsObject: Object containing the following properties of the entity:
    • id: Entity Id
    • sName: Short name of entity
    • lName: Long name of entity
    • value: value of the entity
EntityRollover not available This event is raised when mouse hovers over entities. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • id: ID of the entity. In general it is the internal ID specified in the Maps Specification Sheet of the respective map. However, if custom ID is defined, it provide the custom ID.
  • originalId: When custom ID is defined for an entity, it provide the original internal ID of the map, as per Map Specification Sheet of the respective map.
  • value:  Value of entity.
  • label: Long name of entity.
  • shortLabel: Short name of entity.
EntityRollout not available This event is raised when mouse rolls out of entities. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • id: ID of the entity. In general it is the internal ID specified in the Maps Specification Sheet of the respective map. However, if custom ID is defined, it provide the custom ID.
  • originalId: When custom ID is defined for an entity, it provide the original internal ID of the map, as per Map Specification Sheet of the respective map.
  • value:  Value of entity.
  • label: Long name of entity.
  • shortLabel: Short name of entity.
LegendItemClicked not available This event is raised when any of the legend items are clicked. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • minRange: Minimum value of the color range represented by the legend item.
  • maxRange: Maximum value of the color range represented by the legend item.
MarkerClicked not available This event is raised when a marker is clicked. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:
  • id: ID of the marker
  • label: Marker label
  • x and y: The original x and y positions of the marker. This x and y positions are the values set through the marker definition in XML/JSON data.
  • scaledX and scaledY: Scaled x and y positions of the marker. These scaled values proportionate to the scaled dimension of the map.

    Each map is created using a specific width and height. These dimensions are specified as original dimensions in the Map Specification Sheet of the respective map. Marker's x and y positions are defined in the XML/JSON with respect to the original dimensions of the map. However, a map's dimensions are scaled based on the map size set while rendering the map. Accordingly, the x and y positions of the markers also get scaled.

  • chartX and chartY: The x and y positions of the marker with respect to the top-left corner of the map canvas (that is, 0,0 position).
MarkerRollover not available This event is raised when mouse hovers over a marker. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:
  • id: ID of the marker
  • label: Marker label
  • x and y: The original x and y positions of the marker. This x and y positions are the values set through the marker definition in XML/JSON data.
  • scaledX and scaledY: Scaled x and y positions of the marker. These scaled values proportionate to the scaled dimension of the map.

    Each map is created using a specific width and height. These dimensions are specified as original dimensions in the Map Specification Sheet of the respective map. Marker's x and y positions are defined in the XML/JSON with respect to the original dimensions of the map. However, a map's dimensions are scaled based on the map size set while rendering the map. Accordingly, the x and y positions of the markers also get scaled.

  • chartX and chartY: The x and y positions of the marker with respect to the top-left corner of the map canvas (that is, 0,0 position).
MarkerRollout not available This event is raised when mouse leaves a marker. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:
  • id: ID of the marker
  • label: Marker label
  • x and y: The original x and y positions of the marker. This x and y positions are the values set through the marker definition in XML/JSON data.
  • scaledX and scaledY: Scaled x and y positions of the marker. These scaled values proportionate to the scaled dimension of the map.

    Each map is created using a specific width and height. These dimensions are specified as original dimensions in the Map Specification Sheet of the respective map. Marker's x and y positions are defined in the XML/JSON with respect to the original dimensions of the map. However, a map's dimensions are scaled based on the map size set while rendering the map. Accordingly, the x and y positions of the markers also get scaled.

  • chartX and chartY: The x and y positions of the marker with respect to the top-left corner of the map canvas (that is, 0,0 position).
ConnectorClicked not available This event is raised when marker connectors are clicked. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • fromMarkerId: ID of the marker from where the connector line starts.
  • toMarkerId: ID of the marker where the connector line ends.
ConnectorRollover not available This event is raised when mouse hovers over marker connectors. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • fromMarkerId: ID of the marker from where the connector line starts.
  • toMarkerId: ID of the marker where the connector line ends.
ConnectorRollout not available This event is raised when mouse leaves marker connectors. The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • fromMarkerId: ID of the marker from where the connector line starts.
  • toMarkerId: ID of the marker where the connector line ends.
DataLoadError FC_DataLoadError This event is raised when there was an error in loading data from the specified Url. It can be used to show an error message to user, or to take a corrective measure. The event argument provided by FC_DataLoadError function (simple event model) is DOMId of the map raising the event.

The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This object contains properties listed below:

  • error: JavaScript error object which describes the underlying error which has raised this event
  • httpStatus: A number which Denotes the HTTP status number when the error was raised.For example, the status will be 404 for URL not found."
  • source: Denotes who raised the error. It is generally undefined when SWF raises this event, but is otherwise equal to "XmlHttpRequest" in case the error was raised due to AJAX request
  • xmlHttprequestObject: The httpRequest object associated with this data transaction
DataXMLInvalid FC_DataXMLInvalid This event is raised when the XML data loaded by map is invalid. It can be used to show an error message to user, or to take a corrective measure. The event argument provided by FC_DataXMLInvalid function (simple event model) is DOMId of the map raising the event.

The event arguments provided in the advanced model are:

eventObject: This object contains eventId, eventType and sender properties.

argumentsObject: This is passed as a blank object.