Difference between revisions of "Nats display graph"
From TMM Wiki
Jump to navigationJump to searchm |
|||
| Line 38: | Line 38: | ||
| 0 | | 0 | ||
| period="7" | | period="7" | ||
| + | |- | ||
| + | | stats | ||
| + | | The variable to get statistics from | ||
| + | | An array | ||
| + | | $stats[$range] | ||
| + | | stats=$stats['date'] or $stats['site'] | ||
|- | |- | ||
| bgcolor | | bgcolor | ||
| Line 97: | Line 103: | ||
| Any valid breakdown method | | Any valid breakdown method | ||
| date | | date | ||
| − | | breakdown=" | + | | breakdown="program" |
|- | |- | ||
| period | | period | ||
| Line 104: | Line 110: | ||
| 0 | | 0 | ||
| period="7" | | period="7" | ||
| + | |- | ||
| + | | fields | ||
| + | | The variables that the line graph is based on | ||
| + | | A variable in $stats[$range] | ||
| + | | none | ||
| + | | fields = joins,recurring,refunds,reversals | ||
| + | |- | ||
| + | | field_titles | ||
| + | | The line graph titles | ||
| + | | any string | ||
| + | | none | ||
| + | | field_titles = Joins,Rebills,Refunds,Reversals | ||
| + | |- | ||
| + | | fields2 | ||
| + | | The variables that the bar graph is based on. | ||
| + | | A variable in $stats[$range] | ||
| + | | none | ||
| + | | fields2 = join_submits,join_hits,impression | ||
| + | |- | ||
| + | | field_titles2 | ||
| + | | The bar graph titles | ||
| + | | any string | ||
| + | | none | ||
| + | | field_titles2 = Submits,Join Hits,Raw Hits | ||
| + | |- | ||
| + | | show_legend | ||
| + | | Show legend or not. | ||
| + | | 0 (hide) or 1 (show) | ||
| + | | 0 | ||
| + | | show_legend = 1 | ||
|- | |- | ||
| reference_date | | reference_date | ||
Revision as of 17:13, 16 March 2010
nats_display_graph
Displays a graph of affiliate statistics.
Alias: display_graph
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| width | Width of the graph in pixels | Any whole number greater than 0 | 400 | width="800" |
| height | Height of the graph in pixels | Any whole number greater than 0 | 250 | height="800" |
| period | The period to get statistics for | Any valid period number | 0 | period="7" |
| stats | The variable to get statistics from | An array | $stats[$range] | stats=$stats['date'] or $stats['site'] |
| bgcolor | The background color for the graph | Any background color specification | 0xe7e9eb | bgcolor="green" |
| plot_bgcolor | Background color for the plot | Any background color specification | Transparent | bgcolor="blue" |
| img_width | Width of the image in pixels | Any whole number greater than zero | Same as width parameter above | img_width="800" |
| img_height | Height of the image in pixels | Any whole number greater than zero | Same as height parameter above | img_height="800" |
| plot_width | Width of the plot in pixels | Any whole number greater than zero | Same as width parameter above | plot_widht="800" |
| plot_height | Height of the plot in pixels | Any whole number greater than zero | Same as height parameter above | plot_height="800" |
| legend_bgcolor | Background color of the legend | Any color specification | Transparent | legend_bgcolor="green" |
| plot_left_margin | Left margin of the plot in number of pixels relative to the border | Any whole number greater than or equal to zero | 0 | plot_left_margin="100" |
| plot_right_margin | Right margin of the plot in number of pixels relative to the border | Any whole number greater than or equal to zero | 0 | plot_right_margin |
| breakdown | How to breakdown the statistics in the chart | Any valid breakdown method | date | breakdown="program" |
| period | What period to display the chart for | Any valid period I.D. | 0 | period="7" |
| fields | The variables that the line graph is based on | A variable in $stats[$range] | none | fields = joins,recurring,refunds,reversals |
| field_titles | The line graph titles | any string | none | field_titles = Joins,Rebills,Refunds,Reversals |
| fields2 | The variables that the bar graph is based on. | A variable in $stats[$range] | none | fields2 = join_submits,join_hits,impression |
| field_titles2 | The bar graph titles | any string | none | field_titles2 = Submits,Join Hits,Raw Hits |
| show_legend | Show legend or not. | 0 (hide) or 1 (show) | 0 | show_legend = 1 |
| reference_date | ? | ? | None. | ? |
| name | Name of the graph | Any HTML encoded string | Random | name="my_chart" |
| loginid | I.D. of the user to get data for | Any valid user I.D. | Current user's I.D. number | loginid="123" |
Output
A graph.
Notes
None.
