dojox/widget/DataPresentation.js

• Provides:

  • dojox.widget.DataPresentation

• Requires:

  • dojox.grid.DataGrid in common
  • dojox.charting.Chart2D in common
  • dojox.charting.widget.Legend in common
  • dojox.charting.action2d.Tooltip in common
  • dojox.charting.action2d.Highlight in common
  • dojo.colors in common
  • dojo.data.ItemFileWriteStore in common

• dojox.widget.DataPresentation

  • type

    Function

  • parameters:
    • node: (typeof DomNode)

      The node to attach the data presentation to.
      kwArgs:	Object (see above)

    • args
  • summary

    DataPresentation
    
    A widget that connects to a data store in a simple manner,
    and also provides some additional convenience mechanisms
    for connecting to common data sources without needing to
    explicitly construct a Dojo data store. The widget can then
    present the data in several forms: as a graphical chart,
    as a tabular grid, or as display panels presenting meta-data
    (title, creation information, etc) from the data. The
    widget can also create and manage several of these forms
    in one simple construction.
    
    Note: this is a first experimental draft and any/all details
    are subject to substantial change in later drafts.

  • example

    var pres = new dojox.data.DataPresentation("myChartNode", {

• dojox.widget.DataPresentation.type

  • type

    String

  • summary

    the type of presentation to be applied at the DOM attach point.
    This can be 'chart', 'legend', 'grid', 'title', 'footer'. The
    default type is 'chart'.

• dojox.widget.DataPresentation.chartType

  • type

    String

  • summary

    the type of chart to display. This can be 'clusteredbars',
    'areas', 'stackedcolumns', 'stackedbars', 'stackedareas',
    'lines', 'hybrid'. The default type is 'bar'.

• dojox.widget.DataPresentation.reverse

  • type

    Boolean

  • summary

    true if the chart independant axis should be reversed.

• dojox.widget.DataPresentation.animate

  • type

    Object

  • summary

    if an object is supplied, then the chart bars or columns will animate
    into place. If the object contains a field 'duration' then the value
    supplied is the duration of the animation in milliseconds, otherwise
    a default duration is used. A boolean value true can alternatively be
    supplied to enable animation with the default duration.
    The default is null (no animation).

• dojox.widget.DataPresentation.labelMod

  • type

    Integer

  • summary

    the frequency of label annotations to be included on the
    independent axis. 1=every label. 0=no labels. The default is 1.
    
    
    
    tooltip: String | Function
    a string pattern defining the tooltip text to be applied to chart
    data points, or a function which takes a single parameter and returns
    the tooltip text to be applied to chart data points. The string pattern
    will have the following substitutions applied:
    {0} - the type of chart element ('bar', 'surface', etc)
    {1} - the name of the data series
    {2} - the independent axis value at the tooltip data point
    {3} - the series value at the tooltip data point point
    The function, if supplied, will receive a single parameter exactly
    as per the dojox.charting.action2D.Tooltip class. The default value
    is to apply the default tooltip as defined by the
    dojox.charting.action2D.Tooltip class.

• dojox.widget.DataPresentation.legendHorizontal

  • type

    Boolean

  • summary

    | Number
    true if the legend should be rendered horizontally, or a number if
    the legend should be rendered as horizontal rows with that number of
    items in each row, or false if the legend should be rendered
    vertically (same as specifying 1). The default is true (legend
    rendered horizontally).
    
    
    
    theme: String|Theme
    a theme to use for the chart, or the name of a theme.
    
    chartNode: String|DomNode
    an optional DOM node or the id of a DOM node to receive a
    chart presentation of the data. Supply only when a chart is
    required and the type is not 'chart'; when the type is
    'chart' this property will be set to the widget attach point.
    
    legendNode: String|DomNode
    an optional DOM node or the id of a DOM node to receive a
    chart legend for the data. Supply only when a legend is
    required and the type is not 'legend'; when the type is
    'legend' this property will be set to the widget attach point.
    
    gridNode: String|DomNode
    an optional DOM node or the id of a DOM node to receive a
    grid presentation of the data. Supply only when a grid is
    required and the type is not 'grid'; when the type is
    'grid' this property will be set to the widget attach point.
    
    titleNode: String|DomNode
    an optional DOM node or the id of a DOM node to receive a
    title for the data. Supply only when a title is
    required and the type is not 'title'; when the type is
    'title' this property will be set to the widget attach point.
    
    footerNode: String|DomNode
    an optional DOM node or the id of a DOM node to receive a
    footer presentation of the data. Supply only when a footer is
    required and the type is not 'footer'; when the type is
    'footer' this property will be set to the widget attach point.
    
    chartWidget: Object
    the chart widget, if any
    
    legendWidget: Object
    the legend widget, if any
    
    gridWidget: Object
    the grid widget, if any

• dojox.widget.DataPresentation.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node: (typeof DomNode)

      The node to attach the data presentation to.
      kwArgs:	Object (see above)

    • args
  • summary

    Set up properties and initialize.
    
    arguments:

• dojox.widget.DataPresentation.setURL

  • parameters:
    • url: (typeof String)
    • urlContent: (typeof Object)
    • refreshInterval: (typeof Number)
  • summary

    Sets the URL to fetch data from, with optional content
    supplied with the request, and an optional
    refresh interval in milliseconds (0=no refresh)

  • type

    Function

• dojox.widget.DataPresentation.url

  • type

    Object

• dojox.widget.DataPresentation.urlContent

  • type

    Object

• dojox.widget.DataPresentation.refreshInterval

  • type

    Object

• dojox.widget.DataPresentation.refreshIntervalPending

  • type

    Object

• dojox.widget.DataPresentation.setData

  • parameters:
    • data: (typeof Object)
    • refreshInterval: (typeof Number)
  • summary

    Sets the data to be presented, and an optional
    refresh interval in milliseconds (0=no refresh)

  • type

    Function

• dojox.widget.DataPresentation.data

  • type

    Object

• dojox.widget.DataPresentation.refresh

  • summary

    If a URL or data has been supplied, refreshes the
    presented data from the URL or data. If a refresh
    interval is also set, the periodic refresh is
    restarted. If a URL or data was not supplied, this
    method has no effect.

  • type

    Function

• dojox.widget.DataPresentation.cancelRefresh

  • summary

    Cancels any and all outstanding data refreshes

  • type

    Function

• dojox.widget.DataPresentation.setStore

  • parameters:
    • store: (typeof Object)
    • query: (typeof String)
    • queryOptions: (typeof Object)
  • type

    Function

• dojox.widget.DataPresentation.setPreparedStore

  • parameters:
    • store: (typeof Object)
    • query: (typeof String)
    • queryOptions: (typeof Object)
  • summary

    Sets the store and query.

  • type

    Function

• dojox.widget.DataPresentation.preparedstore

  • type

    Object

• dojox.widget.DataPresentation.query

  • type

    Object

• dojox.widget.DataPresentation.queryOptions

  • type

    Object

• dojox.widget.DataPresentation.chartWidget

  • type

    Object

• dojox.widget.DataPresentation.legendWidget

  • type

    Object

• dojox.widget.DataPresentation.gridWidget

  • type

    Object

• dojox.widget.DataPresentation.renderChartWidget

  • summary

    Renders the chart widget (if any). This method is
    called whenever a chart widget is created or
    configured, and may be connected to.

  • type

    Function

• dojox.widget.DataPresentation.renderGridWidget

  • summary

    Renders the grid widget (if any). This method is
    called whenever a grid widget is created or
    configured, and may be connected to.

  • type

    Function

• dojox.widget.DataPresentation.getChartWidget

  • summary

    Returns the chart widget (if any) created if the type
    is "chart" or the "chartNode" property was supplied.

  • type

    Function

• dojox.widget.DataPresentation.getGridWidget

  • summary

    Returns the grid widget (if any) created if the type
    is "grid" or the "gridNode" property was supplied.

  • type

    Function

• dojox.widget.DataPresentation.destroy

  • summary

    Destroys the widget and all components and resources.

  • type

    Function

• dojox.widget.DataPresentation.chartNode.innerHTML

  • type

    String

• dojox.widget.DataPresentation.legendNode.innerHTML

  • type

    String

• dojox.widget.DataPresentation.gridNode.innerHTML

  • type

    String

• dojox.widget.DataPresentation.titleNode.innerHTML

  • type

    String

• dojox.widget.DataPresentation.footerNode.innerHTML

  • type

    String

• dojox.widget.DataPresentation.domNode

  • type

    Object

• dojox.widget.DataPresentation.theme

  • type

    Object

• dojox.widget.DataPresentation.chartNode

  • type

    Object

• dojox.widget.DataPresentation.legendNode

  • type

    Object

• dojox.widget.DataPresentation.gridNode

  • type

    Object

• dojox.widget.DataPresentation.titleNode

  • type

    Object

• dojox.widget.DataPresentation.footerNode

  • type

    Object

• dojox.widget

  • type

    Object

• dojox

  • type

    Object