Show:

ia.ReportData Class

Extends ia.EventDispatcher
Defined in: ia\data\ReportData.js:1
Module: ia

Contains information about a report.

Constructor

ia.ReportData

()

Defined in ia\data\ReportData.js:1

Methods

addEventListener

(
  • eventType
  • fnc
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:15

Add an event listener.

Parameters:

  • eventType String

    The type of event to listen for.

  • fnc Function

    The function to call when the event occurs.

  • obj Object

    An optional parent object.

dispatchEvent

(
  • event
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:50

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

getDataTree

(
  • showDates
  • reverseDates
)
Associative Array

Defined in ia\data\ReportData.js:176

Returns an associative array of the form:

["i1"]{id:"i1"; label:"Home"; type:"branch"; children:["i2"; "i3"; "i4"]}
["i2"]{id:"i2"; label:"ia.Indicator 1"; type:"branch"; parent:"i1"; children:["i5"; "i6"; "i7"]}
["i5"]{id:"i5~2004"; label:"2004"; type:"leaf"; parent:"i2"}

Used by data explorers. Dates are returned as part of the tree.

Parameters:

  • showDates Boolean

    Should the dates be displayed.

  • reverseDates Boolean

    Should the dates be reversed.

Returns:

Associative Array: An associative array as described.

getGeographies

() ia.Geography[]

Defined in ia\data\ReportData.js:63

Returns the geographies contained in the data.

Returns:

ia.Geography[]: An array of geographies.

getGeography

(
  • id
)
ia.Geography

Defined in ia\data\ReportData.js:98

Returns the geography that corresponds to the geography id.

Parameters:

  • id String

    The geography id.

Returns:

ia.Geography: The geography for the given id.

getGeographyTree

(
  • dataHash
  • parentId
)

Defined in ia\data\ReportData.js:211

Returns an associative array of the form:

["i1"]{id:"i1"; label:"Home"; type:"branch"; children:["i2"; "i3"; "i4"]}
["i2"]{id:"i2"; label:"ia.Indicator 1"; type:"branch"; parent:"i1"; children:["i5"; "i6"; "i7"]}
["i5"]{id:"i5~2004"; label:"2004"; type:"leaf"; parent:"i2"}

Used by data explorers. Dates are returned as part of the tree.

Parameters:

  • dataHash Associative Array

    An associative array as described.

  • parentId String

    The parent id.

getProperties

() Object

Defined in ia\data\ReportData.js:90

Gets the properties.

Returns:

Object: A hashtable of properties.

getProperty

(
  • propName
)
Object

Defined in ia\data\ReportData.js:71

Get a value for a custom property.

Parameters:

  • propName String

    The name of the property.

Returns:

Object: The value for that property, or null.

loadSource

(
  • url
  • callbackFunction
)

Defined in ia\data\ReportData.js:107

Loads and parses the source file then calls the given function.

Parameters:

  • url String

    The url to the data.

  • callbackFunction Function

    The call back function.

parseData

(
  • data
  • callbackFunction
)

Defined in ia\data\ReportData.js:130

Parses the geography data.

Parameters:

  • data JSON

    The json data describing the object.

  • callbackFunction Function

    The call back function.

refresh

(
  • callbackFunction
)

Defined in ia\data\ReportData.js:161

Refreshes the data.

Parameters:

  • callbackFunction Function

    The call back function.

removeListener

(
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:30

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

setProperty

(
  • propName
  • propValue
)

Defined in ia\data\ReportData.js:80

Set a value for a custom property. Use this to set any default properties to be inherited by all data types beneath.

Parameters:

  • propName String

    The name of the property.

  • propValue Object

    The value of the property.

Properties

data

JSON

Defined in ia\data\ReportData.js:21

The raw json data describing the object.

getValue

ia.Formatter

Defined in ia\data\ReportData.js:47

The formatter

path

String

Defined in ia\data\ReportData.js:38

The directory path to the data source.

Default: ""

precision

Number

Defined in ia\data\ReportData.js:55

The precision. Inherited from parent if undefined.

url

String

Defined in ia\data\ReportData.js:29

The url of the data source.

Default: ""