Difference between revisions of "Nats display graph"
TMMStephenY (talk | contribs) m |
|||
| (10 intermediate revisions by one other user not shown) | |||
| Line 35: | Line 35: | ||
| period | | period | ||
| The period to get statistics for | | The period to get statistics for | ||
| − | | Any valid period number | + | | Any valid period number or string description |
| − | | 0 | + | | 0 or date |
| − | | period="7" | + | | period="7" or period='week' |
|- | |- | ||
| stats | | stats | ||
| Line 146: | Line 146: | ||
| Random | | Random | ||
| name="my_chart" | | name="my_chart" | ||
| + | |- | ||
| + | | reference_date | ||
| + | | The reference point for the start and end dates. | ||
| + | | Any valid free formed date. | ||
| + | | now | ||
| + | | reference_date='last Thursday' | ||
|- | |- | ||
| loginid | | loginid | ||
| Line 155: | Line 161: | ||
== Output == | == Output == | ||
| − | A graph. | + | A graph that is generated from the parameters supplied to the display_graph template function.<br /> |
| + | For example: <br /> | ||
| + | |||
| + | <pre> | ||
| + | {display_graph width=988 height=290 type=TMM plot_width=896 plot_height=240 plot_bgcolor=0xFFFFFF bgcolor=0xDDDDDD | ||
| + | edge_color=0x000000 stats=$stats[$range] chart_type=TMM fields=joins,recurring,refunds,reversals breakdown=$range | ||
| + | field_titles=Joins,Rebills,Refunds,Reversals field_titles2="Submits,Join Hits,Raw Hits" field_color0=0xffaa71 | ||
| + | field_color1=0xdd8851 field_color2=0xaa0000 fields2=join_submits,join_hits,impression field_color20=0x91b1d7 | ||
| + | field_color21=0x7191b7 field_color22=0x517191 legend_x=45 legend_y=-2 left_margin=40 top_margin=26 show_legend=1 | ||
| + | name=$name plot_edge_color=0xe5e5e5 plot_hgrid_color=0xe5e5e5 xaxis_tick_color=0xd3dde8 yaxis_label_offset=0 | ||
| + | xaxis_label_gap=0} | ||
| + | </pre> | ||
| + | |||
| + | '''width=988 height=290''' These parameters set the width and the height of the graph window. <br /> | ||
| + | '''type=TMM''' This sets the type of the graph to a TooMuchMedia default graph (both line and bar graph)<br /> | ||
| + | '''plot_width=896 plot_height=240''' This sets the size of the x and y axes in the graph. <br /> | ||
| + | '''plot_bgcolor=0xFFFFFF''' This sets the background color of the plot area. <br /> | ||
| + | '''bgcolor=0xDDDDDD''' This sets the background color of the graph window. <br /> | ||
| + | '''edge_color=0x000000''' This sets the color of the edge of the background window. <br /> | ||
| + | '''stats=$stats[$range]''' This is the array that the statistics are taken from. <br /> | ||
| + | '''chart_type=TMM''' This sets the type of the chart to TooMuchMedia default graph <br /> | ||
| + | '''fields=joins,recurring,refunds,reversals''' These are the fields in the "stats" parameter that represent the statistics of the line graph shown below.<br /> | ||
| + | '''field_titles=Joins,Rebills,Refunds,Reversals''' These are the titles for the fields defined in the "fields" parameter.<br /> | ||
| + | '''fields_titles2=Submits, Join Hits, Raw Hits''' These are the titles for the fields defined in the "fields2" parameter.<br /> | ||
| + | '''fields_color0=0xffaa71''' This sets the color of the join line graph. <br /> | ||
| + | '''fields_color1=0xdd8851''' This sets the color of the rebills line graph. <br /> | ||
| + | '''fields_color2=0xaa0000''' This sets the color of the refunds line graph. <br /> | ||
| + | '''fields2=join_submits,join_hits,impression''' These are the fields in the "stats" parameter that represent the statistics of the bar graph shown below. <br /> | ||
| + | '''field_color20=0x91b1d7''' This sets the color of the Submits field in the bar graph. <br /> | ||
| + | '''field_color21=0x7191b7''' This sets the color of the Join Hits field in the bar graph. <br /> | ||
| + | '''field_color22=0x517191''' This sets the color of the Raw Hits field in the bar graph. <br /> | ||
| + | '''legend_x=45''' This sets the x position of the legend <br /> | ||
| + | '''legend_y=-2''' This sets the y position of the legend <br /> | ||
| + | '''left_margin=40''' This is the left margin of the graph window <br /> | ||
| + | '''top_margin=26''' This is the top margin of the graph window <br /> | ||
| + | '''show_legend=1''' This sets whether the legend appears or not. 1 is show 0 is hide. <br /> | ||
| + | '''name=$name''' This sets the name of the graph. <br /> | ||
| + | '''plot_edge_color=0xe5e5e5''' This sets the color for the edge of the plot. <br /> | ||
| + | '''plot_hgrid_color=0xe5e5e5''' This sets the color of the horizontal grid lines. <br /> | ||
| + | '''xaxis_tick_color=0xd3dde8''' This sets the color of the x axis. <br /> | ||
| + | '''yaxis_label_offset=0''' This sets the offset of the y axis labels. <br /> | ||
| + | '''xaxis_label_gap=0''' This sets the gap of the x axis labels. <br /> | ||
| + | |||
| + | |||
| + | |||
| + | <p>The Smarty template function call above will display a graph that has a bar graph component and a line graph component as defined by the "fields1" and "fields2" parameters as shown below. </p> <br> | ||
| + | |||
| + | [[File:sample_graph.jpg|720px]] | ||
== Notes == | == Notes == | ||
| − | + | <p>The reference date refers to the date that the start date and the end date (in the date range form) use as a reference point.</p> | |
| + | For example: | ||
| + | <p>Setting reference_date = 'today' and start_date to 'last Thursday' will set start_date to last Thursday relative to today.</p> | ||
| + | <p> The end date uses the reference_date as a reference point in the same way. </p> | ||
| + | <p>If you wanted to show qualified hits on your graph, you would simply add "qualified" to either the "fields" parameter or the "fields2" parameter (depending on whether you wanted to show it as a line or a bar graph), and "Qualified Hits" to the "field_titles" or the "fields_titles2" parameters. </p> | ||
| + | |||
| + | [[Category:NATS4 Template Functions]] | ||
Latest revision as of 16:07, 20 May 2011
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 or string description | 0 or date | period="7" or period='week' |
| 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 |
| name | Name of the graph | Any HTML encoded string | Random | name="my_chart" |
| reference_date | The reference point for the start and end dates. | Any valid free formed date. | now | reference_date='last Thursday' |
| 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 that is generated from the parameters supplied to the display_graph template function.
For example:
{display_graph width=988 height=290 type=TMM plot_width=896 plot_height=240 plot_bgcolor=0xFFFFFF bgcolor=0xDDDDDD
edge_color=0x000000 stats=$stats[$range] chart_type=TMM fields=joins,recurring,refunds,reversals breakdown=$range
field_titles=Joins,Rebills,Refunds,Reversals field_titles2="Submits,Join Hits,Raw Hits" field_color0=0xffaa71
field_color1=0xdd8851 field_color2=0xaa0000 fields2=join_submits,join_hits,impression field_color20=0x91b1d7
field_color21=0x7191b7 field_color22=0x517191 legend_x=45 legend_y=-2 left_margin=40 top_margin=26 show_legend=1
name=$name plot_edge_color=0xe5e5e5 plot_hgrid_color=0xe5e5e5 xaxis_tick_color=0xd3dde8 yaxis_label_offset=0
xaxis_label_gap=0}
width=988 height=290 These parameters set the width and the height of the graph window.
type=TMM This sets the type of the graph to a TooMuchMedia default graph (both line and bar graph)
plot_width=896 plot_height=240 This sets the size of the x and y axes in the graph.
plot_bgcolor=0xFFFFFF This sets the background color of the plot area.
bgcolor=0xDDDDDD This sets the background color of the graph window.
edge_color=0x000000 This sets the color of the edge of the background window.
stats=$stats[$range] This is the array that the statistics are taken from.
chart_type=TMM This sets the type of the chart to TooMuchMedia default graph
fields=joins,recurring,refunds,reversals These are the fields in the "stats" parameter that represent the statistics of the line graph shown below.
field_titles=Joins,Rebills,Refunds,Reversals These are the titles for the fields defined in the "fields" parameter.
fields_titles2=Submits, Join Hits, Raw Hits These are the titles for the fields defined in the "fields2" parameter.
fields_color0=0xffaa71 This sets the color of the join line graph.
fields_color1=0xdd8851 This sets the color of the rebills line graph.
fields_color2=0xaa0000 This sets the color of the refunds line graph.
fields2=join_submits,join_hits,impression These are the fields in the "stats" parameter that represent the statistics of the bar graph shown below.
field_color20=0x91b1d7 This sets the color of the Submits field in the bar graph.
field_color21=0x7191b7 This sets the color of the Join Hits field in the bar graph.
field_color22=0x517191 This sets the color of the Raw Hits field in the bar graph.
legend_x=45 This sets the x position of the legend
legend_y=-2 This sets the y position of the legend
left_margin=40 This is the left margin of the graph window
top_margin=26 This is the top margin of the graph window
show_legend=1 This sets whether the legend appears or not. 1 is show 0 is hide.
name=$name This sets the name of the graph.
plot_edge_color=0xe5e5e5 This sets the color for the edge of the plot.
plot_hgrid_color=0xe5e5e5 This sets the color of the horizontal grid lines.
xaxis_tick_color=0xd3dde8 This sets the color of the x axis.
yaxis_label_offset=0 This sets the offset of the y axis labels.
xaxis_label_gap=0 This sets the gap of the x axis labels.
The Smarty template function call above will display a graph that has a bar graph component and a line graph component as defined by the "fields1" and "fields2" parameters as shown below.
Notes
The reference date refers to the date that the start date and the end date (in the date range form) use as a reference point.
For example:
Setting reference_date = 'today' and start_date to 'last Thursday' will set start_date to last Thursday relative to today.
The end date uses the reference_date as a reference point in the same way.
If you wanted to show qualified hits on your graph, you would simply add "qualified" to either the "fields" parameter or the "fields2" parameter (depending on whether you wanted to show it as a line or a bar graph), and "Qualified Hits" to the "field_titles" or the "fields_titles2" parameters.
