You are here

README.txt in Webform Chart 7.2

Same filename and directory in other branches
  1. 7 README.txt
AUTHORS
--------------------------------------------------------------------------------
 
 * Dominique CLAUSE ("Miroslav", https://drupal.org/user/801982)
 
Required Modules
--------------------------------------------------------------------------------

Webform (Version used: 7.x-4.0-alpha10) - http://drupal.org/project/webform

Recommended Modules (this will not create charts without at least one of these)
--------------------------------------------------------------------------------

Chart API - http://drupal.org/project/chart
Charts - http://drupal.org/project/charts

Configuration
--------------------------------------------------------------------------------

 node/%/webform/configure
   Here, you can select a back end for rendering charts. You can also select the 
   configuration mode: either global settings or per component settings.
    - global settings: 
      > select a backend-end charting API to render all chart in this webform
      > choose a unique chart type for all components within the webform
      > apply backend's settings to all components within the webform.
    - per component settings:
      > select a backend-end charting API to render all chart in this webform
      > choose a different chart type for each component within the webform
        in the component setting page.
      > apply backend's settings individually to each components.

Usage
--------------------------------------------------------------------------------

 node/%/webform-results/chart
   At this URL (substituting % for the node # of the webform), you may access
   the results of your webform, presented with charts


Notes
--------------------------------------------------------------------------------

 Note that many of the chart types available will make no sense and may not even
 work because of the types of data passed in. Eventually we will filter out
 chart types that do not work.

 Bar charts, column charts, and pie charts should all operate correctly for
 both of the rendering libraries.

 Not all components are currently supported but a hard work is put on improving 
 this.
 Grid-type components are rendered as individual questions instead of as a 
 group.
 Support was added for the webform table element module
 (http://drupal.org/project/webform_table_element) that again will take each
 constituent question and render it as stand-alone.

API
--------------------------------------------------------------------------------

 This was designed to be extensible so other charting libraries can be used
 besides the two mentioned. To implement another charting library, assuming your
 module is named 'my_module', you will need to add a hook to include the name of
 the library in the configuration section, named
 "my_module_webform_chart_backends". See webform_chart_webform_chart_backends()
 in webform_chart.admin.inc for this module's implementation.

 To render using your own charting library, you will need to write and register
 a theming implementation, again assuming your back end is called 'my_module',
 named "theme_webform_chart_render_my_module".

 To provide configuration specific to your module, you will need to provide the
 form elements for configuring your module in a function named
 "_webform_chart_backend_config_my_module", and make sure the file containing
 the function is included as is done in webform_chart_webform_chart_backends().
 See _webform_chart_backend_config_googleapilibs and
 _webform_chart_backend_config_chart in includes/googleapilibs.inc and
 includes/chart.inc.

 You can also provide configuration help specific to your chart library using
 "my_module_webform_chart_help"

File

README.txt
View source
  1. AUTHORS
  2. --------------------------------------------------------------------------------
  3. * Dominique CLAUSE ("Miroslav", https://drupal.org/user/801982)
  4. Required Modules
  5. --------------------------------------------------------------------------------
  6. Webform (Version used: 7.x-4.0-alpha10) - http://drupal.org/project/webform
  7. Recommended Modules (this will not create charts without at least one of these)
  8. --------------------------------------------------------------------------------
  9. Chart API - http://drupal.org/project/chart
  10. Charts - http://drupal.org/project/charts
  11. Configuration
  12. --------------------------------------------------------------------------------
  13. node/%/webform/configure
  14. Here, you can select a back end for rendering charts. You can also select the
  15. configuration mode: either global settings or per component settings.
  16. - global settings:
  17. > select a backend-end charting API to render all chart in this webform
  18. > choose a unique chart type for all components within the webform
  19. > apply backend's settings to all components within the webform.
  20. - per component settings:
  21. > select a backend-end charting API to render all chart in this webform
  22. > choose a different chart type for each component within the webform
  23. in the component setting page.
  24. > apply backend's settings individually to each components.
  25. Usage
  26. --------------------------------------------------------------------------------
  27. node/%/webform-results/chart
  28. At this URL (substituting % for the node # of the webform), you may access
  29. the results of your webform, presented with charts
  30. Notes
  31. --------------------------------------------------------------------------------
  32. Note that many of the chart types available will make no sense and may not even
  33. work because of the types of data passed in. Eventually we will filter out
  34. chart types that do not work.
  35. Bar charts, column charts, and pie charts should all operate correctly for
  36. both of the rendering libraries.
  37. Not all components are currently supported but a hard work is put on improving
  38. this.
  39. Grid-type components are rendered as individual questions instead of as a
  40. group.
  41. Support was added for the webform table element module
  42. (http://drupal.org/project/webform_table_element) that again will take each
  43. constituent question and render it as stand-alone.
  44. API
  45. --------------------------------------------------------------------------------
  46. This was designed to be extensible so other charting libraries can be used
  47. besides the two mentioned. To implement another charting library, assuming your
  48. module is named 'my_module', you will need to add a hook to include the name of
  49. the library in the configuration section, named
  50. "my_module_webform_chart_backends". See webform_chart_webform_chart_backends()
  51. in webform_chart.admin.inc for this module's implementation.
  52. To render using your own charting library, you will need to write and register
  53. a theming implementation, again assuming your back end is called 'my_module',
  54. named "theme_webform_chart_render_my_module".
  55. To provide configuration specific to your module, you will need to provide the
  56. form elements for configuring your module in a function named
  57. "_webform_chart_backend_config_my_module", and make sure the file containing
  58. the function is included as is done in webform_chart_webform_chart_backends().
  59. See _webform_chart_backend_config_googleapilibs and
  60. _webform_chart_backend_config_chart in includes/googleapilibs.inc and
  61. includes/chart.inc.
  62. You can also provide configuration help specific to your chart library using
  63. "my_module_webform_chart_help"